com.realtime.crossfire.jxclient.gui.list

Class GUIList<T extends GUIElement>

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>

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:

GUICharacterList, GUIItemList, GUIMetaElementList

public abstract class GUIList<T extends GUIElement>
extends ActivatableGUIElement
implements GUIScrollable

A GUIElement that displays a list of entries.

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

Modifier and Type	Field and Description
private int	cellHeight The height of a list cell in pixels.
private CommandList	doubleClickCommandList The CommandList to execute on double-clicks or null to ignore double-clicks.
private javax.swing.JList<T>	list The list used to display the cells.
private GUIListCellRenderer<? extends T>	listCellRenderer The GUIListCellRenderer for the list.
private javax.swing.event.ListSelectionListener	listSelectionListener The ListSelectionListener attached to list.
private javax.swing.DefaultListModel<T>	model The list model of list.
private javax.swing.JScrollPane	scrollPane The scroll pane instance used to display the list.
private static long	serialVersionUID The serial version UID.
private int	tooltipIndex The index of the currently shown tooltip.
private java.awt.Rectangle	tooltipRectangle The location of the tooltip.
private GUIListViewport	viewport The viewport used by scrollPane.

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	GUIList(TooltipManager tooltipManager, GUIElementListener elementListener, java.lang.String name, int cellWidth, int cellHeight, GUIListCellRenderer<T> listCellRenderer, CommandList doubleClickCommandList) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	addElement(T element) Adds an GUIElement to the list.
boolean	canMoveSelection(int diffLines, int diffElements) Returns whether the selection can be moved.
boolean	canScroll(int distance) Returns whether the list can be scrolled.
void	dispose() Releases all allocated resources.
private void	doSelect(java.awt.event.MouseEvent e) Selects the list entry corresponding to a MouseEvent instance.
private void	doTooltip(java.awt.event.MouseEvent e) Updates the tooltip text corresponding to a MouseEvent instance.
void	execute() Executes the actions associated with this GUI element.
T	getElement(int index) Returns the GUIElement for a given index.
java.awt.Dimension	getMinimumSize()
java.awt.Dimension	getPreferredSize()
protected java.lang.Object	getSelectedObject() Returns the selected list object.
void	mouseClicked(java.awt.event.MouseEvent e) Will be called when the user has clicked (pressed+released) this element.
void	mouseDragged(java.awt.event.MouseEvent e) Will be called when the mouse moves within this component while the button is pressed.
void	mouseEntered(java.awt.event.MouseEvent e, boolean debugGui) Will be called when the mouse has entered the bounding box of this element.
void	mouseExited(java.awt.event.MouseEvent e) Will be called when the mouse has left the bounding box of this element.
void	mouseMoved(java.awt.event.MouseEvent e) Will be called when the mouse moves within this component.
void	mousePressed(java.awt.event.MouseEvent e) Will be called when the user has pressed the mouse inside this element.
void	moveSelection(int diffLines, int diffElements) Moves the selection.
void	resetScroll() Resets the scroll index to the default value.
protected int	resizeElements(int newSize) Changes the number of list elements.
void	scroll(int distance) Moves the list.
protected void	selectionChanged() Called whenever the selected list entry has changed.
protected abstract void	selectionChanged(int selectedIndex) Called whenever the selected list entry has changed.
void	setBounds(int x, int y, int width, int height)
void	setChanged() Records that the contents have changed and must be repainted.
protected void	setLayoutOrientation(int layoutOrientation, int visibleRowCount) Sets the layout orientation.
protected void	setSelectedIndex(int newIndex) Update the selected list entry.
private void	updateTooltip() Updates the current tooltip text.
protected abstract void	updateTooltip(int index, int x, int y, int w, int h) Updates the tooltip text.

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

activeChanged, isActive, markInactivePending, setActive, setInactiveIfPending

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

getName, hasTooltipText, isDefault, isIgnore, mouseReleased, setChangedListener, setDefault, setIgnore, setTooltipText, setTooltipText, 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, 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

Field Detail

cellHeight

private final int cellHeight

The height of a list cell in pixels.

doubleClickCommandList

@Nullable
private final CommandList doubleClickCommandList

The CommandList to execute on double-clicks or null to ignore double-clicks.

list

@NotNull
private final javax.swing.JList<T extends GUIElement> list

The list used to display the cells.

listCellRenderer

@NotNull
private final GUIListCellRenderer<? extends T extends GUIElement> listCellRenderer

The GUIListCellRenderer for the list.

listSelectionListener

@NotNull
private final javax.swing.event.ListSelectionListener listSelectionListener

The ListSelectionListener attached to list.

model

@NotNull
private final javax.swing.DefaultListModel<T extends GUIElement> model

The list model of list.

scrollPane

@NotNull
private final javax.swing.JScrollPane scrollPane

The scroll pane instance used to display the list.

serialVersionUID

private static final long serialVersionUID

The serial version UID.

See Also:

Constant Field Values

tooltipIndex

private int tooltipIndex

The index of the currently shown tooltip. Set to -1 if no tooltip is shown.

tooltipRectangle

@Nullable
private java.awt.Rectangle tooltipRectangle

The location of the tooltip. Set to null if no tooltip is shown.

viewport

@NotNull
private final GUIListViewport viewport

The viewport used by scrollPane.

Constructor Detail

GUIList

