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:
AbstractButton2,GUITextButton
public abstract class AbstractButton extends ActivatableGUIElement implements KeyPressedHandler
Abstract base class for button classes.- See Also:
- Serialized Form
-
-
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractButton(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, int transparency, boolean autoRepeat, @NotNull CommandList commandList, @NotNull GuiFactory guiFactory, @NotNull NewCharModel newCharModel)Creates a new instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voiddispose()Releases all allocated resources.voidexecute()Executes the actions associated with this GUI element.@Nullable java.awt.DimensiongetMinimumSize()protected abstract @NotNull java.awt.DimensiongetMinimumSizeInt()Returns the minimal size needed to display this component.@Nullable java.awt.DimensiongetPreferredSize()booleankeyPressed(@NotNull KeyEvent2 e)Invoked when a key has been pressed.voidmouseClicked(@NotNull java.awt.event.MouseEvent e)Will be called when the user has clicked (pressed+released) this element.voidmouseExited(@NotNull java.awt.event.MouseEvent e)Will be called when the mouse has left the bounding box of this element.voidmousePressed(@NotNull java.awt.event.MouseEvent e)Will be called when the user has pressed the mouse inside this element.voidmouseReleased(@NotNull 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
getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, getTooltip, inhibitListeners, isDefault, isIgnore, mouseDragged, mouseEntered, mouseMoved, 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 Detail
-
AbstractButton
protected AbstractButton(@NotNull @NotNull TooltipManager tooltipManager, @NotNull @NotNull GUIElementListener elementListener, @NotNull @NotNull java.lang.String name, int transparency, 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 elementtransparency- the transparency value for the backing bufferautoRepeat- 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 Detail
-
dispose
public void dispose()
Description copied from interface:GUIElementReleases all allocated resources.- Specified by:
disposein interfaceGUIElement- Overrides:
disposein classAbstractGUIElement
-
mouseClicked
public void mouseClicked(@NotNull @NotNull java.awt.event.MouseEvent e)Description copied from interface:GUIElementWill be called when the user has clicked (pressed+released) this element. This event will be delivered afterGUIElement.mouseReleased(MouseEvent).- Specified by:
mouseClickedin interfaceGUIElement- Overrides:
mouseClickedin classAbstractGUIElement- Parameters:
e- the mouse event relative to this element
-
mouseReleased
public void mouseReleased(@NotNull @NotNull java.awt.event.MouseEvent e)Description copied from interface:GUIElementWill 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:
mouseReleasedin interfaceGUIElement- Overrides:
mouseReleasedin classAbstractGUIElement- Parameters:
e- the mouse event relative to this element
-
mousePressed
public void mousePressed(@NotNull @NotNull java.awt.event.MouseEvent e)Description copied from class:ActivatableGUIElementWill be called when the user has pressed the mouse inside this element.- Specified by:
mousePressedin interfaceGUIElement- Overrides:
mousePressedin classActivatableGUIElement- Parameters:
e- the mouse event relative to this element
-
mouseExited
public void mouseExited(@NotNull @NotNull java.awt.event.MouseEvent e)Description copied from interface:GUIElementWill 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:
mouseExitedin interfaceGUIElement- Overrides:
mouseExitedin classAbstractGUIElement- Parameters:
e- the mouse event relative to this element
-
execute
public void execute()
Description copied from class:ActivatableGUIElementExecutes the actions associated with this GUI element. Does nothing if this element has no associated actions.- Specified by:
executein classActivatableGUIElement
-
getPreferredSize
@Nullable public @Nullable java.awt.Dimension getPreferredSize()
- Overrides:
getPreferredSizein classjavax.swing.JComponent
-
getMinimumSize
@Nullable public @Nullable java.awt.Dimension getMinimumSize()
- Overrides:
getMinimumSizein classjavax.swing.JComponent
-
getMinimumSizeInt
@NotNull protected abstract @NotNull java.awt.Dimension getMinimumSizeInt()
Returns the minimal size needed to display this component.- Returns:
- the minimal size
-
keyPressed
public boolean keyPressed(@NotNull @NotNull KeyEvent2 e)Description copied from interface:KeyPressedHandlerInvoked when a key has been pressed.- Specified by:
keyPressedin interfaceKeyPressedHandler- Parameters:
e- the key event for the key- Returns:
- whether the key event has been consumed
-
-