com.realtime.crossfire.jxclient.gui.gui

Class AbstractGUIElement

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGUIMap, AbstractLabel, ActivatableGUIElement, GUIComboBox, GUIDialogBackground, GUIDupGauge, GUIFill, GUIGauge, GUILog, GUIMapDirections, GUIPicture, GUIPictureStat

public abstract class AbstractGUIElement
extends javax.swing.JComponent
implements GUIElement

Abstract base class for GUI elements to be shown in Guis.

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

Modifier	Constructor and Description
protected	AbstractGUIElement(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, boolean opaque, @NotNull GuiFactory guiFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases all allocated resources.
int	getDialogBorderBottom() Returns the size of the dialog's bottom border.
int	getDialogBorderLeft() Returns the size of the dialog's left border.
int	getDialogBorderRight() Returns the size of the dialog's right border.
int	getDialogBorderTop() Returns the size of the dialog's top border.
@NotNull java.lang.String	getName() Returns the internal name of this gui element.
abstract @Nullable TooltipText	getTooltip() Returns the current tooltip text.
void	inhibitListeners() Prevents change listeners to be notified.
boolean	isDefault() Returns whether this element is the default element.
boolean	isIgnore() Returns whether this gui element is to be ignored for user interaction.
void	mouseClicked(@NotNull java.awt.event.MouseEvent e) Will be called when the user has clicked (pressed+released) this element.
void	mouseDragged(@NotNull java.awt.event.MouseEvent e) Will be called when the mouse moves within this component while the button is pressed.
void	mouseEntered(@NotNull java.awt.event.MouseEvent e) Will be called when the mouse has entered the bounding box of this element.
void	mouseExited(@NotNull java.awt.event.MouseEvent e) Will be called when the mouse has left the bounding box of this element.
void	mouseMoved(@NotNull java.awt.event.MouseEvent e) Will be called when the mouse moves within this component.
void	mousePressed(@NotNull java.awt.event.MouseEvent e) Will be called when the user has pressed the mouse inside this element.
void	mouseReleased(@NotNull java.awt.event.MouseEvent e) Will be called when the user has released the mouse.
void	mouseWheelMoved(int wheelRotation) Will be called when the mouse wheel has been moved.
protected @Nullable TooltipText	newTooltipText(@Nullable java.lang.String tooltipText) Creates a TooltipText instance relative to this instance.
void	setChanged() Records that the contents have changed and must be repainted.
void	setChangedListener(@Nullable GUIElementChangedListener changedListener) Sets the GUIElementChangedListener to be notified.
void	setDefault(boolean isDefault) Sets whether this element is the default element.
void	setIgnore() Marks this gui element to be ignored for user interaction.
protected void	tooltipChanged() Must be called whenever the tooltip may have changed.
@NotNull java.lang.String	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, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, 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

Methods inherited from interface com.realtime.crossfire.jxclient.gui.gui.GUIElement

notifyOpen

Constructor Detail

AbstractGUIElement

protected AbstractGUIElement(@NotNull
                             @NotNull TooltipManager tooltipManager,
                             @NotNull
                             @NotNull GUIElementListener elementListener,
                             @NotNull
                             @NotNull java.lang.String name,
                             boolean opaque,
                             @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

opaque - whether this element is opaque

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

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.awt.Component

isDefault

public boolean isDefault()

Description copied from interface: GUIElement

Returns whether this element is the default element. The default element is selected with the ENTER key.

Specified by:

isDefault in interface GUIElement

Returns:

whether this element is the default element

setDefault

public void setDefault(boolean isDefault)

Description copied from interface: GUIElement

Sets whether this element is the default element. The default element is selected with the ENTER key.

Specified by:

setDefault in interface GUIElement

Parameters:

isDefault - whether this element is the default element

setIgnore

public void setIgnore()

Description copied from interface: GUIElement

Marks this gui element to be ignored for user interaction.

Specified by:

setIgnore in interface GUIElement

isIgnore

public boolean isIgnore()

Description copied from interface: GUIElement

Returns whether this gui element is to be ignored for user interaction.

Specified by:

isIgnore in interface GUIElement

Returns:

whether this gui element is ignored

getName

@NotNull
public @NotNull java.lang.String getName()

Description copied from interface: GUIElement

Returns the internal name of this gui element. The name is used in skin files for identifying an element.

Specified by:

getName in interface GUIElement

Overrides:

getName in class java.awt.Component

Returns:

the name

mouseClicked

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

Description copied from interface: GUIElement

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

Parameters:

e - the mouse event relative to this element

mouseEntered

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

Description copied from interface: GUIElement

Will be called when the mouse has entered the bounding box of this element.

Specified by:

mouseEntered in interface GUIElement

Parameters:

e - the mouse event relative to this element

mouseExited

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

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 unless GUIElement.mouseEntered(MouseEvent) has been called before.

Specified by:

mouseExited in interface GUIElement

Parameters:

e - the mouse event relative to this element

mousePressed

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

Description copied from interface: GUIElement

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

Specified by:

mousePressed in interface GUIElement

Parameters:

e - the mouse event relative to this element

mouseReleased

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

Description copied from interface: GUIElement

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

Parameters:

e - the mouse event relative to this element

mouseMoved

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

Description copied from interface: GUIElement

Will be called when the mouse moves within this component. before.

Specified by:

mouseMoved in interface GUIElement

Parameters:

e - the mouse event relative to this element

mouseDragged

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

Description copied from interface: GUIElement

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after GUIElement.mouseMoved(MouseEvent).

Note: if the mouse leaves this element's bounding box while the mouse button is still pressed, further mouseDragged (but no mouseMoved) events will be generated.

Specified by:

mouseDragged in interface GUIElement

Parameters:

e - the mouse event relative to this element

mouseWheelMoved

public void mouseWheelMoved(int wheelRotation)

Description copied from interface: GUIElement

Will be called when the mouse wheel has been moved.

Specified by:

mouseWheelMoved in interface GUIElement

Parameters:

wheelRotation - the movement amount; negative=away from the user, positive=towards the user

setChanged

public void setChanged()

Description copied from interface: GUIElement

Records that the contents have changed and must be repainted.

Specified by:

setChanged in interface GUIElement

getTooltip

@Nullable
public abstract @Nullable TooltipText getTooltip()

Returns the current tooltip text.

Returns:

the tooltip text or null to not show a tooltip

newTooltipText

@Nullable
protected @Nullable TooltipText newTooltipText(@Nullable
                                                         @Nullable java.lang.String tooltipText)

Creates a TooltipText instance relative to this instance.

Parameters:

tooltipText - the text of the instance or null to return null

Returns:

the new instance or null if this component is not in a GUI

tooltipChanged

protected void tooltipChanged()

Must be called whenever the tooltip may have changed.

setChangedListener

public void setChangedListener(@Nullable
                               @Nullable GUIElementChangedListener changedListener)

Description copied from interface: GUIElement

Sets the GUIElementChangedListener to be notified. Note that at most one such listener may be set per gui element.

Specified by:

setChangedListener in interface GUIElement

Parameters:

changedListener - the listener or null to unset

inhibitListeners

public void inhibitListeners()

Prevents change listeners to be notified.

getDialogBorderTop

public int getDialogBorderTop()

Returns the size of the dialog's top border.

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderLeft

public int getDialogBorderLeft()

Returns the size of the dialog's left border.

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderRight

public int getDialogBorderRight()

Returns the size of the dialog's right border.

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderBottom

public int getDialogBorderBottom()

Returns the size of the dialog's bottom border.

Returns:

the size in pixels or 0 if this GUI element is not a dialog