Package org.apache.jorphan.gui

Class JLabeledTextField

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jorphan.gui.JLabeledTextField
All Implemented Interfaces:
FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, JLabeledField
Direct Known Subclasses:
JLabeledPasswordField
public class JLabeledTextField 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:

  • Constructor Details

    • JLabeledTextField

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

    • JLabeledTextField

      public JLabeledTextField(String pLabel)
      Constructs a new component with the label displaying the passed text.
      Parameters:
      pLabel - The text to in the label.

    • JLabeledTextField

      public JLabeledTextField(String pLabel, int size)
      Constructs a new component with the label displaying the passed text.
      Parameters:
      pLabel - The text to in the label.
      size - size of text field

    • JLabeledTextField

      public JLabeledTextField(String pLabel, Color bk)
      Size defaults to 20
      Parameters:
      pLabel - The text to in the label.
      bk - Color background color

    • JLabeledTextField

      public JLabeledTextField(String pLabel, int size, Color bk, boolean editable)
      Size defaults to 20
      Parameters:
      pLabel - The text to in the label.
      size - textfield length
      bk - Color background color may be null
      editable - boolean

  • Method Details

    • getComponentList

      public List<JComponent> getComponentList()
      Get the label JLabel followed by the text field @link JTextField.
      Specified by:
      getComponentList in interface JLabeledField

    • setEnabled

      public void setEnabled(boolean enable)
      Overrides:
      setEnabled in class JComponent

    • createTextField

      protected JTextField createTextField(int size)

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

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

    • notifyChangeListeners

      protected void notifyChangeListeners()
      Notify all registered change listeners that the text in the text field has changed.

    • requestFocusInWindow

      public boolean requestFocusInWindow()
      Overrides:
      requestFocusInWindow in class JComponent