Package uk.ac.starlink.util.gui
Class SelectTextField
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- uk.ac.starlink.util.gui.SelectTextField
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
,SelectCharactersListener
public class SelectTextField extends javax.swing.JPanel implements SelectCharactersListener
A component for accepting a text string, but with the additional capability of choosing from the complete list of characters available in the current font. The font details are shown in a popup window that is initialised using a button shown against the text entry area.- Since:
- $Date$, 06-NOV-2000
- Version:
- $Id$
- Author:
- Peter W. Draper
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.swing.JButton
charButton
Button to initiate selecting special characters.protected SelectCharacters
charChooser
The special character chooser.protected javax.swing.event.EventListenerList
listeners
protected javax.swing.JTextField
textField
The text entry field.-
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
-
-
Constructor Summary
Constructors Constructor Description SelectTextField()
Create an instance.SelectTextField(java.lang.String text)
Create an instance with initial text field.SelectTextField(java.lang.String text, SelectCharacters charChooser)
Create an instance with initial text field and using the pre-configured instance of SelectCharacters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addActionListener(java.awt.event.ActionListener l)
Registers a listener who wants to be informed about changes to the character string.protected void
chooseChars()
Choose a special character phrase to append.protected void
fireAction(java.awt.event.ActionEvent e)
Send action event to all listeners.javax.swing.text.Document
getDocument()
Get the document model used by the JTextField.java.lang.String
getText()
Get the displayed text.java.awt.Color
getTextColour()
Get the text colour.java.awt.Font
getTextFont()
Get the text font.protected void
initUI()
Initialise the user interface.void
insertText(java.lang.String text)
Insert new text, either at the end or at the insertion point.void
newCharacters(SelectCharactersEvent e)
Accept new characters.void
removeActionListener(java.awt.event.ActionListener l)
void
setColumns(int columns)
Set the number of columns displayed by the JTextField.void
setText(java.lang.String text)
Set the displayed text.void
setTextColour(java.awt.Color colour)
Set the text colour.void
setTextFont(java.awt.Font font)
Set the text font.void
setToolTipText(java.lang.String tip)
Set the tooltip for the text component.-
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, 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, setEnabled, 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
-
-
-
-
Field Detail
-
textField
protected javax.swing.JTextField textField
The text entry field.
-
charButton
protected javax.swing.JButton charButton
Button to initiate selecting special characters.
-
charChooser
protected SelectCharacters charChooser
The special character chooser.
-
listeners
protected javax.swing.event.EventListenerList listeners
-
-
Constructor Detail
-
SelectTextField
public SelectTextField()
Create an instance.
-
SelectTextField
public SelectTextField(java.lang.String text)
Create an instance with initial text field.- Parameters:
text
- default text for the text field.
-
SelectTextField
public SelectTextField(java.lang.String text, SelectCharacters charChooser)
Create an instance with initial text field and using the pre-configured instance of SelectCharacters.- Parameters:
text
- default text for the text field.
-
-
Method Detail
-
initUI
protected void initUI()
Initialise the user interface.
-
chooseChars
protected void chooseChars()
Choose a special character phrase to append.
-
newCharacters
public void newCharacters(SelectCharactersEvent e)
Accept new characters.- Specified by:
newCharacters
in interfaceSelectCharactersListener
-
setText
public void setText(java.lang.String text)
Set the displayed text.
-
insertText
public void insertText(java.lang.String text)
Insert new text, either at the end or at the insertion point.
-
getText
public java.lang.String getText()
Get the displayed text.
-
setTextFont
public void setTextFont(java.awt.Font font)
Set the text font.
-
getTextFont
public java.awt.Font getTextFont()
Get the text font.
-
setTextColour
public void setTextColour(java.awt.Color colour)
Set the text colour.
-
getTextColour
public java.awt.Color getTextColour()
Get the text colour.
-
getDocument
public javax.swing.text.Document getDocument()
Get the document model used by the JTextField.
-
setToolTipText
public void setToolTipText(java.lang.String tip)
Set the tooltip for the text component.- Overrides:
setToolTipText
in classjavax.swing.JComponent
-
setColumns
public void setColumns(int columns)
Set the number of columns displayed by the JTextField.
-
addActionListener
public void addActionListener(java.awt.event.ActionListener l)
Registers a listener who wants to be informed about changes to the character string.- Parameters:
l
- the ActionListener
-
removeActionListener
public void removeActionListener(java.awt.event.ActionListener l)
-
fireAction
protected void fireAction(java.awt.event.ActionEvent e)
Send action event to all listeners.
-
-