org.apache.jorphan.gui
Class JLabeledTextArea
JPanel
org.apache.jorphan.gui.JLabeledTextArea
- FocusListener, JLabeledField
public class JLabeledTextArea
extends JPanel
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.
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.
|
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 | getComponentList()
|
String | getLabel() - Returns the text of the label.
|
String | getText() - Returns the text in the Text Field.
|
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.
|
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.
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.
pLabel
- The text to display in the label.docModel
- the document for the text area
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.
- addChangeListener in interface JLabeledField
pChangeListener
- The listener to add
focusGained
public void focusGained(FocusEvent pFocusEvent)
Catch what the value was when focus was gained.
focusLost
public void focusLost(FocusEvent pFocusEvent)
Callback method when the focus to the Text Field component is lost.
pFocusEvent
- The focus event that occured.
getLabel
public String getLabel()
Returns the text of the label.
getText
public String getText()
Returns the text in the Text Field.
- getText in interface JLabeledField
- The text in the Text Field.
getToolTipText
public String getToolTipText()
Returns the tooltip string that has been set with setToolTipText
removeChangeListener
public void removeChangeListener(ChangeListener pChangeListener)
Removes a change listener.
pChangeListener
- The change listener to remove.
setDocumentModel
public void setDocumentModel(Document docModel)
setEnabled
public void setEnabled(boolean enable)
setLabel
public void setLabel(String pLabel)
Set the text displayed in the label.
- setLabel in interface JLabeledField
pLabel
- The new label text.
setText
public void setText(String pText)
Set the text displayed in the Text Field.
- setText in interface JLabeledField
pText
- The new text to display in the text field.
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.
text
- the string to display; if the text is null,
the tool tip is turned off for this component
Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.