org.gjt.universe.gui.tree
Class TreeViewer

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.gjt.universe.gui.tree.TreeViewer

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class TreeViewer

extends javax.swing.JPanel

See Also:

Serialized Form

Field Summary

(package private) TVButtonBar	buttonBar
(package private) int	currentFilter
(package private) TVFilter[]	filters
(package private) TVModel	model
private static int	NUM_FILTERS
(package private) TVPopup	popup
(package private) TVRenderer	renderer
(package private) javax.swing.JTree	tree

Fields inherited from class javax.swing.JPanel

Fields inherited from class javax.swing.JComponent

accessibleContext, 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.Container

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

TreeViewer()
Create a TreeViewer object.

Method Summary

void	addExtensibleMenu(java.lang.String type, TVMenuExtension ext) Add a menu for a particular type of data.
int	getCurrentFilter() gets the current filter id #
TVFilter	getFilter(int n) gets a Filter that was defined by setFilter().
javax.swing.JTree	getJTree() returns the JTree used to display the tree.
int	getModelType() Returns the current model type.
java.lang.String[]	getPlayerColorMap() Returns the player colors, set by setPlayerMapping().
java.lang.String[]	getPlayerNameMap() Returns the player names, set by setPlayerMapping()
void	removeExtensibleMenu(java.lang.String type) Remove a menu extension for a particular type of data.
void	setCurrentFilter(int currentFilter) sets which filter is the current filter.
void	setCurrentTurn(int turn) Sets the current turn number, for proper rendering
void	setFilter(int n, TVFilter filter) sets a Filter.
void	setModelType(int value) Sets the current model type; type may be TVModel.BY_TYPE or TVModel.BY_HIERARCHY This will also inform the renderer attached to this tree that the model has changed.
void	setPlayerMapping(java.lang.String[] players, java.awt.Color[] colors) set the player ID to Name & Color mapping for the renderer.
protected void	setupListeners() sets up the mouse listeners for selection events
protected void	setupTree() takes care of all the JTree setup, initializes the model and the renderer, and fine-tunes the tree to taste.
void	showPopup(java.awt.event.MouseEvent e) displays the popup, when appropriate.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

NUM_FILTERS

private static final int NUM_FILTERS

See Also:

Constant Field Values

currentFilter

int currentFilter

tree

javax.swing.JTree tree

renderer

TVRenderer renderer

model

TVModel model

popup

TVPopup popup

buttonBar

TVButtonBar buttonBar

filters

TVFilter[] filters

Constructor Detail

TreeViewer

public TreeViewer()

Create a TreeViewer object.

Method Detail

setCurrentTurn

public void setCurrentTurn(int turn)

Sets the current turn number, for proper rendering

setPlayerMapping

public void setPlayerMapping(java.lang.String[] players,
                             java.awt.Color[] colors)

set the player ID to Name & Color mapping for the renderer. With the current renderer implementation, this will affect all TVRenderers. If we use the same colors for multiple players we can show which players are allied/neutral/enemy.

getPlayerNameMap

public java.lang.String[] getPlayerNameMap()

Returns the player names, set by setPlayerMapping()

getPlayerColorMap

public java.lang.String[] getPlayerColorMap()

Returns the player colors, set by setPlayerMapping(). Note that the colors are encoded as HTML tags, thus they are returned as Strings.

getJTree

public javax.swing.JTree getJTree()

returns the JTree used to display the tree.

addExtensibleMenu

public void addExtensibleMenu(java.lang.String type,
                              TVMenuExtension ext)

Add a menu for a particular type of data. If an extension already exists for the type, it will be replaced.

removeExtensibleMenu

public void removeExtensibleMenu(java.lang.String type)

Remove a menu extension for a particular type of data.

setFilter

public void setFilter(int n,
                      TVFilter filter)

sets a Filter. setFilter(null) clears the current filter.

getFilter

public TVFilter getFilter(int n)

gets a Filter that was defined by setFilter(). Returns null if no filter was defined, or 'n' is out of range.

setCurrentFilter

public void setCurrentFilter(int currentFilter)

sets which filter is the current filter. -1 is "all"

getCurrentFilter

public int getCurrentFilter()

gets the current filter id #

getModelType

public int getModelType()

Returns the current model type.

setModelType

public void setModelType(int value)

Sets the current model type; type may be TVModel.BY_TYPE or TVModel.BY_HIERARCHY This will also inform the renderer attached to this tree that the model has changed.

setupTree

protected void setupTree()

takes care of all the JTree setup, initializes the model and the renderer, and fine-tunes the tree to taste.

setupListeners

protected void setupListeners()

sets up the mouse listeners for selection events

showPopup

public void showPopup(java.awt.event.MouseEvent e)

displays the popup, when appropriate. Uses platform-dependent 'popup trigger' (e.g., RMB on Windows)