Inheritance diagram for com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement:

Public Member Functions
void	dispose ()

int	getDialogBorderBottom ()

int	getDialogBorderLeft ()

int	getDialogBorderRight ()

int	getDialogBorderTop ()

String	getName ()

abstract TooltipText	getTooltip ()

void	inhibitListeners ()

boolean	isDefault ()

boolean	isIgnore ()

void	mouseClicked (@NotNull final MouseEvent e)

void	mouseDragged (@NotNull final MouseEvent e)

void	mouseEntered (@NotNull final MouseEvent e)

void	mouseExited (@NotNull final MouseEvent e)

void	mouseMoved (@NotNull final MouseEvent e)

void	mousePressed (@NotNull final MouseEvent e)

void	mouseReleased (@NotNull final MouseEvent e)

void	mouseWheelMoved (final int wheelRotation)

void	setChanged ()

void	setChangedListener (@Nullable final GUIElementChangedListener changedListener)

void	setDefault (final boolean isDefault)

void	setIgnore ()

String	toString ()

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.GUIElement
void	notifyOpen ()

Protected Member Functions
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)

TooltipText	newTooltipText (@Nullable final String tooltipText)

void	tooltipChanged ()

Private Attributes
GUIElementChangedListener	changedListener

final GUIElementListener	elementListener

final GuiFactory	guiFactory

boolean	ignore

boolean	inhibitListeners

boolean	isDefault

final String	name

boolean	pendingChange

final Runnable	setChangedRunnable

final TooltipManager	tooltipManager

Static Private Attributes
static final long	serialVersionUID = 1

Detailed Description

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

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 37 of file AbstractGUIElement.java.

Constructor & Destructor Documentation

◆ AbstractGUIElement()

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.AbstractGUIElement	(	@NotNull final TooltipManager	tooltipManager,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	name,
		final boolean	opaque,
		@NotNull final GuiFactory	guiFactory
	)

protected

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

Definition at line 130 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Member Function Documentation

◆ dispose()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.dispose ( )

Releases all allocated resources.

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 141 of file AbstractGUIElement.java.

◆ getDialogBorderBottom()

int com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.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

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.

Definition at line 313 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseVertical().

Here is the caller graph for this function:

◆ getDialogBorderLeft()

int com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.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

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.

Definition at line 297 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseHorizontal().

Here is the caller graph for this function:

◆ getDialogBorderRight()

int com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.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

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.

Definition at line 305 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseHorizontal().

Here is the caller graph for this function:

◆ getDialogBorderTop()

int com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.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

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.

Definition at line 289 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.skin.io.JXCSkinLoader.parseVertical().

Here is the caller graph for this function:

◆ getName()

String com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.getName ( )

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

Returns: the name

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 174 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name.

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.activateCommandInput().

Here is the caller graph for this function:

◆ getTooltip()

abstract TooltipText com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.getTooltip ( )

abstract

Returns the current tooltip text.

Returns: the tooltip text or
null

to not show a tooltip

Referenced by com.realtime.crossfire.jxclient.gui.label.TooltipManagerImpl.addTooltip().

Here is the caller graph for this function:

◆ inhibitListeners()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners ( )

Prevents change listeners to be notified.

Definition at line 279 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChangedRunnable.

◆ isDefault()

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault ( )

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

Returns: whether this element is the default element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 152 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault.

◆ isIgnore()

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isIgnore ( )

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

Returns: whether this gui element is ignored

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 167 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.ignore.

◆ mouseClicked()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseClicked ( @NotNull final MouseEvent e )

Will be called when the user has clicked (pressed+released) this element. This event will be delivered after mouseReleased(MouseEvent).

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 179 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, and com.realtime.crossfire.jxclient.gui.gui.GUIElementListener.raiseDialog().

Here is the call graph for this function:

◆ mouseDragged()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseDragged ( @NotNull final MouseEvent e )

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after 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.

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground, com.realtime.crossfire.jxclient.gui.log.GUILog, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, and com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.

Definition at line 215 of file AbstractGUIElement.java.

◆ mouseEntered()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseEntered ( @NotNull final MouseEvent e )

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

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >.

