com.realtime.crossfire.jxclient.gui.button

Class AbstractButton

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIButton, GUITextButton

public abstract class AbstractButton
extends ActivatableGUIElement
implements KeyPressedHandler

Abstract base class for button classes.

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

Modifier and Type	Field and Description
private boolean	autoRepeat Whether this button should autorepeat.
private CommandList	commandList The commands to execute when the button is elected.
private static long	serialVersionUID The serial version UID.
private static int	TIMEOUT_FIRST The autorepeat delay initially.
private static int	TIMEOUT_SECOND The autorepeat delay for further repeats.
private java.awt.event.ActionListener	timeoutEvent The ActionListener for generating autorepeat events.
private javax.swing.Timer	timer The Timer for auto-repeating buttons.

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 and Description
protected	AbstractButton(TooltipManager tooltipManager, GUIElementListener elementListener, java.lang.String name, int transparency, boolean autoRepeat, CommandList commandList) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the actions associated with this GUI element.
java.awt.Dimension	getMinimumSize()
protected abstract java.awt.Dimension	getMinimumSizeInt() Returns the minimal size needed to display this component.
java.awt.Dimension	getPreferredSize()
boolean	keyPressed(KeyEvent2 e) Invoked when a key has been pressed.
void	mouseClicked(java.awt.event.MouseEvent e) Will be called when the user has clicked (pressed+released) this element.
void	mouseExited(java.awt.event.MouseEvent e) Will be called when the mouse has left the bounding box of this element.
void	mousePressed(java.awt.event.MouseEvent e) Will be called when the user has pressed the mouse inside this element.
void	mouseReleased(java.awt.event.MouseEvent e) Will be called when the user has released the mouse.

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

activeChanged, isActive, markInactivePending, setActive, setInactiveIfPending

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

dispose, getName, hasTooltipText, isDefault, isIgnore, mouseDragged, mouseEntered, mouseMoved, setChanged, setChangedListener, setDefault, setIgnore, setTooltipText, setTooltipText, 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, paintComponent, 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, 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

Field Detail

autoRepeat

private final boolean autoRepeat

Whether this button should autorepeat.

commandList

@NotNull
private final CommandList commandList

The commands to execute when the button is elected.

serialVersionUID

private static final long serialVersionUID

The serial version UID.

See Also:

Constant Field Values

TIMEOUT_FIRST

private static final int TIMEOUT_FIRST

The autorepeat delay initially.

See Also:

Constant Field Values

TIMEOUT_SECOND

private static final int TIMEOUT_SECOND

The autorepeat delay for further repeats.

See Also:

Constant Field Values

timeoutEvent

@NotNull
private final java.awt.event.ActionListener timeoutEvent

The ActionListener for generating autorepeat events.

timer

@NotNull
private final javax.swing.Timer timer

The Timer for auto-repeating buttons.

Constructor Detail

AbstractButton

protected AbstractButton(@NotNull
                         TooltipManager tooltipManager,
                         @NotNull
                         GUIElementListener elementListener,
                         @NotNull
                         java.lang.String name,
                         int transparency,
                         boolean autoRepeat,
                         @NotNull
                         CommandList commandList)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

transparency - the transparency value for the backing buffer

autoRepeat - whether the button should autorepeat while being pressed

commandList - the commands to execute when the button is elected

Method Detail

execute

public void execute()

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

Specified by:

execute in class ActivatableGUIElement

getMinimumSize

@Nullable
public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getMinimumSizeInt

@NotNull
protected abstract java.awt.Dimension getMinimumSizeInt()

Returns the minimal size needed to display this component.

Returns:

the minimal size

getPreferredSize

@Nullable
public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

keyPressed

public boolean keyPressed(@NotNull
                          KeyEvent2 e)

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

mouseClicked

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

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

mouseExited

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

Will be called when the mouse has left the bounding box of this element. This function will not be called unless GUIElement.mouseEntered(MouseEvent, boolean) has been called before.

Specified by:

mouseExited in interface GUIElement

Overrides:

mouseExited in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mousePressed

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

Will be called when the user has pressed the mouse inside this element.

Specified by:

mousePressed in interface GUIElement

Overrides:

mousePressed in class ActivatableGUIElement

Parameters:

e - the mouse event relative to this element

mouseReleased

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

Will be called when the user has released the mouse. This event may be delivered even if no previous GUIElement.mousePressed(MouseEvent) has been delivered before.

Specified by:

mouseReleased in interface GUIElement

Overrides:

mouseReleased in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element