com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement Class Reference

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

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

Public Member Functions
void	activateNextElement ()
void	activatePrevElement ()
abstract void	execute ()
boolean	isActive ()
void	mousePressed (@NotNull final MouseEvent e)
void	setActive (final boolean active)
void	setNextActive (@NotNull final ActivatableGUIElement next)
void	setPrevActive (@NotNull final ActivatableGUIElement prev)
Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
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	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
	ActivatableGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)
abstract void	activeChanged ()
void	markInactivePending ()
void	setInactiveIfPending ()
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 boolean opaque, @NotNull final GuiFactory guiFactory)
TooltipText	newTooltipText (@Nullable final String tooltipText)
void	tooltipChanged ()

Private Attributes
final GUIElementListener	elementListener
ActivatableGUIElement	next = this
boolean	pendingInactive
ActivatableGUIElement	prev = this

Static Private Attributes
static final long	serialVersionUID = 1

Detailed Description

A GUIElement that can be set to active or inactive.

Author

Andreas Kirschbaum

Definition at line 33 of file ActivatableGUIElement.java.

Constructor & Destructor Documentation

ActivatableGUIElement()

com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.ActivatableGUIElement ( @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 73 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.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

activateNextElement()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activateNextElement

(

)

Activates the following element.

Definition at line 137 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.next, and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress(), and com.realtime.crossfire.jxclient.gui.misc.GUISpinner.keyPressed().

Here is the call graph for this function:

Here is the caller graph for this function:

activatePrevElement()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activatePrevElement

(

)

Activates the previous element.

Definition at line 145 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.prev, and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

activeChanged()

abstract void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activeChanged ( )

abstractprotected

Will be called whenever the active state has changed.

Reimplemented in com.realtime.crossfire.jxclient.gui.textinput.GUIText, com.realtime.crossfire.jxclient.gui.list.GUIMetaElement, com.realtime.crossfire.jxclient.gui.misc.GUISpinner, com.realtime.crossfire.jxclient.gui.button.GUITextButton, com.realtime.crossfire.jxclient.gui.misc.GUICheckBox, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.list.GUICharacter, com.realtime.crossfire.jxclient.gui.item.GUIItem, com.realtime.crossfire.jxclient.gui.button.GUISelectableButton, and com.realtime.crossfire.jxclient.gui.button.GUIButton.

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

Here is the caller graph for this function:

execute()

abstract void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.execute ( )

abstract

Executes the actions associated with this GUI element. Does nothing if this element has no associated actions.

Reimplemented in com.realtime.crossfire.jxclient.gui.list.GUIList< T extends GUIElement >, com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar, com.realtime.crossfire.jxclient.gui.button.AbstractButton, com.realtime.crossfire.jxclient.gui.list.GUICharacter, com.realtime.crossfire.jxclient.gui.list.GUIMetaElement, com.realtime.crossfire.jxclient.gui.misc.GUICheckBox, com.realtime.crossfire.jxclient.gui.misc.GUISpinner, com.realtime.crossfire.jxclient.gui.textinput.GUICommandText, com.realtime.crossfire.jxclient.gui.textinput.GUIQueryText, com.realtime.crossfire.jxclient.gui.textinput.GUITextField, and com.realtime.crossfire.jxclient.gui.item.GUIItem.

Referenced by com.realtime.crossfire.jxclient.gui.commands.ScrollNextCommand.execute(), com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress(), and com.realtime.crossfire.jxclient.gui.textinput.GUIText.keyPressed().

Here is the caller graph for this function:

isActive()

boolean com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.isActive

(

)

Returns whether a GUI element is active.

Returns

whether the element is active

Definition at line 124 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.elementListener, and com.realtime.crossfire.jxclient.gui.gui.GUIElementListener.isActive().

Referenced by com.realtime.crossfire.jxclient.gui.misc.GUISpinner.activeChanged(), com.realtime.crossfire.jxclient.gui.commands.ScrollNextCommand.execute(), com.realtime.crossfire.jxclient.gui.button.GUIButton.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledgeType.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemInventory.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpellSkill.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.isSelected(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.isSelected(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.paintComponent(), com.realtime.crossfire.jxclient.gui.list.GUIMetaElement.paintComponent(), com.realtime.crossfire.jxclient.gui.button.GUITextButton.paintComponent(), and com.realtime.crossfire.jxclient.gui.textinput.GUIText.paintComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

markInactivePending()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.markInactivePending ( )

protected

Marks this GUI element as pending inactive.

Definition at line 98 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.pendingInactive.

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

Here is the caller graph for this function:

mousePressed()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.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

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.

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

Definition at line 88 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Here is the call graph for this function:

setActive()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive

(

final boolean

active

)

Sets the active state of a GUI element.

Parameters

active

the active state

Definition at line 115 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.GUIElementListener.activeChanged(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.elementListener, and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.pendingInactive.

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.activateCommandInput(), com.realtime.crossfire.jxclient.gui.gui.Gui.activateDefaultElement(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activateNextElement(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activatePrevElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.deactivateCommandInput(), com.realtime.crossfire.jxclient.gui.commands.ScrollNextCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountCreateCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountCreateCharacterCommand.execute(), com.realtime.crossfire.jxclient.gui.item.GUIItem.mouseClicked(), com.realtime.crossfire.jxclient.gui.button.AbstractButton.mouseClicked(), com.realtime.crossfire.jxclient.gui.list.GUIMetaElement.mouseClicked(), com.realtime.crossfire.jxclient.gui.textinput.GUIText.mouseClicked(), com.realtime.crossfire.jxclient.gui.button.AbstractButton.mouseExited(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.mousePressed(), com.realtime.crossfire.jxclient.gui.button.AbstractButton.mouseReleased(), com.realtime.crossfire.jxclient.window.GuiManager.openDialog(), com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElementActive(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setInactiveIfPending().

Here is the call graph for this function:

Here is the caller graph for this function:

setInactiveIfPending()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setInactiveIfPending ( )

protected

Unsets the active state of this GUI element if it is pending.

Definition at line 105 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.pendingInactive, and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setNextActive()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setNextActive

(

@NotNull final ActivatableGUIElement

next

)

Sets the next activatable GUI element in the same dialog.

Parameters

next	the element

Definition at line 154 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.next.

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

Here is the caller graph for this function:

setPrevActive()

void com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setPrevActive

(

@NotNull final ActivatableGUIElement

prev

)

Sets the previous activatable GUI element in the same dialog.

Parameters

prev	the element

Definition at line 162 of file ActivatableGUIElement.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.prev.

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

Here is the caller graph for this function:

Member Data Documentation

elementListener

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

private

The GUIElementListener to notify.

Definition at line 44 of file ActivatableGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.button.AbstractButton.AbstractButton(), com.realtime.crossfire.jxclient.gui.button.AbstractButton2.AbstractButton2(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.ActivatableGUIElement(), com.realtime.crossfire.jxclient.gui.button.GUIButton.GUIButton(), com.realtime.crossfire.jxclient.gui.list.GUICharacter.GUICharacter(), com.realtime.crossfire.jxclient.gui.misc.GUICheckBox.GUICheckBox(), com.realtime.crossfire.jxclient.gui.textinput.GUICommandText.GUICommandText(), com.realtime.crossfire.jxclient.gui.item.GUIItem.GUIItem(), com.realtime.crossfire.jxclient.gui.item.GUIItemFloor.GUIItemFloor(), com.realtime.crossfire.jxclient.gui.item.GUIItemInventory.GUIItemInventory(), com.realtime.crossfire.jxclient.gui.item.GUIItemItem.GUIItemItem(), com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledge.GUIItemKnowledge(), com.realtime.crossfire.jxclient.gui.item.GUIItemKnowledgeType.GUIItemKnowledgeType(), com.realtime.crossfire.jxclient.gui.item.GUIItemQuest.GUIItemQuest(), com.realtime.crossfire.jxclient.gui.item.GUIItemShortcut.GUIItemShortcut(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.GUIItemSpell(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpellSkill.GUIItemSpellSkill(), com.realtime.crossfire.jxclient.gui.list.GUIList< GUICharacter >.GUIList(), com.realtime.crossfire.jxclient.gui.list.GUIMetaElement.GUIMetaElement(), com.realtime.crossfire.jxclient.gui.textinput.GUIQueryText.GUIQueryText(), com.realtime.crossfire.jxclient.gui.misc.GUIScrollBar.GUIScrollBar(), com.realtime.crossfire.jxclient.gui.button.GUISelectableButton.GUISelectableButton(), com.realtime.crossfire.jxclient.gui.misc.GUISpinner.GUISpinner(), com.realtime.crossfire.jxclient.gui.textinput.GUIText.GUIText(), com.realtime.crossfire.jxclient.gui.button.GUITextButton.GUITextButton(), com.realtime.crossfire.jxclient.gui.textinput.GUITextField.GUITextField(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.isActive(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

next

ActivatableGUIElement com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.next = this

private

The next activatable GUI element in the same dialog.

Definition at line 57 of file ActivatableGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activateNextElement(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setNextActive().

pendingInactive

boolean com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.pendingInactive

private

Set if the next call to setInactiveIfPending() will deactivate this GUI element. It is set by calling markInactivePending() and reset by calling setActive(boolean).

Definition at line 51 of file ActivatableGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.markInactivePending(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setInactiveIfPending().

prev

ActivatableGUIElement com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.prev = this

private

The previous activatable GUI element in the same dialog.

Definition at line 63 of file ActivatableGUIElement.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activatePrevElement(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setPrevActive().

serialVersionUID

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

staticprivate

The serial version UID.

Definition at line 38 of file ActivatableGUIElement.java.

---

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

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