wyvern.common.util
Class AWTList

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Panel
              extended bywyvern.common.util.AWTList
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class AWTList
extends java.awt.Panel

A pure-AWT version of the ImageList. Doesn't handle scrolling; put it in a ScrollPane to get scrollbars.

Version:
1.0, Mar 30, 2002
Author:
Steve Yegge
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Panel
java.awt.Panel.AccessibleAWTPanel
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class java.awt.Component
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
AWTList()
          Constructs a new AWTList
 
Method Summary
 void add(java.lang.String caption, java.awt.Image img)
          Adds an item to the end of the list.
 void add(java.lang.String caption, int tile, int index, short offset)
          Adds the specified text/picture to the list at the specified index.
 void add(java.lang.String caption, int tile, short offset)
          Adds an item to the end of the list.
protected  java.awt.Image getImage(int tile, int x, int y)
          Gets the image from the ClientImageCache
protected  java.awt.Image getImage(int tile, short offset)
          Returns a piece of an image given its offsets.
 java.awt.Component getItemAt(int index)
          Returns the list item at the specified index.
 int getItemIndex(AWTListItem item)
          Returns the index (i.e. list position) of a given item
 int getNumItems()
          Returns the number of items in the list.
 java.lang.String getTextValueAt(int index)
          Returns the text of the specified item.
 void itemSelected(int index, java.awt.event.MouseEvent e)
          An item at a particular index was selected.
static void main(java.lang.String[] args)
          Tests the list.
 void mouseEvent(AWTListItem item, java.awt.event.MouseEvent e)
          Notifies the list that one of the children was selected.
 void replaceItem(java.lang.String caption, short tile, int index, short offset)
          Replaces the item at the specified location.
 void setFont(int size)
          Sets the new font size for all the items.
 void setTextColor(int index, java.awt.Color c)
          Sets the text color for the item at the specified index.
 
Methods inherited from class java.awt.Panel
addNotify, getAccessibleContext
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AWTList

public AWTList()
Constructs a new AWTList

Method Detail

add

public void add(java.lang.String caption,
                int tile,
                int index,
                short offset)
Adds the specified text/picture to the list at the specified index.

Parameters:
caption - the item text
tile - the TileDatabase index of the object's picture, -1 if the object has no visible representation.
index - the position at which to insert the item. -1 means add to the end of the list.
offset - the offset at which to draw the image.

add

public void add(java.lang.String caption,
                int tile,
                short offset)
Adds an item to the end of the list.

Parameters:
caption - the item text
tile - the TileDatabase index of the object's picture, -1 if the object has no visible representation.
offset - the offset at which to draw the image.

add

public void add(java.lang.String caption,
                java.awt.Image img)
Adds an item to the end of the list.

Parameters:
caption - the item text
img - the item image

replaceItem

public void replaceItem(java.lang.String caption,
                        short tile,
                        int index,
                        short offset)
Replaces the item at the specified location.

Parameters:
caption - the item text
tile - the TileDatabase index of the object's picture, -1 if the object has no visible representation.
index - the index of the item to replace

getImage

protected java.awt.Image getImage(int tile,
                                  short offset)
Returns a piece of an image given its offsets.

Parameters:
offset - the image offsets

getImage

protected java.awt.Image getImage(int tile,
                                  int x,
                                  int y)
Gets the image from the ClientImageCache

Parameters:
tile - the tile number
x - the x offset
y - the y offset

getTextValueAt

public java.lang.String getTextValueAt(int index)
Returns the text of the specified item.

Parameters:
index - the index of the item to get
Returns:
the item caption, or null if not found

mouseEvent

public void mouseEvent(AWTListItem item,
                       java.awt.event.MouseEvent e)
Notifies the list that one of the children was selected.

Parameters:
item - the child that was selected
e - the MouseEvent

getItemIndex

public int getItemIndex(AWTListItem item)
Returns the index (i.e. list position) of a given item

Parameters:
item - the item to check
Returns:
the item's index, or -1 if it's not in the list

itemSelected

public void itemSelected(int index,
                         java.awt.event.MouseEvent e)
An item at a particular index was selected.


setFont

public void setFont(int size)
Sets the new font size for all the items.


getNumItems

public int getNumItems()
Returns the number of items in the list.


getItemAt

public java.awt.Component getItemAt(int index)
Returns the list item at the specified index.


setTextColor

public void setTextColor(int index,
                         java.awt.Color c)
Sets the text color for the item at the specified index.


main

public static void main(java.lang.String[] args)
Tests the list.