Crossfire JXClient, Trunk
com.realtime.crossfire.jxclient.gui.list.GUISpellList Class Reference

A GUIList to display spells. More...

+ Inheritance diagram for com.realtime.crossfire.jxclient.gui.list.GUISpellList:
+ Collaboration diagram for com.realtime.crossfire.jxclient.gui.list.GUISpellList:

Public Member Functions

 GUISpellList (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int cellWidth, final int cellHeight, @NotNull final ItemView itemView, @Nullable final AbstractLabel currentItem, @NotNull final SpellsManager spellsManager, @NotNull final KeybindingsManager keybindingsManager, @NotNull final CommandQueue commandQueue, @NotNull final ItemPainter itemPainter, @NotNull final FacesManager facesManager, @NotNull final GuiFactory guiFactory)
 Creates a new instance. More...
 
void notifyOpen ()
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.list.GUIItemList< GUIItemSpell >
void dispose ()
 
GUIItemItem getSelectedItem ()
 Returns the selected GUIItemItem instance. More...
 
void mouseClicked ( @NotNull final MouseEvent e)
 

Protected Member Functions

String getTooltip (final int index)
 
GUIItemSpell newItem (final int index)
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.list.GUIItemList< GUIItemSpell >
void activeChanged ()
 
 GUIItemList ( @NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final int cellWidth, final int cellHeight, @NotNull final ItemView itemView, @Nullable final AbstractLabel currentItem, @NotNull final GUIItemItem templateItem, @NotNull final GuiFactory guiFactory)
 Creates a new instance. More...
 
abstract T newItem (final int index)
 Creates a new GUIElement instance. More...
 
void selectionChanged (final int selectedIndex)
 

Private Member Functions

String getBindings (@NotNull final Spell spell, @NotNull final String prefix, @NotNull final String legend)
 Return a text with the keybindings for the spell. More...
 

Private Attributes

final CommandQueue commandQueue
 The CommandQueue for sending commands. More...
 
final GUIElementListener elementListener
 The GUIElementListener to notify. More...
 
final FacesManager facesManager
 The FacesManager to use. More...
 
final GuiFactory guiFactory
 The global GuiFactory instance. More...
 
final ItemPainter itemPainter
 The ItemPainter for painting the icon. More...
 
final ItemView itemView
 The ItemView to use. More...
 
final KeybindingsManager keybindingsManager
 The keybinding for displaying shortcuts. More...
 
final String name
 The base name for created elements. More...
 
final SpellsManager spellsManager
 The spells to display. More...
 
final TooltipManager tooltipManager
 The TooltipManager to update. More...
 

Static Private Attributes

static final long serialVersionUID = 1L
 The serial version UID. More...
 

Detailed Description

A GUIList to display spells.

Author
Nicolas Weeger

Definition at line 45 of file GUISpellList.java.

Constructor & Destructor Documentation

◆ GUISpellList()

com.realtime.crossfire.jxclient.gui.list.GUISpellList.GUISpellList ( @NotNull final TooltipManager  tooltipManager,
@NotNull final GUIElementListener  elementListener,
@NotNull final String  name,
final int  cellWidth,
final int  cellHeight,
@NotNull final ItemView  itemView,
@Nullable final AbstractLabel  currentItem,
@NotNull final SpellsManager  spellsManager,
@NotNull final KeybindingsManager  keybindingsManager,
@NotNull final CommandQueue  commandQueue,
@NotNull final ItemPainter  itemPainter,
@NotNull final FacesManager  facesManager,
@NotNull final GuiFactory  guiFactory 
)

Creates a new instance.

Parameters
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
namethe name of this element
cellWidththe width of cells
cellHeightthe height of cells
itemViewthe item view to monitor
currentItemthe label to update with information about the selected item.
spellsManagerthe spells to display
keybindingsManagerthe bindings for displaying shortcuts
commandQueuethe command queue for sending commands
itemPainterthe item painter for painting the icon
facesManagerthe faces manager to use
guiFactorythe global GUI factory instance

Definition at line 129 of file GUISpellList.java.

References com.realtime.crossfire.jxclient.gui.list.GUISpellList.commandQueue, com.realtime.crossfire.jxclient.gui.list.GUIItemList< GUIItemSpell >.currentItem, com.realtime.crossfire.jxclient.gui.list.GUISpellList.elementListener, com.realtime.crossfire.jxclient.gui.list.GUISpellList.facesManager, com.realtime.crossfire.jxclient.gui.list.GUISpellList.guiFactory, com.realtime.crossfire.jxclient.gui.list.GUISpellList.itemPainter, com.realtime.crossfire.jxclient.gui.list.GUISpellList.itemView, com.realtime.crossfire.jxclient.gui.list.GUISpellList.keybindingsManager, com.realtime.crossfire.jxclient.gui.list.GUISpellList.name, com.realtime.crossfire.jxclient.gui.list.GUISpellList.spellsManager, and com.realtime.crossfire.jxclient.gui.list.GUISpellList.tooltipManager.

Member Function Documentation

◆ getBindings()

String com.realtime.crossfire.jxclient.gui.list.GUISpellList.getBindings ( @NotNull final Spell  spell,
@NotNull final String  prefix,
@NotNull final String  legend 
)
private

Return a text with the keybindings for the spell.

Parameters
spellwhat to search bindings for
prefixinvocation prefix, "cast " or "invoke ", to search for
legendthe text before the binding(s)
Returns
empty string if no matching bindings, else text in the form "legend (binding 1) ; (binding 2) ; ..."

Definition at line 152 of file GUISpellList.java.

References com.realtime.crossfire.jxclient.gui.keybindings.KeybindingsManager.getBindings(), and com.realtime.crossfire.jxclient.gui.list.GUISpellList.keybindingsManager.

Referenced by com.realtime.crossfire.jxclient.gui.list.GUISpellList.getTooltip().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getTooltip()

String com.realtime.crossfire.jxclient.gui.list.GUISpellList.getTooltip ( final int  index)
protected

◆ newItem()

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.list.GUISpellList.notifyOpen ( )

Definition at line 204 of file GUISpellList.java.

Member Data Documentation

◆ commandQueue

final CommandQueue com.realtime.crossfire.jxclient.gui.list.GUISpellList.commandQueue
private

◆ elementListener

final GUIElementListener com.realtime.crossfire.jxclient.gui.list.GUISpellList.elementListener
private

◆ facesManager

final FacesManager com.realtime.crossfire.jxclient.gui.list.GUISpellList.facesManager
private

◆ guiFactory

final GuiFactory com.realtime.crossfire.jxclient.gui.list.GUISpellList.guiFactory
private

◆ itemPainter

final ItemPainter com.realtime.crossfire.jxclient.gui.list.GUISpellList.itemPainter
private

◆ itemView

final ItemView com.realtime.crossfire.jxclient.gui.list.GUISpellList.itemView
private

◆ keybindingsManager

final KeybindingsManager com.realtime.crossfire.jxclient.gui.list.GUISpellList.keybindingsManager
private

◆ name

final String com.realtime.crossfire.jxclient.gui.list.GUISpellList.name
private

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.list.GUISpellList.serialVersionUID = 1L
staticprivate

The serial version UID.

Definition at line 50 of file GUISpellList.java.

◆ spellsManager

final SpellsManager com.realtime.crossfire.jxclient.gui.list.GUISpellList.spellsManager
private

◆ tooltipManager

final TooltipManager com.realtime.crossfire.jxclient.gui.list.GUISpellList.tooltipManager
private

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