Package com.realtime.crossfire.jxclient.gui.button

Class GUISelectableButton

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.button.AbstractButton

com.realtime.crossfire.jxclient.gui.button.AbstractButton2

com.realtime.crossfire.jxclient.gui.button.GUISelectableButton

All Implemented Interfaces:

GUISelectable, GUIElement, KeyPressedHandler, ImageObserver, MenuContainer, Serializable

public class GUISelectableButton
extends AbstractButton2
implements GUISelectable

A GUIElement that implements a button. The button shows an image and optionally overlays a text string.

See Also:

• Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, 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	Description
GUISelectableButton(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull String name, @NotNull BufferedImage imageUp, @NotNull BufferedImage imageDown, @NotNull String tooltipText, boolean autoRepeat, @NotNull CommandList commandList, @NotNull GuiFactory guiFactory, @NotNull NewCharModel newCharModel)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	activeChanged()	Will be called whenever the active state has changed.
@Nullable TooltipText	getTooltip()	Returns the current tooltip text.
protected boolean	isSelected()	Returns which image should be shown.
void	notifyOpen()	Called each time the enclosing dialog is opened (or raised).
void	select(boolean selected)	Selects or deselects the element.

Methods inherited from class com.realtime.crossfire.jxclient.gui.button.AbstractButton2

getMaximumSize, getMinimumSizeInt, paintComponent

Methods inherited from class com.realtime.crossfire.jxclient.gui.button.AbstractButton

dispose, execute, getMinimumSize, getPreferredSize, keyPressed, mouseClicked, mouseExited, mousePressed, mouseReleased

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

activateNextElement, activatePrevElement, isActive, markInactivePending, 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, mouseMoved, 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, 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

Constructor Details

GUISelectableButton

public GUISelectableButton(@NotNull
 @NotNull TooltipManager tooltipManager,
 @NotNull
 @NotNull GUIElementListener elementListener,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull BufferedImage imageUp,
 @NotNull
 @NotNull BufferedImage imageDown,
 @NotNull
 @NotNull String tooltipText,
 boolean autoRepeat,
 @NotNull
 @NotNull CommandList commandList,
 @NotNull
 @NotNull GuiFactory guiFactory,
 @NotNull
 @NotNull NewCharModel newCharModel)

Creates a new instance. Both imageUp and imageDown must have the same size. The x/y coordinates specify the baseline of the first character of the overlay text.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

imageUp - the image in unselected state

imageDown - the image in selected state

tooltipText - the tooltip text

autoRepeat - whether the button should autorepeat while being pressed

commandList - the commands to execute when the button is elected

guiFactory - the global GUI factory instance

newCharModel - the global new char model instance

Method Details

isSelected

protected boolean isSelected()

Description copied from class: AbstractButton2

Returns which image should be shown.

Specified by:

isSelected in class AbstractButton2

Returns:

false=show "up" image, true=show "down" image

select

public void select(boolean selected)

Description copied from interface: GUISelectable

Selects or deselects the element.

Specified by:

select in interface GUISelectable

Parameters:

selected - whether the element should be selected

activeChanged

protected void activeChanged()

Description copied from class: ActivatableGUIElement

Will be called whenever the active state has changed.

Specified by:

activeChanged in class ActivatableGUIElement

getTooltip

@Nullable
public @Nullable TooltipText getTooltip()

Description copied from class: AbstractGUIElement

Returns the current tooltip text.

Overrides:

getTooltip in class AbstractButton2

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

Specified by:

notifyOpen in interface GUIElement