com.realtime.crossfire.jxclient.gui.list

Class GUIItemList<T extends GUIItemItem>

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.list.GUIList<T>

com.realtime.crossfire.jxclient.gui.list.GUIItemList<T>

Type Parameters:

T - the type of the list elements

All Implemented Interfaces:

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

Direct Known Subclasses:

GUIFloorList, GUIInventoryList, GUIKnowledgeList, GUIKnowledgeTypeList, GUIQuestList, GUISpellList, GUISpellSkillList

public abstract class GUIItemList<T extends GUIItemItem>
extends GUIList<T>

A GUIList instance that displays GUIItemItem instances.

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

Modifier	Constructor and Description
protected	GUIItemList(@NotNull TooltipManager tooltipManager, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, int cellWidth, int cellHeight, @NotNull ItemView itemView, @Nullable AbstractLabel currentItem, @NotNull GUIItemItem templateItem, @NotNull GuiFactory guiFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	activeChanged() Will be called whenever the active state has changed.
void	dispose() Releases all allocated resources.
@Nullable GUIItemItem	getSelectedItem() Returns the selected GUIItemItem instance.
void	mouseClicked(@NotNull java.awt.event.MouseEvent e) Will be called when the user has clicked (pressed+released) this element.
protected abstract T	newItem(int index) Creates a new GUIElement instance.
protected void	selectionChanged(int selectedIndex) Called whenever the selected list entry has changed.

Methods inherited from class com.realtime.crossfire.jxclient.gui.list.GUIList

addElement, canMoveSelection, canScroll, execute, getElement, getMaximumSize, getMinimumSize, getPreferredSize, getSelectedObject, getTooltip, getTooltip, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseWheelMoved, moveSelection, resetScroll, resizeElements, scroll, selectionChanged, setBounds, setChanged, setLayoutOrientation, setSelectedIndex

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

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

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

getDialogBorderBottom, getDialogBorderLeft, getDialogBorderRight, getDialogBorderTop, getName, inhibitListeners, isDefault, isIgnore, mouseReleased, newTooltipText, 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, 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, paintComponent, 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, setVisible, 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, 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

Methods inherited from interface com.realtime.crossfire.jxclient.gui.gui.GUIElement

notifyOpen

Constructor Detail

GUIItemList

protected GUIItemList(@NotNull
                      @NotNull TooltipManager tooltipManager,
                      @NotNull
                      @NotNull GUIElementListener elementListener,
                      @NotNull
                      @NotNull java.lang.String name,
                      int cellWidth,
                      int cellHeight,
                      @NotNull
                      @NotNull ItemView itemView,
                      @Nullable
                      @Nullable AbstractLabel currentItem,
                      @NotNull
                      @NotNull GUIItemItem templateItem,
                      @NotNull
                      @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

cellWidth - the width of cells

cellHeight - the height of cells

itemView - the item view to monitor

currentItem - the label to update with information about the selected item.

templateItem - the template item for painting the list

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 GUIList<T extends GUIItemItem>

selectionChanged

protected void selectionChanged(int selectedIndex)

Description copied from class: GUIList

Called whenever the selected list entry has changed.

Specified by:

selectionChanged in class GUIList<T extends GUIItemItem>

Parameters:

selectedIndex - the selected list entry

activeChanged

protected void activeChanged()

Description copied from class: ActivatableGUIElement

Will be called whenever the active state has changed.

Specified by:

activeChanged in class ActivatableGUIElement

mouseClicked

public void mouseClicked(@NotNull
                         @NotNull java.awt.event.MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has clicked (pressed+released) this element. This event will be delivered after GUIElement.mouseReleased(MouseEvent).

Specified by:

mouseClicked in interface GUIElement

Overrides:

mouseClicked in class GUIList<T extends GUIItemItem>

Parameters:

e - the mouse event relative to this element

getSelectedItem

@Nullable
public @Nullable GUIItemItem getSelectedItem()

Returns the selected GUIItemItem instance.

Returns:

the selected instance or null if none is selected

newItem

@NotNull
protected abstract T newItem(int index)

Creates a new GUIElement instance.

Parameters:

index - the item inventory's index

Returns:

the new instance