Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> jorphan >> [ gui overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.jorphan.gui
Class JLabeledTextArea  

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.apache.jorphan.gui.JLabeledTextArea

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, JLabeledField, java.awt.MenuContainer, java.io.Serializable

---

public class JLabeledTextArea

extends javax.swing.JPanel

implements JLabeledField, java.awt.event.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.

Version:

$Revision: 1.8 $

---

Nested Class Summary

 

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

 

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

 

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

 

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

 

Field Summary
private  java.util.ArrayList	mChangeListeners
private  javax.swing.JLabel	mLabel
private  javax.swing.JTextArea	mTextArea
private  java.lang.String	oldValue

 

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.Container

 

Fields inherited from class java.awt.Component

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

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

JLabeledTextArea(java.lang.String pLabel, javax.swing.text.Document docModel)           Constructs a new component with the label displaying the passed text.

 

Method Summary
void	addChangeListener(javax.swing.event.ChangeListener pChangeListener)           Adds a change listener, that will be notified when the text in the text field is changed.
void	focusGained(java.awt.event.FocusEvent pFocusEvent)           Catch what the value was when focus was gained.
void	focusLost(java.awt.event.FocusEvent pFocusEvent)           Callback method when the focus to the Text Field component is lost.
java.util.List	getComponentList()
java.lang.String	getLabel()           Returns the text of the label.
java.lang.String	getText()           Returns the text in the Text Field.
private  void	init()           Initialises all of the components on this panel.
private  void	notifyChangeListeners()           Notify all registered change listeners that the text in the text field has changed.
void	removeChangeListener(javax.swing.event.ChangeListener pChangeListener)           Removes a change listener.
void	setDocumentModel(javax.swing.text.Document docModel)
void	setEnabled(boolean enable)           Set the value of the enabled property.
void	setLabel(java.lang.String pLabel)           Set the text displayed in the label.
void	setText(java.lang.String pText)           Set the text displayed in the Text Field.

 

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

 

Methods inherited from class javax.swing.JComponent

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

 

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

 

Field Detail

mLabel

private javax.swing.JLabel mLabel

---

mTextArea

private javax.swing.JTextArea mTextArea

---

mChangeListeners

private java.util.ArrayList mChangeListeners

---

oldValue

private java.lang.String oldValue

Constructor Detail

JLabeledTextArea

public JLabeledTextArea()

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

---

JLabeledTextArea

public JLabeledTextArea(java.lang.String pLabel,
                        javax.swing.text.Document docModel)

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

Method Detail

getComponentList

public java.util.List getComponentList()

Specified by:

getComponentList in interface JLabeledField

---

setDocumentModel

public void setDocumentModel(javax.swing.text.Document docModel)

---

init

private void init()

Initialises all of the components on this panel.

---

focusLost

public void focusLost(java.awt.event.FocusEvent pFocusEvent)

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

Specified by:

focusLost in interface java.awt.event.FocusListener

---

focusGained

public void focusGained(java.awt.event.FocusEvent pFocusEvent)

Catch what the value was when focus was gained.

Specified by:

focusGained in interface java.awt.event.FocusListener

---

setLabel

public void setLabel(java.lang.String pLabel)

Set the text displayed in the label.

Specified by:

setLabel in interface JLabeledField

---

setText

public void setText(java.lang.String pText)

Set the text displayed in the Text Field.

Specified by:

setText in interface JLabeledField

---

getText

public java.lang.String getText()

Returns the text in the Text Field.

Specified by:

getText in interface JLabeledField

---

getLabel

public java.lang.String getLabel()

Returns the text of the label.

---

setEnabled

public void setEnabled(boolean enable)

Description copied from class: javax.swing.JComponent

Set the value of the enabled property.

---

addChangeListener

public void addChangeListener(javax.swing.event.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 55 method.

Specified by:

addChangeListener in interface JLabeledField

---

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener pChangeListener)

Removes a change listener.

---

notifyChangeListeners

private void notifyChangeListeners()

Notify all registered change listeners that the text in the text field has changed.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> jorphan >> [ gui overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---