public abstract class GUIText extends ActivatableGUIElement implements KeyListener
execute(String)
executing
the entered text when ENTER
is pressed.javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
private java.awt.Color |
activeColor
The
color for rendering displayed text when the element is
active. |
private java.awt.Image |
activeImage
The element's background image when it is active.
|
private java.awt.datatransfer.Clipboard |
clipboard
The clipboard for cut/copy/paste operations.
|
private CommandCallback |
commandCallback
The
CommandCallback to use. |
private CommandHistory |
commandHistory
The
CommandHistory for this text field. |
private int |
cursor
The cursor location.
|
private java.awt.Font |
font
The
font for rendering displayed text. |
private boolean |
hideInput
If set, hide input; else show input.
|
private java.awt.Color |
inactiveColor
The
color for rendering displayed text when the element is
inactive. |
private java.awt.Image |
inactiveImage
The element's background image when it is inactive.
|
private int |
margin
The left margin in pixels.
|
private int |
offset
The display offset: this many characters are hidden.
|
private java.awt.Dimension |
preferredSize
The size of this component.
|
private static int |
SCROLL_CHARS
The number of characters to scroll left/right when the cursor would move
outside of the visible area.
|
private java.awt.datatransfer.Clipboard |
selection
The system selection for cut/copy/paste operations.
|
private static long |
serialVersionUID
The serial version UID.
|
private java.lang.Object |
syncCursor
|
private java.lang.StringBuilder |
text
The entered text.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Modifier | Constructor and Description |
---|---|
protected |
GUIText(CommandCallback commandCallback,
CommandHistory commandHistory,
TooltipManager tooltipManager,
GUIElementListener elementListener,
java.lang.String name,
java.awt.Image activeImage,
java.awt.Image inactiveImage,
java.awt.Font font,
java.awt.Color inactiveColor,
java.awt.Color activeColor,
int margin,
java.lang.String text)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
protected void |
activeChanged()
Will be called whenever the active state has changed.
|
void |
execute()
Executes the actions associated with this GUI element.
|
protected abstract void |
execute(java.lang.String command)
Will be called to execute the entered command.
|
private java.lang.String |
getDisplayText()
Returns the displayed text.
|
java.awt.Dimension |
getMaximumSize() |
java.awt.Dimension |
getMinimumSize() |
java.awt.Dimension |
getPreferredSize() |
java.lang.String |
getText()
Returns the entered text.
|
private boolean |
historyNext()
Activates the next command from the command history.
|
private boolean |
historyPrev()
Activates the previous command from the command history.
|
private void |
insertChar(char ch)
Inserts a character at the cursor position.
|
private void |
insertString(java.lang.String str)
Inserts a string at the cursor position.
|
boolean |
keyPressed(KeyEvent2 e)
Invoked when a key has been pressed.
|
boolean |
keyReleased(java.awt.event.KeyEvent e)
Invoked when a key has been released.
|
void |
mouseClicked(java.awt.event.MouseEvent e)
Will be called when the user has clicked (pressed+released) this element.
|
void |
paintComponent(java.awt.Graphics g) |
private void |
paste()
Performs a "paste" operation from the system clipboard.
|
private void |
setCursor(int cursor)
Sets the cursor position.
|
void |
setHideInput(boolean hideInput)
Enables or disables hidden text.
|
void |
setText(java.lang.String text)
Sets the entered text.
|
isActive, markInactivePending, mousePressed, setActive, setInactiveIfPending
dispose, getName, hasTooltipText, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseReleased, setChanged, setChangedListener, setDefault, setIgnore, setTooltipText, setTooltipText, toString
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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
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
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, getAccessibleContext, 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, getParent, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
@NotNull private final java.awt.Color activeColor
color
for rendering displayed text when the element is
active.@NotNull private final java.awt.Image activeImage
@NotNull private final java.awt.datatransfer.Clipboard clipboard
@NotNull private final CommandCallback commandCallback
CommandCallback
to use.@Nullable private final CommandHistory commandHistory
CommandHistory
for this text field. Set to null
is no
command history is used.private int cursor
@NotNull private final java.awt.Font font
font
for rendering displayed text.private boolean hideInput
@NotNull private final java.awt.Color inactiveColor
color
for rendering displayed text when the element is
inactive. Also color of cursor.@NotNull private final java.awt.Image inactiveImage
private final int margin
private int offset
private final java.awt.Dimension preferredSize
private static final int SCROLL_CHARS
@Nullable private final java.awt.datatransfer.Clipboard selection
private static final long serialVersionUID
@NotNull private final java.lang.Object syncCursor
@NotNull private final java.lang.StringBuilder text
protected GUIText(@NotNull CommandCallback commandCallback, @Nullable CommandHistory commandHistory, @NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, @NotNull java.awt.Image activeImage, @NotNull java.awt.Image inactiveImage, @NotNull java.awt.Font font, @NotNull java.awt.Color inactiveColor, @NotNull java.awt.Color activeColor, int margin, @NotNull java.lang.String text)
commandCallback
- the command callback to usecommandHistory
- the command history to use or null
to
disable command history accesstooltipManager
- the tooltip manager to updateelementListener
- the element listener to notifyname
- the name of this elementactiveImage
- the element's background image when it is activeinactiveImage
- the element's background image when it is inactivefont
- the font for rendering displayed textinactiveColor
- the color for rendering displayed text when the
element is active; also cursor coloractiveColor
- the color for rendering displayed text when the
element is activemargin
- the left margin in pixelstext
- the initially entered textprotected void activeChanged()
activeChanged
in class ActivatableGUIElement
public void execute()
execute
in class ActivatableGUIElement
protected abstract void execute(@NotNull java.lang.String command)
command
- the entered command@NotNull private java.lang.String getDisplayText()
entered text
as it may be clipped left because the input
field is scrolled or because the input field is a password field that hides input
.@NotNull public java.awt.Dimension getMaximumSize()
getMaximumSize
in class javax.swing.JComponent
@NotNull public java.awt.Dimension getMinimumSize()
getMinimumSize
in class javax.swing.JComponent
@NotNull public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
@NotNull public java.lang.String getText()
private boolean historyNext()
private boolean historyPrev()
private void insertChar(char ch)
ch
- the characterprivate void insertString(@NotNull java.lang.String str)
str
- the stringpublic boolean keyPressed(@NotNull KeyEvent2 e)
KeyPressedHandler
keyPressed
in interface KeyPressedHandler
e
- the key event for the keypublic boolean keyReleased(@NotNull java.awt.event.KeyEvent e)
keyReleased
in interface KeyListener
e
- the key event for the keypublic void mouseClicked(@NotNull java.awt.event.MouseEvent e)
GUIElement.mouseReleased(MouseEvent)
.mouseClicked
in interface GUIElement
mouseClicked
in class AbstractGUIElement
e
- the mouse event relative to this elementpublic void paintComponent(@NotNull java.awt.Graphics g)
paintComponent
in class javax.swing.JComponent
private void paste()
private void setCursor(int cursor)
cursor
- the new cursor positionpublic void setHideInput(boolean hideInput)
hideInput
- if set, hide input; else show inputpublic void setText(@NotNull java.lang.String text)
text
- the text