org.vizzini.ui.game.boardgame.chess
Class AbstractGridBoardUISwing

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.vizzini.ui.game.AbstractEnvironmentUISwing
                      org.vizzini.ui.game.boardgame.AbstractGridBoardUISwing
                          org.vizzini.ui.game.boardgame.GridBoard3DUISwing
                              org.vizzini.ui.game.boardgame.chess.AbstractGridBoardUISwing

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, IScoreListener, IStateListener, IGridBoard3DUISwing, IGridBoardUI, IGridBoardUISwing, IEnvironmentUI, IListener

Direct Known Subclasses:

DefaultGridBoardUISwing

public abstract class AbstractGridBoardUISwing
extends GridBoard3DUISwing

Provides base functionality for a Swing grid board user interface in the 3D chess framework.

Since:

v0.3

Version:

v0.3

Author:

Jeffrey M. Thompson

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static Map	PIECE_TYPES Map of token class to token UI class.
static String	SHOW_HINT_PROPERTY Name of the show hints property.

Fields inherited from class org.vizzini.ui.game.boardgame.GridBoard3DUISwing

_arrangement, _boards, _viewer, BOARD_SEPARATION

Fields inherited from class org.vizzini.ui.game.boardgame.AbstractGridBoardUISwing

LABEL_PAINTED_PROPERTY

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.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.vizzini.ui.game.boardgame.IGridBoard3DUISwing

ARRANGEMENT_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AbstractGridBoardUISwing()
Construct this object.

Method Summary

void	configure(Properties properties) Configure this environment.
JCheckBoxMenuItem	createShowHintsUI() Create a show hints user interface widget.
protected ITokenUI	createTokenUI(IToken token, Class type) Create a token user interface component for the given agent.
Color	getHintColor() Return the hint color.
protected Class	getTokenUIClassFor(IToken token) Return the proper ITokenUI type for the given token.
boolean	isHintMode() Return true if we're in hint mode.
void	setEnvironment(IEnvironment environment) Set the environment this UI represents.
void	setHintColor(Color color) Set the hint color.
protected void	setHintHighlights(IEnvironment environment, IAdjudicator adjudicator) Set the hint highlights.
void	setHintMode(boolean isHintMode) Set the flag indicating if we're in hint mode.
protected void	setSelectionHighlightData(HighlightData selectionHighlightData)
void	showHintsActionPerformed(ActionEvent event) Callback for the show hints action.

Methods inherited from class org.vizzini.ui.game.boardgame.GridBoard3DUISwing

add, cantActionPerformed, clearHighlights, createAndPlaceTokenUI, createArrangementUI, createBoards, createLabelPaintedUI, fillAdditionalViewMenuItems, get, getArrangement, getBoardUI, getBoardUI, getMagnify, getMarkings, getObjectViewer, getPositionForPoint, isArrangement, labelPaintedActionPerformed, reconcileBoard, remove, remove, reset, setArrangement, setBoardColor, setCurrentHighlightData, setLabelColor, setLabelPainted, setMagnify, setMarkings, setViewerColor, skewActionPerformed, slantActionPerformed, uprightActionPerformed

Methods inherited from class org.vizzini.ui.game.boardgame.AbstractGridBoardUISwing

clearCurrentHighlight, clearLastMoveHighlight, clearSelectionHighlight, getBoardColor, getCurrentColor, getCurrentHighlightWidth, getFirstColor, getGridLineColor, getLabelColor, getLastMoveColor, getLastMoveHighlightWidth, getPlacementAudioClip, getSecondColor, getSelectionColor, getSelectionHighlightData, getSelectionHighlightWidth, highlightCurrentPosition, highlightLastMovePosition, highlightSelectedPosition, isLabelPainted, isPositionUsable, setCurrentColor, setCurrentHighlightWidth, setFirstColor, setGridLineColor, setLastMoveColor, setLastMoveHighlightWidth, setSecondColor, setSelectionColor, setSelectionHighlightWidth, stateChange

Methods inherited from class org.vizzini.ui.game.AbstractEnvironmentUISwing

