com.realtime.crossfire.jxclient.gui.item

Class GUIItemShortcut

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.item.GUIItem

com.realtime.crossfire.jxclient.gui.item.GUIItemShortcut

All Implemented Interfaces:

GUIElement, GUIScrollable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class GUIItemShortcut
extends GUIItem

Displays a shortcut command.

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

Constructor and Description

GUIItemShortcut(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, @Nullable java.awt.Color activateColor, @Nullable java.awt.Image activateImage, @Nullable java.awt.Color immediateColor, @Nullable java.awt.Image immediateImage, @NotNull ShortcutSlot shortcutSlot, @NotNull FacesManager facesManager, @NotNull CommandExecutor commandExecutor, @NotNull Shortcuts shortcuts, @NotNull java.awt.Font font, @NotNull GuiFactory guiFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	button1Clicked(int modifiers) Called when the left mouse button was pressed.
void	button2Clicked(int modifiers) Called when the middle mouse button was pressed.
void	button3Clicked(int modifiers) Called when the right mouse button was pressed.
boolean	canScroll(int distance) Returns whether scrolling is possible.
void	dispose() Releases all allocated resources.
@NotNull java.awt.Dimension	getMinimumSize()
@NotNull java.awt.Dimension	getPreferredSize()
@Nullable TooltipText	getTooltip() Returns the current tooltip text.
void	notifyOpen() Called each time the enclosing dialog is opened (or raised).
void	paintComponent(@NotNull java.awt.Graphics g)
void	resetScroll() Resets the scroll index to the default value.
void	scroll(int distance) Scrolls the element.

Methods inherited from class com.realtime.crossfire.jxclient.gui.item.GUIItem

activeChanged, execute, mouseClicked, setVisible

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

activateNextElement, activatePrevElement, isActive, markInactivePending, mousePressed, setActive, setInactiveIfPending, setNextActive, setPrevActive

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

getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, inhibitListeners, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseReleased, mouseWheelMoved, 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, getMaximumSize, 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, 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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

GUIItemShortcut

public GUIItemShortcut(@NotNull
                       @NotNull TooltipManager tooltipManager,
                       @NotNull
                       @NotNull GUIElementListener elementListener,
                       @NotNull
                       @NotNull java.lang.String name,
                       @Nullable
                       @Nullable java.awt.Color activateColor,
                       @Nullable
                       @Nullable java.awt.Image activateImage,
                       @Nullable
                       @Nullable java.awt.Color immediateColor,
                       @Nullable
                       @Nullable java.awt.Image immediateImage,
                       @NotNull
                       @NotNull ShortcutSlot shortcutSlot,
                       @NotNull
                       @NotNull FacesManager facesManager,
                       @NotNull
                       @NotNull CommandExecutor commandExecutor,
                       @NotNull
                       @NotNull Shortcuts shortcuts,
                       @NotNull
                       @NotNull java.awt.Font font,
                       @NotNull
                       @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

activateColor - the background color for shortcuts that activate the command

activateImage - the overlay image for shortcuts that activate the command

immediateColor - the background color for shortcuts that immediately execute the command

immediateImage - the overlay image for shortcuts that immediately execute the command

shortcutSlot - the shortcut slot

facesManager - the faces manager instance for looking up faces

commandExecutor - the command executor for executing commands

shortcuts - the shortcuts instance for looking up shortcuts

font - the font for displaying the key that activates the shortcut

guiFactory - the global GUI factory instance

Method Detail

dispose

public void dispose()

Description copied from interface: GUIElement

Releases all allocated resources.

Specified by:

dispose in interface GUIElement

Overrides:

dispose in class AbstractGUIElement

getTooltip

@Nullable
public @Nullable TooltipText getTooltip()

Description copied from class: AbstractGUIElement

Returns the current tooltip text.

Specified by:

getTooltip in class AbstractGUIElement

Returns:

the tooltip text or null to not show a tooltip

notifyOpen

public void notifyOpen()

Description copied from interface: GUIElement

Called each time the enclosing dialog is opened (or raised).

button1Clicked

public void button1Clicked(int modifiers)

Description copied from class: GUIItem

Called when the left mouse button was pressed.

Specified by:

button1Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

button2Clicked

public void button2Clicked(int modifiers)

Description copied from class: GUIItem

Called when the middle mouse button was pressed.

Specified by:

button2Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

button3Clicked

public void button3Clicked(int modifiers)

Description copied from class: GUIItem

Called when the right mouse button was pressed.

Specified by:

button3Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

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

canScroll

public boolean canScroll(int distance)

Description copied from interface: GUIScrollable

Returns whether scrolling is possible.

Parameters:

distance - the distance to scroll

Returns:

whether scrolling is possible

scroll

public void scroll(int distance)

Description copied from interface: GUIScrollable

Scrolls the element.

Parameters:

distance - the distance to scroll

resetScroll

public void resetScroll()

Description copied from interface: GUIScrollable

Resets the scroll index to the default value.