protected GUIList(@NotNull
                  TooltipManager tooltipManager,
                  @NotNull
                  GUIElementListener elementListener,
                  @NotNull
                  java.lang.String name,
                  int cellWidth,
                  int cellHeight,
                  @NotNull
                  GUIListCellRenderer<T> listCellRenderer,
                  @Nullable
                  CommandList doubleClickCommandList)

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 each cell

cellHeight - the height of each cell

listCellRenderer - the renderer for the list

doubleClickCommandList - the command list to execute on double-click or null to ignore double-clicks

Method Detail

addElement

protected void addElement(@NotNull
                          T element)

Adds an GUIElement to the list.

Parameters:

element - the element to add

canMoveSelection

public boolean canMoveSelection(int diffLines,
                                int diffElements)

Returns whether the selection can be moved.

Parameters:

diffLines - the distance in lines to move

diffElements - the distance in elements to move

Returns:

whether moving is possible

canScroll

public boolean canScroll(int distance)

Returns whether the list can be scrolled.

Specified by:

canScroll in interface GUIScrollable

Parameters:

distance - the distance to scroll

Returns:

whether scrolling is possible

dispose

public void dispose()

Releases all allocated resources.

Specified by:

dispose in interface GUIElement

Overrides:

dispose in class AbstractGUIElement

doSelect

private void doSelect(@NotNull
                      java.awt.event.MouseEvent e)

Selects the list entry corresponding to a MouseEvent instance.

Parameters:

e - the mouse event instance

doTooltip

private void doTooltip(@NotNull
                       java.awt.event.MouseEvent e)

Updates the tooltip text corresponding to a MouseEvent instance.

Parameters:

e - the mouse event instance

execute

public void execute()

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

Specified by:

execute in class ActivatableGUIElement

getElement

@NotNull
public T getElement(int index)

Returns the GUIElement for a given index.

Parameters:

index - the index

Returns:

the gui element

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getSelectedObject

@NotNull
protected java.lang.Object getSelectedObject()

Returns the selected list object.

Returns:

the selected object or null if none is selected

mouseClicked

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

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 AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseDragged

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

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after GUIElement.mouseMoved(MouseEvent).

Note: if the mouse leaves this element's bounding box while the mouse button is still pressed, further mouseDragged (but no mouseMoved) events will be generated.

Specified by:

mouseDragged in interface GUIElement

Overrides:

mouseDragged in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseEntered

public void mouseEntered(@NotNull
                         java.awt.event.MouseEvent e,
                         boolean debugGui)

Will be called when the mouse has entered the bounding box of this element.

Specified by:

mouseEntered in interface GUIElement

Overrides:

mouseEntered in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

debugGui - whether --debug-gui is active

mouseExited

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

Will be called when the mouse has left the bounding box of this element. This function will not be called unless GUIElement.mouseEntered(MouseEvent, boolean) has been called before.

Specified by:

mouseExited in interface GUIElement

Overrides:

mouseExited in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseMoved

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

Will be called when the mouse moves within this component. before.

Specified by:

mouseMoved in interface GUIElement

Overrides:

mouseMoved in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mousePressed

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

Will be called when the user has pressed the mouse inside this element.

Specified by:

mousePressed in interface GUIElement

Overrides:

mousePressed in class ActivatableGUIElement

Parameters:

e - the mouse event relative to this element

moveSelection

public void moveSelection(int diffLines,
                          int diffElements)

Moves the selection.

Parameters:

diffLines - the distance in lines to move

diffElements - the distance in elements to move

resetScroll

public void resetScroll()

Resets the scroll index to the default value.

Specified by:

resetScroll in interface GUIScrollable

resizeElements

protected int resizeElements(int newSize)

Changes the number of list elements. If the new element count is less than the current count, excess elements are cut off. Otherwise the caller has to add elements with addElement(GUIElement).

Parameters:

newSize - the new element count

Returns:

the number of elements to add by the caller

scroll

public void scroll(int distance)

Moves the list.

Specified by:

scroll in interface GUIScrollable

Parameters:

distance - the distance to scroll

selectionChanged

protected void selectionChanged()

Called whenever the selected list entry has changed.

selectionChanged

protected abstract void selectionChanged(int selectedIndex)

Called whenever the selected list entry has changed.

Parameters:

selectedIndex - the selected list entry

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Overrides:

setBounds in class java.awt.Component

setChanged

public void setChanged()

Records that the contents have changed and must be repainted.

Specified by:

setChanged in interface GUIElement

Overrides:

setChanged in class AbstractGUIElement

setLayoutOrientation

protected void setLayoutOrientation(int layoutOrientation,
                                    int visibleRowCount)

Sets the layout orientation. See JList.setLayoutOrientation(int) and JList.setVisibleRowCount(int).

Parameters:

layoutOrientation - the layout orientation

visibleRowCount - the number of visible rows

setSelectedIndex

protected void setSelectedIndex(int newIndex)

Update the selected list entry.

Parameters:

newIndex - the new selected list entry

updateTooltip

private void updateTooltip()

Updates the current tooltip text.

updateTooltip

protected abstract void updateTooltip(int index,
                                      int x,
                                      int y,
                                      int w,
                                      int h)

Updates the tooltip text.

Parameters:

index - the index to use

x - the x coordinate of the cell

y - the y coordinate of the cell

w - the width of the cell

h - the height of the cell