com.realtime.crossfire.jxclient.gui.item

Class GUIItemSpell

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

com.realtime.crossfire.jxclient.gui.item.GUIItem

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

com.realtime.crossfire.jxclient.gui.item.GUIItemSpell

All Implemented Interfaces:

GUIElement, GUIScrollable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class GUIItemSpell
extends GUIItemItem

A GUIItemItem that represents an entry in a GUISpellList.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
GUIItemSpell(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull CommandQueue commandQueue, @NotNull java.lang.String name, @NotNull ItemPainter itemPainter, int defaultIndex, @NotNull FacesManager facesManager, @NotNull SpellsManager spellsManager, @NotNull ItemView spellsView, int size, @NotNull GuiFactory guiFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	button1Clicked(int modifiers) Called when the left mouse button was pressed.
void	button2Clicked(int modifiers) Called when the middle mouse button was pressed.
void	button3Clicked(int modifiers) Called when the right mouse button was pressed.
boolean	canScroll(int distance) Returns whether scrolling is possible.
void	dispose() Releases all allocated resources.
protected @NotNull java.awt.Image	getFace(@NotNull CfItem item) Returns the face for a CfItem instance.
int	getIndex() Returns the slot index.
@NotNull java.awt.Dimension	getMinimumSize()
@NotNull java.awt.Dimension	getPreferredSize()
protected boolean	isSelected() Returns whether this element should be drawn as "selected".
void	notifyOpen() Called each time the enclosing dialog is opened (or raised).
void	resetScroll() Resets the scroll index to the default value.
void	scroll(int distance) Scrolls the element.
void	setIndexNoListeners(int index) Sets the slot index to display without registering listeners for updates.
void	setSelected(boolean selected) Sets the selected state.

Methods inherited from class com.realtime.crossfire.jxclient.gui.item.GUIItemItem

getItem, getTooltip, paintComponent, setItem, setItemNoListeners

Methods inherited from class com.realtime.crossfire.jxclient.gui.item.GUIItem

activeChanged, execute, mouseClicked, setVisible

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement

activateNextElement, activatePrevElement, isActive, markInactivePending, mousePressed, setActive, setInactiveIfPending, setNextActive, setPrevActive

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, inhibitListeners, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mouseReleased, mouseWheelMoved, newTooltipText, setChanged, setChangedListener, setDefault, setIgnore, tooltipChanged, toString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GUIItemSpell

public GUIItemSpell(@NotNull
                    @NotNull TooltipManager tooltipManager,
                    @NotNull
                    @NotNull GUIElementListener elementListener,
                    @NotNull
                    @NotNull CommandQueue commandQueue,
                    @NotNull
                    @NotNull java.lang.String name,
                    @NotNull
                    @NotNull ItemPainter itemPainter,
                    int defaultIndex,
                    @NotNull
                    @NotNull FacesManager facesManager,
                    @NotNull
                    @NotNull SpellsManager spellsManager,
                    @NotNull
                    @NotNull ItemView spellsView,
                    int size,
                    @NotNull
                    @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

commandQueue - the command queue for sending commands

name - the name of this element

itemPainter - the item painter for painting the icon

defaultIndex - the default scroll index

facesManager - the faces manager for looking up faces

spellsManager - the spells manager instance to watch

spellsView - the spells view to use

size - the size of the component or 0 for undefined

guiFactory - the global GUI factory instance

Method Detail

dispose

public void dispose()

Description copied from interface: GUIElement

Releases all allocated resources.

Specified by:

dispose in interface GUIElement

Overrides:

dispose in class GUIItemItem

notifyOpen

public void notifyOpen()

Description copied from interface: GUIElement

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

canScroll

public boolean canScroll(int distance)

Description copied from interface: GUIScrollable

Returns whether scrolling is possible.

Parameters:

distance - the distance to scroll

Returns:

whether scrolling is possible

scroll

public void scroll(int distance)

Description copied from interface: GUIScrollable

Scrolls the element.

Parameters:

distance - the distance to scroll

resetScroll

public void resetScroll()

Description copied from interface: GUIScrollable

Resets the scroll index to the default value.

button1Clicked

public void button1Clicked(int modifiers)

Description copied from class: GUIItem

Called when the left mouse button was pressed.

Specified by:

button1Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

button2Clicked

public void button2Clicked(int modifiers)

Description copied from class: GUIItem

Called when the middle mouse button was pressed.

Specified by:

button2Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

button3Clicked

public void button3Clicked(int modifiers)

Description copied from class: GUIItem

Called when the right mouse button was pressed.

Specified by:

button3Clicked in class GUIItem

Parameters:

modifiers - the input event modifiers

getPreferredSize

@NotNull
public @NotNull java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class GUIItemItem

getMinimumSize

@NotNull
public @NotNull java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class GUIItemItem

getFace

@NotNull
protected @NotNull java.awt.Image getFace(@NotNull
                                                   @NotNull CfItem item)

Description copied from class: GUIItemItem

Returns the face for a CfItem instance.

Specified by:

getFace in class GUIItemItem

Parameters:

item - the item instance

Returns:

the face

setSelected

public void setSelected(boolean selected)

Description copied from class: GUIItemItem

Sets the selected state.

Specified by:

setSelected in class GUIItemItem

Parameters:

selected - whether this element should be drawn as "selected"

isSelected

protected boolean isSelected()

Description copied from class: GUIItemItem

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

Specified by:

isSelected in class GUIItemItem

Returns:

whether this element is selected

getIndex

public int getIndex()

Description copied from class: GUIItemItem

Returns the slot index.

Specified by:

getIndex in class GUIItemItem

Returns:

the slot index

setIndexNoListeners

public void setIndexNoListeners(int index)

Description copied from class: GUIItemItem

Sets the slot index to display without registering listeners for updates.

Specified by:

setIndexNoListeners in class GUIItemItem

Parameters:

index - the slot index