assignAgentListener, assignAgentListeners, getEnvironment, getSupport, init, isAudioOn, removeAgentListener, removeAgentListeners, scoreChange, setAudioOn

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vizzini.ui.game.boardgame.IGridBoardUISwing

clearCurrentHighlight, clearLastMoveHighlight, clearSelectionHighlight, getBoardColor, getCurrentColor, getCurrentHighlightWidth, getFirstColor, getGridLineColor, getLabelColor, getLastMoveColor, getLastMoveHighlightWidth, getSecondColor, getSelectionColor, getSelectionHighlightWidth, highlightCurrentPosition, highlightLastMovePosition, highlightSelectedPosition, isLabelPainted, setCurrentColor, setCurrentHighlightWidth, setFirstColor, setGridLineColor, setLastMoveColor, setLastMoveHighlightWidth, setSecondColor, setSelectionColor, setSelectionHighlightWidth

Methods inherited from interface org.vizzini.ui.game.IEnvironmentUI

assignAgentListeners, getEnvironment, isAudioOn, removeAgentListeners, setAudioOn

Methods inherited from interface org.vizzini.game.event.IStateListener

stateChange

Methods inherited from interface org.vizzini.game.event.IScoreListener

scoreChange

Field Detail

SHOW_HINT_PROPERTY

public static final String SHOW_HINT_PROPERTY

Name of the show hints property.

See Also:

Constant Field Values

PIECE_TYPES

public static final Map PIECE_TYPES

Map of token class to token UI class.

Constructor Detail

AbstractGridBoardUISwing

public AbstractGridBoardUISwing()

Construct this object. Extends the super method to initialize hint mode.

Since:

v0.3

Method Detail

configure

public void configure(Properties properties)
               throws InstantiationException,
                      IllegalAccessException

Configure this environment. Extends the super method to configure the object viewer.

Specified by:

configure in interface IEnvironmentUI

Overrides:

configure in class GridBoard3DUISwing

Parameters:

properties - Source of configuration information.

Throws:

InstantiationException

IllegalAccessException

Since:

v0.3

createShowHintsUI

public JCheckBoxMenuItem createShowHintsUI()

Create a show hints user interface widget.

Since:

v0.3

getHintColor

public Color getHintColor()

Return the hint color.

Since:

v0.3

isHintMode

public boolean isHintMode()

Return true if we're in hint mode.

Since:

v0.3

setEnvironment

public void setEnvironment(IEnvironment environment)

Set the environment this UI represents.

Specified by:

setEnvironment in interface IEnvironmentUI

Overrides:

setEnvironment in class GridBoard3DUISwing

Parameters:

environment - Environment.

Since:

v0.3

setHintColor

public void setHintColor(Color color)

Set the hint color.

Since:

v0.3

setHintMode

public void setHintMode(boolean isHintMode)

Set the flag indicating if we're in hint mode.

Since:

v0.3

showHintsActionPerformed

public void showHintsActionPerformed(ActionEvent event)

Callback for the show hints action.

Since:

v0.3

createTokenUI

protected ITokenUI createTokenUI(IToken token,
                                 Class type)

Create a token user interface component for the given agent. Extends the super method to handle the special case of KnighShape.

Overrides:

createTokenUI in class GridBoard3DUISwing

Parameters:

token - Token.

type - Token UI class.

Since:

v0.3

getTokenUIClassFor

protected Class getTokenUIClassFor(IToken token)

Return the proper ITokenUI type for the given token.

Specified by:

getTokenUIClassFor in class GridBoard3DUISwing

Since:

v0.3

setHintHighlights

protected void setHintHighlights(IEnvironment environment,
                                 IAdjudicator adjudicator)

Set the hint highlights.

Since:

v0.3

setSelectionHighlightData

protected void setSelectionHighlightData(HighlightData selectionHighlightData)

Overrides:

setSelectionHighlightData in class AbstractGridBoardUISwing

Parameters:

selectionHighlightData - The selectionHighlightData to set.

Since:

v0.3