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
,ImageObserver
,MenuContainer
,Serializable
- Direct Known Subclasses:
AbstractButton2
,GUITextButton
Abstract base class for button classes.
- See Also:
-
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
ConstructorsModifierConstructorDescriptionprotected
AbstractButton
(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull String name, boolean opaque, boolean autoRepeat, @NotNull CommandList commandList, @NotNull GuiFactory guiFactory, @NotNull NewCharModel newCharModel) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
dispose()
Releases all allocated resources.void
execute()
Executes the actions associated with this GUI element.@Nullable Dimension
protected abstract @NotNull Dimension
Returns the minimal size needed to display this component.@Nullable Dimension
boolean
keyPressed
(@NotNull KeyEvent2 e) Invoked when a key has been pressed.void
mouseClicked
(@NotNull MouseEvent e) Will be called when the user has clicked (pressed+released) this element.void
mouseExited
(@NotNull MouseEvent e) Will be called when the mouse has left the bounding box of this element.void
mousePressed
(@NotNull MouseEvent e) Will be called when the user has pressed the mouse inside this element.void
mouseReleased
(@NotNull MouseEvent e) Will be called when the user has released the mouse.Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
activateNextElement, activatePrevElement, activeChanged, isActive, markInactivePending, setActive, setInactiveIfPending, setNextActive, setPrevActive
Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, getTooltip, 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, getMaximumSize, 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, 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, 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 Details
-
AbstractButton
protected AbstractButton(@NotNull @NotNull TooltipManager tooltipManager, @NotNull @NotNull GUIElementListener elementListener, @NotNull @NotNull String name, boolean opaque, boolean autoRepeat, @NotNull @NotNull CommandList commandList, @NotNull @NotNull GuiFactory guiFactory, @NotNull @NotNull NewCharModel newCharModel) Creates a new instance.- Parameters:
tooltipManager
- the tooltip manager to updateelementListener
- the element listener to notifyname
- the name of this elementopaque
- whether this element is opaqueautoRepeat
- whether the button should autorepeat while being pressedcommandList
- the commands to execute when the button is electedguiFactory
- the global GUI factory instancenewCharModel
- the global new char model instance
-
-
Method Details
-
dispose
public void dispose()Description copied from interface:GUIElement
Releases all allocated resources.- Specified by:
dispose
in interfaceGUIElement
- Overrides:
dispose
in classAbstractGUIElement
-
mouseClicked
Description copied from interface:GUIElement
Will be called when the user has clicked (pressed+released) this element. This event will be delivered afterGUIElement.mouseReleased(MouseEvent)
.- Specified by:
mouseClicked
in interfaceGUIElement
- Overrides:
mouseClicked
in classAbstractGUIElement
- Parameters:
e
- the mouse event relative to this element
-
mouseReleased
Description copied from interface:GUIElement
Will be called when the user has released the mouse. This event may be delivered even if no previousGUIElement.mousePressed(MouseEvent)
has been delivered before.- Specified by:
mouseReleased
in interfaceGUIElement
- Overrides:
mouseReleased
in classAbstractGUIElement
- Parameters:
e
- the mouse event relative to this element
-
mousePressed
Description copied from class:ActivatableGUIElement
Will be called when the user has pressed the mouse inside this element.- Specified by:
mousePressed
in interfaceGUIElement
- Overrides:
mousePressed
in classActivatableGUIElement
- Parameters:
e
- the mouse event relative to this element
-
mouseExited
Description copied from interface:GUIElement
Will be called when the mouse has left the bounding box of this element. This function will not be called unlessGUIElement.mouseEntered(MouseEvent)
has been called before.- Specified by:
mouseExited
in interfaceGUIElement
- Overrides:
mouseExited
in classAbstractGUIElement
- 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 classActivatableGUIElement
-
getPreferredSize
- Overrides:
getPreferredSize
in classJComponent
-
getMinimumSize
- Overrides:
getMinimumSize
in classJComponent
-
getMinimumSizeInt
Returns the minimal size needed to display this component.- Returns:
- the minimal size
-
keyPressed
Description copied from interface:KeyPressedHandler
Invoked when a key has been pressed.- Specified by:
keyPressed
in interfaceKeyPressedHandler
- Parameters:
e
- the key event for the key- Returns:
- whether the key event has been consumed
-