org.vizzini.ui.game
Interface IEnvironmentUI

All Superinterfaces:
IListener, IScoreListener, IStateListener
All Known Subinterfaces:
IGridBoard3DUISwing, IGridBoardUI, IGridBoardUISwing, ISimEnvironmentUI
All Known Implementing Classes:
AbstractArcadeEnvUISwing, AbstractCardEnvUISwing, AbstractCardEnvUIText, AbstractEnvironmentUISwing, AbstractEnvironmentUIText, AbstractGridBoardUISwing, AbstractGridBoardUISwing, AbstractSimEnvironmentUISwing, DefaultGridBoard3DUISwing, DefaultGridBoardUISwing, DefaultSimEnvironmentUISwing, EnvironmentUISupport, EnvironmentUISwing, EnvironmentUISwing, EnvironmentUISwing, EnvironmentUIText, GridBoard3DUISwing, GridBoardUISwing, GridBoardUISwing, GridBoardUISwing, GridBoardUIText

public interface IEnvironmentUI
extends IStateListener, IScoreListener

Defines methods required by environment user interfaces in the game framework.

Since:
v0.1
Version:
v0.1
Author:
Jeffrey M. Thompson

Method Summary
 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.
 boolean isAudioOn()
          Return true if audio is on.
 void removeAgentListeners(Iterator agentIterator)
          Remove the given agents as listeners.
 void reset()
          Reset.
 void setAudioOn(boolean isAudioOn)
          Set the audio on flag.
 void setEnvironment(IEnvironment environment)
          Set the environment this UI represents.
 
Methods inherited from interface org.vizzini.game.event.IStateListener
stateChange
 
Methods inherited from interface org.vizzini.game.event.IScoreListener
scoreChange
 

Method Detail

setAudioOn

void setAudioOn(boolean isAudioOn)
Set the audio on flag.

Since:
v0.1

isAudioOn

boolean isAudioOn()
Return true if audio is on.

Since:
v0.1

setEnvironment

void setEnvironment(IEnvironment environment)
Set the environment this UI represents.

Parameters:
environment - Environment.
Since:
v0.1

getEnvironment

IEnvironment getEnvironment()
Return the environment this UI represents.

Since:
v0.1

assignAgentListeners

void assignAgentListeners(Iterator agentIterator)
Assign listeners using the given agents.

Parameters:
agentIterator - Agent iterator.
Since:
v0.1

configure

void configure(Properties properties)
               throws InstantiationException,
                      IllegalAccessException
Configure this environment.

Parameters:
properties - Source of configuration information.
Throws:
InstantiationException
IllegalAccessException
Since:
v0.1

removeAgentListeners

void removeAgentListeners(Iterator agentIterator)
Remove the given agents as listeners.

Parameters:
agentIterator - Agent iterator.
Since:
v0.1

reset

void reset()
Reset.

Since:
v0.1


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02