Crossfire JXClient, Trunk
Public Member Functions | Protected Member Functions | Static Private Attributes | List of all members
com.realtime.crossfire.jxclient.gui.item.GUIItem Class Referenceabstract
Inheritance diagram for com.realtime.crossfire.jxclient.gui.item.GUIItem:
Inheritance graph
Collaboration diagram for com.realtime.crossfire.jxclient.gui.item.GUIItem:
Collaboration graph

Public Member Functions

void activeChanged ()
 
abstract void button1Clicked (final int modifiers)
 
abstract void button2Clicked (final int modifiers)
 
abstract void button3Clicked (final int modifiers)
 
void execute ()
 
void mouseClicked (@NotNull final MouseEvent e)
 
void setVisible (final boolean aFlag)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
void activateNextElement ()
 
void activatePrevElement ()
 
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 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 ()
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable
boolean canScroll (int distance)
 
void resetScroll ()
 
void scroll (int distance)
 

Protected Member Functions

 GUIItem (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final GuiFactory guiFactory)
 
- 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 boolean opaque, @NotNull final GuiFactory guiFactory)
 
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 ()
 

Static Private Attributes

static final long serialVersionUID = 1
 

Detailed Description

A GUIElement representing an in-game object.

Author
Lauwenmark
Andreas Kirschbaum

Definition at line 39 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,
@NotNull final GuiFactory  guiFactory 
)
protected

Creates a new instance.

Parameters
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
namethe name of this element
guiFactorythe global GUI factory instance

Definition at line 53 of file GUIItem.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

◆ activeChanged()

void com.realtime.crossfire.jxclient.gui.item.GUIItem.activeChanged ( )

Will be called whenever the active state has changed.

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

Definition at line 105 of file GUIItem.java.

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

Here is the call graph for this function:

◆ button1Clicked()

abstract void com.realtime.crossfire.jxclient.gui.item.GUIItem.button1Clicked ( final int  modifiers)
abstract

◆ button2Clicked()

abstract void com.realtime.crossfire.jxclient.gui.item.GUIItem.button2Clicked ( final int  modifiers)
abstract

◆ button3Clicked()

abstract void com.realtime.crossfire.jxclient.gui.item.GUIItem.button3Clicked ( final int  modifiers)
abstract

◆ execute()

void com.realtime.crossfire.jxclient.gui.item.GUIItem.execute ( )

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

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

Definition at line 82 of file GUIItem.java.

◆ mouseClicked()

void com.realtime.crossfire.jxclient.gui.item.GUIItem.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
ethe mouse event relative to this element

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

Definition at line 58 of file GUIItem.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItem.button1Clicked(), com.realtime.crossfire.jxclient.gui.item.GUIItem.button2Clicked(), com.realtime.crossfire.jxclient.gui.item.GUIItem.button3Clicked(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Here is the call graph for this function:

◆ setVisible()

void com.realtime.crossfire.jxclient.gui.item.GUIItem.setVisible ( final boolean  aFlag)

Definition at line 110 of file GUIItem.java.

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

Here is the call graph for this function:

Member Data Documentation

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.item.GUIItem.serialVersionUID = 1
staticprivate

The serial version UID.

Definition at line 44 of file GUIItem.java.


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