org.vizzini.ui.game
Class AbstractEnvironmentUISwing

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, IScoreListener, IStateListener, IEnvironmentUI, IListener

Direct Known Subclasses:

AbstractArcadeEnvUISwing, AbstractCardEnvUISwing, AbstractGridBoardUISwing, AbstractSimEnvironmentUISwing

public abstract class AbstractEnvironmentUISwing
extends JPanel
implements IEnvironmentUI

Provides base functionality for environment user interfaces in the game framework.

Since:

v0.1

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

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 java.awt.image.ImageObserver

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

Constructor Summary

AbstractEnvironmentUISwing()
Construct this object.

Method Summary

protected void	assignAgentListener(IAgent agent) Assign listeners using the given agent.
void	assignAgentListeners(Iterator agentIterator) Assign listeners using the given agents.
void	configure(Properties properties) Configure this environment.
IEnvironment	getEnvironment() Return the environment this UI represents.
protected EnvironmentUISupport	getSupport()
protected void	init() Initialize.
boolean	isAudioOn() Return true if audio is on.
protected void	removeAgentListener(IAgent agent) Remove the given agent as a listener.
void	removeAgentListeners(Iterator agentIterator) Remove the given agents as listeners.
void	reset() Reset.
void	scoreChange(ScoreEvent event) Respond to score change events.
void	setAudioOn(boolean isAudioOn) Set the audio on flag.
void	setEnvironment(IEnvironment environment) Set the environment this UI represents.

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.game.event.IStateListener

stateChange

Constructor Detail

AbstractEnvironmentUISwing

public AbstractEnvironmentUISwing()

Construct this object.

Since:

v0.1

Method Detail

assignAgentListeners

public void assignAgentListeners(Iterator agentIterator)

Assign listeners using the given agents.

Specified by:

assignAgentListeners in interface IEnvironmentUI

Parameters:

agentIterator - Agent iterator.

Since:

v0.1

configure

public void configure(Properties properties)
               throws InstantiationException,
                      IllegalAccessException

Configure this environment.

Specified by:

configure in interface IEnvironmentUI

Parameters:

properties - Source of configuration information.

Throws:

InstantiationException

IllegalAccessException

Since:

v0.1

getEnvironment

public IEnvironment getEnvironment()

Return the environment this UI represents.

Specified by:

getEnvironment in interface IEnvironmentUI

Since:

v0.1

isAudioOn

public boolean isAudioOn()

Return true if audio is on.

Specified by:

isAudioOn in interface IEnvironmentUI

Since:

v0.1

removeAgentListeners

public void removeAgentListeners(Iterator agentIterator)

Remove the given agents as listeners.

Specified by:

removeAgentListeners in interface IEnvironmentUI

Parameters:

agentIterator - Agent iterator.

Since:

v0.1

reset

public void reset()

Reset.

Specified by:

reset in interface IEnvironmentUI

Since:

v0.1

scoreChange

public void scoreChange(ScoreEvent event)

Respond to score change events.

Specified by:

scoreChange in interface IScoreListener

Since:

v0.1

setAudioOn

public void setAudioOn(boolean isAudioOn)

Set the audio on flag.

Specified by:

setAudioOn in interface IEnvironmentUI

Since:

v0.1

setEnvironment

public void setEnvironment(IEnvironment environment)

Set the environment this UI represents.

Specified by:

setEnvironment in interface IEnvironmentUI

Parameters:

environment - Environment.

Since:

v0.1

assignAgentListener

protected void assignAgentListener(IAgent agent)

Assign listeners using the given agent.

Parameters:

agent - Agent.

Since:

v0.1

getSupport

protected EnvironmentUISupport getSupport()

Returns:

Return support.

Since:

v0.3

init

protected void init()

Initialize.

Since:

v0.1

removeAgentListener

protected void removeAgentListener(IAgent agent)

Remove the given agent as a listener.

Parameters:

agent - Agent.

Since:

v0.1