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

Public Member Functions

void button1Clicked (final int modifiers)
 
void button2Clicked (final int modifiers)
 
void button3Clicked (final int modifiers)
 
boolean canScroll (final int distance)
 
void dispose ()
 
int getIndex ()
 
Dimension getMinimumSize ()
 
Dimension getPreferredSize ()
 
 GUIItemSpell (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final CommandQueue commandQueue, @NotNull final String name, @NotNull final ItemPainter itemPainter, final int defaultIndex, @NotNull final FacesManager facesManager, @NotNull final SpellsManager spellsManager, @NotNull final ItemView spellsView, final int size, @NotNull final GuiFactory guiFactory)
 
void notifyOpen ()
 
void resetScroll ()
 
void scroll (final int distance)
 
void setIndexNoListeners (final int index)
 
void setSelected (final boolean selected)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.item.GUIItemItem
CfItem getItem ()
 
TooltipText getTooltip ()
 
void paintComponent (@NotNull final Graphics g)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.item.GUIItem
void activeChanged ()
 
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
int getDialogBorderBottom ()
 
int getDialogBorderLeft ()
 
int getDialogBorderRight ()
 
int getDialogBorderTop ()
 
String getName ()
 
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 ()
 

Protected Member Functions

Image getFace (@NotNull final CfItem item)
 
boolean isSelected ()
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.item.GUIItemItem
 GUIItemItem (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final ItemPainter itemPainter, @NotNull final FacesManager facesManager, @NotNull final GuiFactory guiFactory)
 
void setItem (@Nullable final CfItem item)
 
void setItemNoListeners (@Nullable final CfItem item)
 
- Protected Member Functions inherited from 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 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 ()
 

Private Member Functions

void setIndex (final int index)
 
void setSpell ()
 

Static Private Member Functions

static Dimension getMinimumSizeInt ()
 

Private Attributes

final CommandQueue commandQueue
 
final int defaultIndex
 
final FacesManager facesManager
 
final FacesManagerListener facesManagerListener
 
int index = -1
 
boolean selected
 
Spell spell
 
final SpellListener spellListener = this::setSpell
 
final SpellsManager spellsManager
 
final SpellsManagerListener spellsManagerListener
 
final ItemView spellsView
 
final Object sync = new Object()
 

Static Private Attributes

static final long serialVersionUID = 1
 

Detailed Description

A GUIItemItem that represents an entry in a GUISpellList.

Author
Andreas Kirschbaum

Definition at line 49 of file GUIItemSpell.java.

Constructor & Destructor Documentation

◆ GUIItemSpell()

com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.GUIItemSpell ( @NotNull final TooltipManager  tooltipManager,
@NotNull final GUIElementListener  elementListener,
@NotNull final CommandQueue  commandQueue,
@NotNull final String  name,
@NotNull final ItemPainter  itemPainter,
final int  defaultIndex,
@NotNull final FacesManager  facesManager,
@NotNull final SpellsManager  spellsManager,
@NotNull final ItemView  spellsView,
final int  size,
@NotNull final GuiFactory  guiFactory 
)

Creates a new instance.

Parameters
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
commandQueuethe command queue for sending commands
namethe name of this element
itemPainterthe item painter for painting the icon
defaultIndexthe default scroll index
facesManagerthe faces manager for looking up faces
spellsManagerthe spells manager instance to watch
spellsViewthe spells view to use
sizethe size of the component or
0
for undefined
guiFactorythe global GUI factory instance