Definition at line 186 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.TooltipManager.setElement(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Here is the call graph for this function:

◆ mouseExited()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseExited ( @NotNull final MouseEvent e )

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

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, and com.realtime.crossfire.jxclient.gui.button.AbstractButton.

Definition at line 193 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager, and com.realtime.crossfire.jxclient.gui.gui.TooltipManager.unsetElement().

Here is the call graph for this function:

◆ mouseMoved()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseMoved ( @NotNull final MouseEvent e )

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

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >.

Definition at line 211 of file AbstractGUIElement.java.

◆ mousePressed()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mousePressed ( @NotNull final MouseEvent e )

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

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground, com.realtime.crossfire.jxclient.gui.log.GUILog, com.realtime.crossfire.jxclient.gui.button.AbstractButton, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement, and com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.

Definition at line 200 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener, and com.realtime.crossfire.jxclient.gui.gui.GUIElementListener.raiseDialog().

Here is the call graph for this function:

◆ mouseReleased()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseReleased ( @NotNull final MouseEvent e )

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

Parameters

e	the mouse event relative to this element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground, com.realtime.crossfire.jxclient.gui.log.GUILog, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.button.AbstractButton, and com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.

Definition at line 207 of file AbstractGUIElement.java.

◆ mouseWheelMoved()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.mouseWheelMoved ( final int wheelRotation )

Will be called when the mouse wheel has been moved.

Parameters

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

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.log.GUILog, and com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar.

Definition at line 219 of file AbstractGUIElement.java.

◆ newTooltipText()

TooltipText com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.newTooltipText ( @Nullable final String tooltipText )

protected

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

Definition at line 247 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.getComponent(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.getGui(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChanged()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged ( )

Records that the contents have changed and must be repainted.

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, and com.realtime.crossfire.jxclient.gui.item.GUIItemInventory.

Definition at line 223 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners, com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeLater(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.pendingChange, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChangedRunnable.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setChangedListener()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChangedListener ( @Nullable final GUIElementChangedListener changedListener )

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

Parameters

changedListener

the listener or

null

to unset

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 272 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.changedListener.

Referenced by com.realtime.crossfire.jxclient.gui.textinput.GUIText.GUIText().

Here is the caller graph for this function:

◆ setDefault()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setDefault ( final boolean isDefault )

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

Parameters

isDefault whether this element is the default element

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 157 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault.

◆ setIgnore()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setIgnore ( )

Marks this gui element to be ignored for user interaction.

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 162 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.ignore.

◆ tooltipChanged()

void com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipChanged ( )

protected

Must be called whenever the tooltip may have changed.

Definition at line 265 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager, and com.realtime.crossfire.jxclient.gui.gui.TooltipManager.tooltipTextChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.toString ( )

Definition at line 147 of file AbstractGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name.

Member Data Documentation

◆ changedListener

GUIElementChangedListener com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.changedListener

private

The GUIElementChangedListener to be notified whenever this element has changed.

Definition at line 55 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChangedListener().

◆ elementListener

final GUIElementListener com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.elementListener

private

The GUIElementListener to notify.

Definition at line 89 of file AbstractGUIElement.java.

◆ guiFactory

final GuiFactory com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory

private

The global GuiFactory instance.

Definition at line 48 of file AbstractGUIElement.java.

◆ ignore

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.ignore

private

Whether this gui element should be ignored for user interaction.

Definition at line 71 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isIgnore(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setIgnore().

◆ inhibitListeners

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners

private

If set, change listeners will not be notified.

Definition at line 66 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

◆ isDefault

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault

private

Whether this element is the default element. The default element is selected with the ENTER key.

Definition at line 61 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.getDefaultElement(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setDefault().

◆ name

final String com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name

private

The name of this element.

Definition at line 77 of file AbstractGUIElement.java.

◆ pendingChange

boolean com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.pendingChange

private

Used to avoid refreshing items all the time.

Definition at line 94 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.serialVersionUID = 1

staticprivate

The serial version UID.

Definition at line 42 of file AbstractGUIElement.java.

◆ setChangedRunnable

final Runnable com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChangedRunnable

private

Initial value:

= new Runnable() {
 
        @Override
        public void run() {
            synchronized (setChangedRunnable) {
                pendingChange = false;
                if (inhibitListeners) {
                    return;
                }
            }
            final Gui parent = guiFactory.getGui(AbstractGUIElement.this);
            if (parent != null) {
                parent.repaint();
            }
            if (isVisible() && changedListener != null) {
                changedListener.notifyChanged();
            }
        }
 
    }

The Runnable that implements the code of setChanged() which must run on the EDT.

Definition at line 101 of file AbstractGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.inhibitListeners(), and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

◆ tooltipManager

final TooltipManager com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager

private

The TooltipManager to update.

Definition at line 83 of file AbstractGUIElement.java.

The documentation for this class was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/gui/AbstractGUIElement.java

Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractGUIElement()

Member Function Documentation

◆ dispose()

◆ getDialogBorderBottom()

◆ getDialogBorderLeft()

◆ getDialogBorderRight()

◆ getDialogBorderTop()

◆ getName()

◆ getTooltip()

◆ inhibitListeners()

◆ isDefault()

◆ isIgnore()

◆ mouseClicked()

◆ mouseDragged()

◆ mouseEntered()

◆ mouseExited()

◆ mouseMoved()

◆ mousePressed()

◆ mouseReleased()

◆ mouseWheelMoved()

◆ newTooltipText()

◆ setChanged()

◆ setChangedListener()

◆ setDefault()

◆ setIgnore()

◆ tooltipChanged()

◆ toString()

Member Data Documentation

◆ changedListener

◆ elementListener

◆ guiFactory

◆ ignore

◆ inhibitListeners

◆ isDefault

◆ name

◆ pendingChange

◆ serialVersionUID

◆ setChangedRunnable

◆ tooltipManager