com.sssw.rt.jform
Class AgcJEditorPane

java.lang.Object
 |
 +--java.awt.Component
       |
       +--java.awt.Container
             |
             +--javax.swing.JComponent
                   |
                   +--javax.swing.text.JTextComponent
                         |
                         +--javax.swing.JEditorPane
                               |
                               +--com.sssw.rt.jform.AgcJEditorPane

All Implemented Interfaces:

Accessible, AgiHelpInfo, ImageObserver, MenuContainer, Scrollable, Serializable

public class AgcJEditorPane

extends JEditorPane

implements AgiHelpInfo

A lightweight component that provides an editing area for text. The AgcJEditorPane class extends javax.swing.JEditorPane, adding data binding.

JEditorPane is a text component that enables editing of various kinds of content. This component uses implementations of the EditorKit to accomplish its behavior. It effectively morphs into the proper kind of text editor for the kind of content it is given. The content type that editor is bound to at any given time is determined by the EditorKit currently installed. If the content is set to a new URL, its type is used to determine the EditorKit that should be used to load the content.

By default, the following types of content are known:

• text/plain - Plain text, which is the default if the type given isn't recognized. The editor kit is an extension of DefaultEditorKit, which produces a wrapped plain text view.
• text/html - HTML text. The editor kit is javax.swing.text.html.HTMLEditorKit, which provides html 3.2 support.
• text/rtf - RTF text. The editor kit is javax.swing.text.rtf.RTFEditorKit, which provides limited support of Rich Text Format.

There are several ways to load content into an editor pane:

• JEditorPane.setText(String)
• JEditorPane.read(InputStream, Object)
• JEditorPane.setPage(String) or JEditorPane.setPage(URL)

  For more information, see JEditorPane.

  Properties:

  Background Color, Content Type, Control Type, Data Column, Editable, Enabled, Font Name, Font Size, Font Style, Height, Help Page, Left, Name, Text Color, Tool Tip, Top, Validation Rules, Visible, Width

  Events:

  focusGained, focusLost, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased

  See Also:

  Serialized Form

  Inner classes inherited from class javax.swing.JEditorPane

  JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

  Inner classes inherited from class javax.swing.text.JTextComponent

  JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding

  Inner classes inherited from class javax.swing.JComponent

  JComponent.AccessibleJComponent

  Field Summary

  static int

  NO_LIMIT Used to remove a limit on the allowed number of characters.

  Fields inherited from class javax.swing.text.JTextComponent

  DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

  Fields inherited from class javax.swing.JComponent

  accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

  Fields inherited from class java.awt.Component

  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

  Constructor Summary

  AgcJEditorPane()
  AgcJEditorPane constructor.

  Method Summary

  boolean	getEmptyStringIsNull() Returns true if the value of an empty text control is null, instead of the empty String, when the text control is empty.
  int	getMaxLength() Gets the maximum number of characters allowed in the control.
  int	getMinLength() Gets the minimum number of characters allowed in the control.
  void	setEmptyStringIsNull(boolean b) Specifies whether the control's value is null or an empty String when the control is empty.
  void	setMaxLength(int length) Sets the maximum number of characters allowed in the control.
  void	setMinLength(int length) Sets the minimum number of characters allowed in the control.

  Methods inherited from class javax.swing.JEditorPane

  addHyperlinkListener, createDefaultEditorKit, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitForContentType, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, getUIClassID, isManagingFocus, paramString, processComponentKeyEvent, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, replaceSelection, scrollToReference, setContentType, setEditorKit, setEditorKitForContentType, setPage, setPage, setText

  Methods inherited from class javax.swing.text.JTextComponent

  addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getUI, isEditable, isFocusTraversable, isOpaque, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setEnabled, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setOpaque, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

  Methods inherited from class javax.swing.JComponent

  addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update

  Methods inherited from class java.awt.Container

  add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree

  Methods inherited from class java.awt.Component

  action, add, addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Methods implemented from interface com.sssw.rt.form.AgiHelpInfo

  getHelpInfo, setHelpInfo

  Field Detail

  NO_LIMIT

  public static final int NO_LIMIT

  Used to remove a limit on the allowed number of characters.

  Constructor Detail

  AgcJEditorPane

  public AgcJEditorPane()

  AgcJEditorPane constructor.

  Method Detail

  getEmptyStringIsNull

  public boolean getEmptyStringIsNull()

  Returns true if the value of an empty text control is null, instead of the empty String, when the text control is empty. When the control is data-bound, this setting affects the value that is written to the database. The default is false. Note that getText() returns the empty String, regardless of this setting.'

  See Also:

  AgcJEditorPane.setEmptyStringIsNull(boolean)

  setEmptyStringIsNull

  public void setEmptyStringIsNull(boolean b)

  Specifies whether the control's value is null or an empty String when the control is empty. If set to true for a data-bound control, then when the control is empty, the value stored in the database is null, instead of an empty String.

  See Also:

  AgcJEditorPane.getEmptyStringIsNull()

  getMaxLength

  public int getMaxLength()

  Gets the maximum number of characters allowed in the control.

  See Also:

  AgcJEditorPane.setMaxLength(int)

  getMinLength

  public int getMinLength()

  Gets the minimum number of characters allowed in the control.

  See Also:

  AgcJEditorPane.setMinLength(int)

  setMaxLength

  public void setMaxLength(int length)

  Sets the maximum number of characters allowed in the control. If the user tries to enter a longer string, a validationFailed event is fired. Use the constant NO_LIMIT to disable the limit.

  See Also:

  AgcJEditorPane.getMaxLength(), AgcJEditorPane.setMinLength(int)

  setMinLength

  public void setMinLength(int length)

  Sets the minimum number of characters allowed in the control. If the user enters a shorter string, a validationFailed event is fired. Use the constant NO_LIMIT to disable the limit.

  See Also:

  AgcJEditorPane.setMaxLength(int), AgcJEditorPane.getMinLength()