Definition at line 174 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.commandQueue, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.defaultIndex, com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.facesManager, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.facesManagerListener, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.item.GUIItemItem.itemPainter, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setIndex(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsManager, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsManagerListener, com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsView, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Here is the call graph for this function:

Member Function Documentation

◆ button1Clicked()

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

◆ button2Clicked()

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

◆ button3Clicked()

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

◆ canScroll()

boolean com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.canScroll ( final int  distance)

◆ dispose()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.dispose ( )

◆ getFace()

Image com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getFace ( @NotNull final CfItem  item)
protected

◆ getIndex()

int com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getIndex ( )

◆ getMinimumSize()

Dimension com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getMinimumSize ( )

Reimplemented from com.realtime.crossfire.jxclient.gui.item.GUIItemItem.

Definition at line 288 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getMinimumSizeInt().

Here is the call graph for this function:

◆ getMinimumSizeInt()

static Dimension com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getMinimumSizeInt ( )
staticprivate

Returns the minimal size to display this component.

Returns
the minimal size

Definition at line 297 of file GUIItemSpell.java.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getMinimumSize(), and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getPreferredSize().

Here is the caller graph for this function:

◆ getPreferredSize()

Dimension com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getPreferredSize ( )

Reimplemented from com.realtime.crossfire.jxclient.gui.item.GUIItemItem.

Definition at line 281 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.getMinimumSizeInt().

Here is the call graph for this function:

◆ isSelected()

boolean com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.isSelected ( )
protected

Returns whether this element should be drawn as "selected".

Returns
whether this element is selected

Reimplemented from com.realtime.crossfire.jxclient.gui.item.GUIItemItem.

Definition at line 362 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.isActive(), and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.selected.

Here is the call graph for this function:

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.notifyOpen ( )

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

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

Definition at line 200 of file GUIItemSpell.java.

◆ resetScroll()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.resetScroll ( )

Resets the scroll index to the default value.

Implements com.realtime.crossfire.jxclient.gui.scrollable.GUIScrollable.

Definition at line 229 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.defaultIndex, and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setIndex().

Here is the call graph for this function:

◆ scroll()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.scroll ( final int  distance)

◆ setIndex()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setIndex ( final int  index)
private

◆ setIndexNoListeners()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setIndexNoListeners ( final int  index)

◆ setSelected()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSelected ( final boolean  selected)

Sets the selected state.

Parameters
selectedwhether this element should be drawn as "selected"

Reimplemented from com.realtime.crossfire.jxclient.gui.item.GUIItemItem.

Definition at line 352 of file GUIItemSpell.java.

References com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.selected, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

Here is the call graph for this function:

◆ setSpell()

void com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSpell ( )
private

Member Data Documentation

◆ commandQueue

final CommandQueue com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.commandQueue
private

◆ defaultIndex

final int com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.defaultIndex
private

◆ facesManager

final FacesManager com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.facesManager
private

◆ facesManagerListener

final FacesManagerListener com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.facesManagerListener
private
Initial value:
= new FacesManagerListener() {
@Override
public void faceUpdated(@NotNull final Face face) {
if (spell != null && spell.getFaceNum() == face.getFaceNum()) {
}
}
}

The FacesManagerListener registered to detect updated faces.

Definition at line 149 of file GUIItemSpell.java.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.dispose(), and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.GUIItemSpell().

◆ index

int com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.index = -1
private

◆ selected

boolean com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.selected
private

◆ serialVersionUID

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

The serial version UID.

Definition at line 54 of file GUIItemSpell.java.

◆ spell

Spell com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spell
private

◆ spellListener

final SpellListener com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellListener = this::setSpell
private

◆ spellsManager

final SpellsManager com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsManager
private

◆ spellsManagerListener

final SpellsManagerListener com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsManagerListener
private
Initial value:
= new SpellsManagerListener() {
@Override
public void spellAdded(final int index) {
synchronized (sync) {
if (GUIItemSpell.this.index < index) {
return;
}
}
}
@Override
public void spellRemoved(final int index) {
synchronized (sync) {
if (GUIItemSpell.this.index < index) {
return;
}
}
}
}

The SpellsManagerListener used to detect spell changes.

Definition at line 113 of file GUIItemSpell.java.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.dispose(), and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.GUIItemSpell().

◆ spellsView

final ItemView com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spellsView
private

◆ sync

final Object com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.sync = new Object()
private

The documentation for this class was generated from the following file:
com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSpell
void setSpell()
Definition: GUIItemSpell.java:305
com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.GUIItemSpell
GUIItemSpell(@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final CommandQueue commandQueue, @NotNull final String name, @NotNull final ItemPainter itemPainter, final int defaultIndex, @NotNull final FacesManager facesManager, @NotNull final SpellsManager spellsManager, @NotNull final ItemView spellsView, final int size, @NotNull final GuiFactory guiFactory)
Definition: GUIItemSpell.java:174
com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.spell
Spell spell
Definition: GUIItemSpell.java:90
com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.index
int index
Definition: GUIItemSpell.java:96
com.realtime.crossfire.jxclient.spells.Spell.getFaceNum
int getFaceNum()
Definition: Spell.java:215
com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.sync
final Object sync
Definition: GUIItemSpell.java:60
com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged
void setChanged()
Definition: AbstractGUIElement.java:223