A GUIElement representing an in-game object. More...

Inheritance diagram for com.realtime.crossfire.jxclient.gui.item.GUIItem:

Collaboration diagram for com.realtime.crossfire.jxclient.gui.item.GUIItem:

Public Member Functions

void activeChanged ()

abstract void button1Clicked (final int modifiers)

Called when the left mouse button was pressed. More...

abstract void button2Clicked (final int modifiers)

Called when the middle mouse button was pressed. More...

abstract void button3Clicked (final int modifiers)

Called when the right mouse button was pressed. More...

void execute ()

void 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

More...

void setVisible (final boolean aFlag)

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

abstract void execute ()

Executes the actions associated with this GUI element. More...

boolean isActive ()

Returns whether a GUI element is active. More...

void mousePressed (@NotNull final MouseEvent e)

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

void setActive (final boolean active)

Sets the active state of a GUI element. More...

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

void dispose ()

Releases all allocated resources. More...

String getName ()

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

Returns: the name

More...

boolean hasTooltipText ()

Returns whether the tooltip is enabled.

Returns: whether the tooltip is enabled

More...

boolean 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

More...

boolean isIgnore ()

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

Returns: whether this gui element is ignored

More...

void 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

More...

void 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

More...

void mouseEntered (@NotNull final MouseEvent e, final boolean debugGui)

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

Parameters

e	the mouse event relative to this element
debugGui	whether –debug-gui is active

More...

void 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 boolean) has been called before.

Parameters

e	the mouse event relative to this element

More...

void 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

More...

void 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

More...

void 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

More...

void setChanged ()

Records that the contents have changed and must be repainted. More...

void 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

More...

void 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

More...

void setIgnore ()

Marks this gui element to be ignored for user interaction. More...

void setTooltipText (@Nullable final String tooltipText)

Sets the tooltip text to show when the mouse is inside this element.

Parameters

tooltipText

the text to show or

null

to disable the tooltip for this element

More...

void setTooltipText (@Nullable final String tooltipText, final int x, final int y, final int w, final int h)

Sets the tooltip text to show when the mouse is inside this element.

Parameters

tooltipText	the text to show, or null to disable the tooltip for this element
x	the x coordinate
y	the y coordinate
w	the width
h	the height

More...

String toString ()

Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable

boolean canScroll (int distance)

Returns whether scrolling is possible. More...

void resetScroll ()

Resets the scroll index to the default value. More...

void scroll (int distance)

Scrolls the element. More...

Protected Member Functions
	GUIItem (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name)
	Creates a new instance. More...

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
	ActivatableGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int transparency)
	Creates a new instance. More...

abstract void	activeChanged ()
	Will be called whenever the active state has changed. More...

void	markInactivePending ()
	Marks this GUI element as pending inactive. More...

void	setInactiveIfPending ()
	Unsets the active state of this GUI element if is is pending. More...

Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
	AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int transparency)
	Creates a new instance. More...

Static Private Attributes
static final long	serialVersionUID = 1
	The serial version UID. More...

Detailed Description

A GUIElement representing an in-game object.

Author: Lauwenmark; Andreas Kirschbaum

Definition at line 38 of file GUIItem.java.

Constructor & Destructor Documentation

◆ GUIItem()

com.realtime.crossfire.jxclient.gui.item.GUIItem.GUIItem	(	@NotNull final TooltipManager	tooltipManager,
		@NotNull final GUIElementListener	elementListener,
		@NotNull final String	name
	)