com.realtime.crossfire.jxclient.gui.gui.GUIElement Interface Reference

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

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

Public Member Functions
void	dispose ()
String	getName ()
boolean	isDefault ()
boolean	isIgnore ()
void	mouseClicked (@NotNull MouseEvent e)
void	mouseDragged (@NotNull MouseEvent e)
void	mouseEntered (@NotNull MouseEvent e)
void	mouseExited (@NotNull MouseEvent e)
void	mouseMoved (@NotNull MouseEvent e)
void	mousePressed (@NotNull MouseEvent e)
void	mouseReleased (@NotNull MouseEvent e)
void	mouseWheelMoved (int wheelRotation)
void	notifyOpen ()
void	setChanged ()
void	setChangedListener (@Nullable GUIElementChangedListener changedListener)
void	setDefault (boolean isDefault)
void	setIgnore ()

Detailed Description

Interface defining an abstract GUI element.

Author

Andreas Kirschbaum

Definition at line 33 of file GUIElement.java.

Member Function Documentation

dispose()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.dispose

(

)

Releases all allocated resources.

Implemented in com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap, com.realtime.crossfire.jxclient.gui.label.GUILabelStats2, com.realtime.crossfire.jxclient.gui.log.GUILog, com.realtime.crossfire.jxclient.gui.item.GUIItemShortcut, com.realtime.crossfire.jxclient.gui.item.GUIItemQuest, com.realtime.crossfire.jxclient.gui.label.GUILabelStats, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell, com.realtime.crossfire.jxclient.gui.misc.GUIPictureStat, com.realtime.crossfire.jxclient.gui.item.GUIItemSpellSkill, com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.item.GUIItemFloor, com.realtime.crossfire.jxclient.gui.item.GUIItemInventory, com.realtime.crossfire.jxclient.gui.label.GUINewcharLabel, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement, com.realtime.crossfire.jxclient.gui.list.GUIMetaElement, com.realtime.crossfire.jxclient.gui.misc.GUILabelMessage, com.realtime.crossfire.jxclient.gui.misc.GUISpinner, com.realtime.crossfire.jxclient.gui.misc.GUICheckBox, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.button.AbstractButton, com.realtime.crossfire.jxclient.gui.combobox.GUIComboBox< T >, com.realtime.crossfire.jxclient.gui.item.GUIItemItem, com.realtime.crossfire.jxclient.gui.label.GUILabelFailure, com.realtime.crossfire.jxclient.gui.label.GUILabelQuery, and com.realtime.crossfire.jxclient.gui.log.GUIMessageLog.

Referenced by com.realtime.crossfire.jxclient.skin.skin.DefaultJXCSkin.detach(), and com.realtime.crossfire.jxclient.gui.list.GUIList< GUICharacter >.resizeElements().

Here is the caller graph for this function:

getName()

String com.realtime.crossfire.jxclient.gui.gui.GUIElement.getName

(

)

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

Returns

the name

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.deactivateCommandInput(), com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementEndingWith(), and com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementNotEndingWith().

Here is the caller graph for this function:

isDefault()

boolean com.realtime.crossfire.jxclient.gui.gui.GUIElement.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

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

isIgnore()

boolean com.realtime.crossfire.jxclient.gui.gui.GUIElement.isIgnore

(

)

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

Returns

whether this gui element is ignored

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

mouseClicked()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseClicked

(

@NotNull 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

Implemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.textinput.GUIText, com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge, com.realtime.crossfire.jxclient.gui.gauge.GUIGauge, com.realtime.crossfire.jxclient.gui.list.GUIMetaElement, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement, com.realtime.crossfire.jxclient.gui.misc.GUICheckBox, com.realtime.crossfire.jxclient.gui.button.AbstractButton, com.realtime.crossfire.jxclient.gui.map.GUIMap, and com.realtime.crossfire.jxclient.gui.item.GUIItem.

mouseDragged()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseDragged

(

@NotNull 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

Implemented 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.gui.AbstractGUIElement, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, and com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged().

Here is the caller graph for this function:

mouseEntered()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseEntered

(

@NotNull 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

Implemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

mouseExited()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseExited

(

@NotNull 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

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

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.enterElement().

Here is the caller graph for this function:

mouseMoved()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseMoved

(

@NotNull MouseEvent

e

)

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

Parameters

e	the mouse event relative to this element

Implemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseDragged(), and com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseMoved().

Here is the caller graph for this function:

mousePressed()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mousePressed

(

@NotNull MouseEvent

e

)

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

Parameters

e	the mouse event relative to this element

Implemented 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.gui.AbstractGUIElement, 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.

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mousePressed().

Here is the caller graph for this function:

mouseReleased()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseReleased

(

@NotNull 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

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

Referenced by com.realtime.crossfire.jxclient.gui.misc.MouseTracker.mouseReleased().

Here is the caller graph for this function:

mouseWheelMoved()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.mouseWheelMoved

(

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

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

notifyOpen()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.notifyOpen

(

)

Called each time the enclosing dialog is opened (or raised).

Implemented in com.realtime.crossfire.jxclient.gui.item.GUIItemInventory, com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground, com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge, com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge, com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledgeType, com.realtime.crossfire.jxclient.gui.gauge.GUIGauge, com.realtime.crossfire.jxclient.gui.item.GUIItemShortcut, com.realtime.crossfire.jxclient.gui.list.GUICharacter, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.button.GUITextButton, com.realtime.crossfire.jxclient.gui.list.GUIMetaElement, com.realtime.crossfire.jxclient.gui.misc.GUIPictureStat, com.realtime.crossfire.jxclient.gui.item.GUIItemQuest, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell, com.realtime.crossfire.jxclient.gui.misc.GUICheckBox, com.realtime.crossfire.jxclient.gui.item.GUIItemSpellSkill, com.realtime.crossfire.jxclient.gui.item.GUIItemFloor, com.realtime.crossfire.jxclient.gui.label.GUIHTMLLabel, com.realtime.crossfire.jxclient.gui.label.GUINewcharLabel, com.realtime.crossfire.jxclient.gui.map.GUIMiniMap, com.realtime.crossfire.jxclient.gui.label.GUIMultiLineLabel, com.realtime.crossfire.jxclient.gui.map.GUIMapDirections, com.realtime.crossfire.jxclient.gui.misc.GUISpinner, com.realtime.crossfire.jxclient.gui.map.GUIMap, com.realtime.crossfire.jxclient.gui.misc.GUIPicture, com.realtime.crossfire.jxclient.gui.label.GUIOneLineLabel, com.realtime.crossfire.jxclient.gui.button.GUISelectableButton, com.realtime.crossfire.jxclient.gui.textinput.GUICommandText, com.realtime.crossfire.jxclient.gui.log.GUILabelLog, com.realtime.crossfire.jxclient.gui.textinput.GUIQueryText, com.realtime.crossfire.jxclient.gui.textinput.GUITextField, com.realtime.crossfire.jxclient.gui.button.GUIButton, com.realtime.crossfire.jxclient.gui.log.GUIMessageLog, and com.realtime.crossfire.jxclient.gui.misc.GUIFill.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.notifyOpen().

Here is the caller graph for this function:

setChanged()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.setChanged

(

)

Records that the contents have changed and must be repainted.

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

setChangedListener()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.setChangedListener

(

@Nullable 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

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

setDefault()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.setDefault

(

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

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

setIgnore()

void com.realtime.crossfire.jxclient.gui.gui.GUIElement.setIgnore

(

)

Marks this gui element to be ignored for user interaction.

Implemented in com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

---

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

• src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/gui/GUIElement.java