Package com.realtime.crossfire.jxclient.gui.textinput

Class GUIText

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

com.realtime.crossfire.jxclient.gui.textinput.GUIText

All Implemented Interfaces:

GUIElement, KeyPressedHandler, KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

GUICommandText, GUIQueryText, GUITextField

public abstract class GUIText
extends ActivatableGUIElement
implements KeyListener

Abstract base class for text input fields. It allows entering and editing text. Subclasses define the behavior when execute(String) executing the entered text when ENTER is pressed.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GUIText(@NotNull CommandCallback commandCallback, @Nullable CommandHistory commandHistory, @NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, @NotNull NewCharModel newCharModel, @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, @NotNull GuiFactory guiFactory)	Creates a new instance.

Method Summary

Modifier and Type	Method	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(@NotNull java.lang.String command)	Will be called to execute the entered command.
@NotNull java.awt.Dimension	getMaximumSize()
@NotNull java.awt.Dimension	getMinimumSize()
@NotNull java.awt.Dimension	getPreferredSize()
@NotNull java.lang.String	getText()	Returns the entered text.
boolean	keyPressed(@NotNull KeyEvent2 e)	Invoked when a key has been pressed.
boolean	keyReleased(@NotNull java.awt.event.KeyEvent e)	Invoked when a key has been released.
void	mouseClicked(@NotNull java.awt.event.MouseEvent e)	Will be called when the user has clicked (pressed+released) this element.
void	paintComponent(@NotNull java.awt.Graphics g)
void	setHideInput(boolean hideInput)	Enables or disables hidden text.
void	setText(@NotNull java.lang.String text)	Sets the entered text.

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

isActive, markInactivePending, mousePressed, setActive, setInactiveIfPending

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

dispose, getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, getTooltip, inhibitListeners, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseReleased, newTooltipText, setChanged, setChangedListener, setDefault, setIgnore, tooltipChanged, toString

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, 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

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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.realtime.crossfire.jxclient.gui.gui.GUIElement

notifyOpen

Constructor Detail

GUIText

protected GUIText(@NotNull
                  @NotNull CommandCallback commandCallback,
                  @Nullable
                  @Nullable CommandHistory commandHistory,
                  @NotNull
                  @NotNull TooltipManager tooltipManager,
                  @NotNull
                  @NotNull GUIElementListener elementListener,
                  @NotNull
                  @NotNull java.lang.String name,
                  @NotNull
                  @NotNull NewCharModel newCharModel,
                  @NotNull
                  @NotNull java.awt.Image activeImage,
                  @NotNull
                  @NotNull java.awt.Image inactiveImage,
                  @NotNull
                  @NotNull java.awt.Font font,
                  @NotNull
                  @NotNull java.awt.Color inactiveColor,
                  @NotNull
                  @NotNull java.awt.Color activeColor,
                  int margin,
                  @NotNull
                  @NotNull java.lang.String text,
                  @NotNull
                  @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

commandCallback - the command callback to use

commandHistory - the command history to use or null to disable command history access

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

newCharModel - the new char model to show

activeImage - the element's background image when it is active

inactiveImage - the element's background image when it is inactive

font - the font for rendering displayed text

inactiveColor - the color for rendering displayed text when the element is active; also cursor color

activeColor - the color for rendering displayed text when the element is active

margin - the left margin in pixels

text - the initially entered text

guiFactory - the global GUI factory instance

Method Detail

setText

public void setText(@NotNull
                    @NotNull java.lang.String text)

Sets the entered text.

Parameters:

text - the text

getText

@NotNull
public @NotNull java.lang.String getText()

Returns the entered text.

Returns:

the text

paintComponent

public void paintComponent(@NotNull
                           @NotNull java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

getPreferredSize

@NotNull
public @NotNull java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getMinimumSize

@NotNull
public @NotNull java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getMaximumSize

@NotNull
public @NotNull java.awt.Dimension getMaximumSize()

Overrides:

getMaximumSize in class javax.swing.JComponent

mouseClicked

public void mouseClicked(@NotNull
                         @NotNull java.awt.event.MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has clicked (pressed+released) this element. This event will be delivered after GUIElement.mouseReleased(MouseEvent).

Specified by:

mouseClicked in interface GUIElement

Overrides:

mouseClicked in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

execute

public void execute()

Description copied from class: ActivatableGUIElement

Executes the actions associated with this GUI element. Does nothing if this element has no associated actions.

Specified by:

execute in class ActivatableGUIElement

activeChanged

protected void activeChanged()

Description copied from class: ActivatableGUIElement

Will be called whenever the active state has changed.

Specified by:

activeChanged in class ActivatableGUIElement

keyPressed

public boolean keyPressed(@NotNull
                          @NotNull KeyEvent2 e)

Description copied from interface: KeyPressedHandler

Invoked when a key has been pressed.

Specified by:

keyPressed in interface KeyPressedHandler

Parameters:

e - the key event for the key

Returns:

whether the key event has been consumed

keyReleased

public boolean keyReleased(@NotNull
                           @NotNull java.awt.event.KeyEvent e)

Description copied from interface: KeyListener

Invoked when a key has been released.

Specified by:

keyReleased in interface KeyListener

Parameters:

e - the key event for the key

Returns:

whether the key event has been consumed

execute

protected abstract void execute(@NotNull
                                @NotNull java.lang.String command)

Will be called to execute the entered command.

Parameters:

command - the entered command

setHideInput

public void setHideInput(boolean hideInput)

Enables or disables hidden text.

Parameters:

hideInput - if set, hide input; else show input