org.apache.jorphan.gui.JLabeledTextArea

All Implemented Interfaces:: FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, JLabeledField

public class JLabeledTextArea extends JPanel implements JLabeledField, FocusListener

A Helper component that wraps a JTextField with a label into a JPanel (this). This component also has an efficient event handling mechanism for handling the text changing in the Text Field. The registered change listeners are only called when the text has changed.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Field Summary

Fields inherited from class javax.swing.JComponent
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
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor Summary

Constructors

Constructor

Description

JLabeledTextArea()

Default constructor, The label and the Text field are left empty.

JLabeledTextArea(String label)

Constructs a new component with the label displaying the passed text.

JLabeledTextArea(String pLabel, Document docModel)

Constructs a new component with the label displaying the passed text.
Method Summary

Modifier and Type

Method

Description

void

addChangeListener(ChangeListener pChangeListener)

Adds a change listener, that will be notified when the text in the text field is changed.

void

focusGained(FocusEvent pFocusEvent)

Catch what the value was when focus was gained.

void

focusLost(FocusEvent pFocusEvent)

Callback method when the focus to the Text Field component is lost.

List<JComponent>

getComponentList()

Get the label JLabel followed by the text field @link JTextArea.

String

getLabel()

Returns the text of the label.

String

getText()

Returns the text in the Text Field.

String[]

getTextLines()

String

getToolTipText()

Returns the tooltip string that has been set with setToolTipText

void

removeChangeListener(ChangeListener pChangeListener)

Removes a change listener.

void

setDocumentModel(Document docModel)

void

setEnabled(boolean enable)

void

setLabel(String pLabel)

Set the text displayed in the label.

void

setText(String pText)

Set the text displayed in the Text Field.

void

setToolTipText(String text)

Registers the text to display in a tool tip.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- JLabeledTextArea
  
  public JLabeledTextArea()
  
  Default constructor, The label and the Text field are left empty.
- JLabeledTextArea
  
  public JLabeledTextArea(String label)
  
  Constructs a new component with the label displaying the passed text.
  
  Parameters:
  
  label - The text to display in the label.
- JLabeledTextArea
  
  public JLabeledTextArea(String pLabel, Document docModel)
  
  Constructs a new component with the label displaying the passed text.
  
  Parameters:
  
  pLabel - The text to display in the label.
  
  docModel - the document for the text area
Method Details
- getComponentList
  
  public List<JComponent> getComponentList()
  
  Get the label JLabel followed by the text field @link JTextArea.
  
  Specified by:
  
  getComponentList in interface JLabeledField
- setDocumentModel
  
  public void setDocumentModel(Document docModel)
- focusLost
  
  public void focusLost(FocusEvent pFocusEvent)
  
  Callback method when the focus to the Text Field component is lost.
  
  Specified by:
  
  focusLost in interface FocusListener
  
  Parameters:
  
  pFocusEvent - The focus event that occurred.
- focusGained
  
  public void focusGained(FocusEvent pFocusEvent)
  
  Catch what the value was when focus was gained.
  
  Specified by:
  
  focusGained in interface FocusListener
- setLabel
  
  public void setLabel(String pLabel)
  
  Set the text displayed in the label.
  
  Specified by:
  
  setLabel in interface JLabeledField
  
  Parameters:
  
  pLabel - The new label text.
- setText
  
  public void setText(String pText)
  
  Set the text displayed in the Text Field.
  
  Specified by:
  
  setText in interface JLabeledField
  
  Parameters:
  
  pText - The new text to display in the text field.
- getText
  
  public String getText()
  
  Returns the text in the Text Field.
  
  Specified by:
  
  getText in interface JLabeledField
  
  Returns:
  
  The text in the Text Field.
- getLabel
  
  public String getLabel()
  
  Returns the text of the label.
  
  Returns:
  
  The text of the label.
- setEnabled
  
  public void setEnabled(boolean enable)
  
  Overrides:
  
  setEnabled in class JComponent
- setToolTipText
  
  public void setToolTipText(String text)
  
  Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.
  
  Overrides:
  
  setToolTipText in class JComponent
  
  Parameters:
  
  text - the string to display; if the text is null, the tool tip is turned off for this component
- getToolTipText
  
  public String getToolTipText()
  
  Returns the tooltip string that has been set with setToolTipText
  
  Overrides:
  
  getToolTipText in class JComponent
  
  Returns:
  
  the text of the tool tip
- addChangeListener
  
  public void addChangeListener(ChangeListener pChangeListener)
  
  Adds a change listener, that will be notified when the text in the text field is changed. The ChangeEvent that will be passed to registered listeners will contain this object as the source, allowing the new text to be extracted using the getText method.
  
  Specified by:
  
  addChangeListener in interface JLabeledField
  
  Parameters:
  
  pChangeListener - The listener to add
- removeChangeListener
  
  public void removeChangeListener(ChangeListener pChangeListener)
  
  Removes a change listener.
  
  Parameters:
  
  pChangeListener - The change listener to remove.
- getTextLines
  
  public String[] getTextLines()

Class JLabeledTextArea

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Details

JLabeledTextArea

JLabeledTextArea

JLabeledTextArea

Method Details

getComponentList

setDocumentModel

focusLost

focusGained

setLabel

setText

getText

getLabel

setEnabled

setToolTipText

getToolTipText

addChangeListener

removeChangeListener

getTextLines