org.apache.jorphan.gui

Class JLabeledTextArea

Implemented Interfaces:
FocusListener, 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.

Constructor Summary

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

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.

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

addChangeListener

public void addChangeListener(ChangeListener pChangeListener)
Specified by:
addChangeListener in interface JLabeledField
Parameters:
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.
Parameters:
pFocusEvent - The focus event that occured.

getComponentList

public List getComponentList()
Specified by:
getComponentList in interface JLabeledField

getLabel

public String getLabel()
Returns the text of the label.
Returns:
The text of the label.

getText

public String getText()
Returns the text in the Text Field.
Specified by:
getText in interface JLabeledField
Returns:
The text in the Text Field.

getToolTipText

public String getToolTipText()
Returns the tooltip string that has been set with setToolTipText
Returns:
the text of the tool tip

removeChangeListener

public void removeChangeListener(ChangeListener pChangeListener)
Removes a change listener.
Parameters:
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.
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.

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.
Parameters:
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.