rle.core
Class GameContextBase

java.lang.Object
  rle.core.GameContextBase

All Implemented Interfaces:

GameContext

Direct Known Subclasses:

SimpleGame

public class GameContextBase
extends java.lang.Object
implements GameContext

Basic implemention of GameContext.

Field Summary

protected CommandSet	commandSet
protected java.util.HashSet<GameContextListener>	contextListeners
protected Board	currentBoard
protected java.lang.String	currentLanguage
protected Perspective	currentPerspective
protected Player	currentPlayer
protected InfoGroupView	data
protected GameClock	gameClock
protected GameThread	gameThread
protected MessageQueue	messageQueue
protected boolean	playing
protected javax.swing.RootPaneContainer	rootPaneContainer
protected SchemaBean	schema
protected Variant	variant
protected World	world

Constructor Summary

GameContextBase()

Method Summary

void	addGameContextListener(GameContextListener cl) Register a listener for changes to the GameContext.
CommandSet	commandSet() Return the current command set.
PlugIn	createPlugIn(java.lang.String path) Create a Plug-in for key "plugindata" without explicitly lookup up the node designated by path.
PlugIn	createPlugIn(java.lang.String path, java.lang.String key) Create a Plug-in for a key without explicitly lookup up the node designated by path.
java.util.List<PlugIn>	createPlugIns(java.lang.String path) Create a Plug-in for key "plugindata" for each child node at path.
Board	currentBoard() The current board.
java.lang.String	currentLanguage() The current language.
Perspective	currentPerspective() The current Perspective.
Player	currentPlayer() The current player.
InfoGroupView	data() Returns a view of the root node of the Variant Manager data tree.
protected void	fireBoardChange(Board leaving, Board entering) Notify listeners that the board has changed.
protected void	fireCommandSetChange(CommandSet oldSet, CommandSet newSet) Notify listeners that the CommandSet has changed.
protected void	fireLanguageChange() Notify listeners that the language has changed.
GameClock	gameClock() The game clock.
GameThread	gameThread()
boolean	isPlaying()
protected InfoGroupView	loadData(Variant variant) Create a root node from the data file for this variant.
MessageQueue	messageQueue() The message queue.
void	removeGameContextListener(GameContextListener cl) Remove a listener.
javax.swing.RootPaneContainer	rootPaneContainer() The JFrame/Frame/Applet window.
void	setCommandSet(CommandSet commandSet) Set the current command set.
void	setCurrentBoard(Board currentBoard) Changes the current board and fires a BoardChangeEvent.
void	setCurrentLanguage(java.lang.String currentLanguage) Changes the current language and fires a LanguageChangeEvent.
void	setCurrentPerspective(Perspective currentPerspective)
void	setCurrentPlayer(Player currentPlayer)
void	setGameClock(GameClock gameClock)
void	setGameThread(GameThread gt)
void	setMessageQueue(MessageQueue mq)
void	setPlaying(boolean b)
void	setRootPaneContainer(javax.swing.RootPaneContainer c)
void	setVariant(Variant variant)
void	setWorld(World world)
java.lang.String	translation(java.lang.String path) Convenience method to retrieve a translation at the given path for key "message".
java.lang.String	translation(java.lang.String path, java.lang.String key) Convenience method to retrieve a translation at the given path for the given key.
Variant	variant() Returns a view of the current Variant.
World	world() The world.

Methods inherited from class java.lang.Object

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

Field Detail

rootPaneContainer

protected javax.swing.RootPaneContainer rootPaneContainer

variant

protected Variant variant

data

protected InfoGroupView data

schema

protected SchemaBean schema

currentBoard

protected Board currentBoard

currentPlayer

protected Player currentPlayer

currentPerspective

protected Perspective currentPerspective

currentLanguage

protected java.lang.String currentLanguage

gameClock

protected GameClock gameClock

world

protected World world

commandSet

protected CommandSet commandSet

messageQueue

protected MessageQueue messageQueue

gameThread

protected GameThread gameThread

playing

protected boolean playing

contextListeners

protected java.util.HashSet<GameContextListener> contextListeners

Constructor Detail

GameContextBase

public GameContextBase()

Method Detail

gameThread

public GameThread gameThread()

Specified by:

gameThread in interface GameContext

setGameThread

public void setGameThread(GameThread gt)

setRootPaneContainer

public void setRootPaneContainer(javax.swing.RootPaneContainer c)

rootPaneContainer

public javax.swing.RootPaneContainer rootPaneContainer()

Description copied from interface: GameContext

The JFrame/Frame/Applet window.

Specified by:

rootPaneContainer in interface GameContext

isPlaying

public boolean isPlaying()

Specified by:

isPlaying in interface GameContext

setPlaying

public void setPlaying(boolean b)

setVariant

public void setVariant(Variant variant)

variant

public Variant variant()

Returns a view of the current Variant. This view can be used for searches or to access information about the variant.

Specified by:

variant in interface GameContext

loadData

protected InfoGroupView loadData(Variant variant)

Create a root node from the data file for this variant. If no such file exists, throw an exception.

Parameters:

variant -

Returns:

data

public InfoGroupView data()

Returns a view of the root node of the Variant Manager data tree.

Specified by:

data in interface GameContext

currentBoard

public Board currentBoard()

Description copied from interface: GameContext

The current board.

Specified by:

currentBoard in interface GameContext

currentPlayer

public Player currentPlayer()

Description copied from interface: GameContext

The current player.

Specified by:

currentPlayer in interface GameContext

currentPerspective

public Perspective currentPerspective()

Description copied from interface: GameContext

The current Perspective.

Specified by:

currentPerspective in interface GameContext

currentLanguage

public java.lang.String currentLanguage()

Description copied from interface: GameContext

The current language.

Specified by:

currentLanguage in interface GameContext

gameClock

public GameClock gameClock()

Description copied from interface: GameContext

The game clock.

Specified by:

gameClock in interface GameContext

world

public World world()

The world.

Specified by:

world in interface GameContext

messageQueue

public MessageQueue messageQueue()

Description copied from interface: GameContext

The message queue.

Specified by:

messageQueue in interface GameContext

setGameClock

public void setGameClock(GameClock gameClock)

setWorld

public void setWorld(World world)

setCurrentBoard

public void setCurrentBoard(Board currentBoard)

Changes the current board and fires a BoardChangeEvent.

setCurrentLanguage

public void setCurrentLanguage(java.lang.String currentLanguage)

Changes the current language and fires a LanguageChangeEvent.

setCurrentPerspective

public void setCurrentPerspective(Perspective currentPerspective)

setCurrentPlayer

public void setCurrentPlayer(Player currentPlayer)

addGameContextListener

public void addGameContextListener(GameContextListener cl)

Description copied from interface: GameContext

Register a listener for changes to the GameContext.

Specified by:

addGameContextListener in interface GameContext

removeGameContextListener

public void removeGameContextListener(GameContextListener cl)

Description copied from interface: GameContext

Remove a listener.

Specified by:

removeGameContextListener in interface GameContext

fireLanguageChange

protected void fireLanguageChange()

Notify listeners that the language has changed.

fireBoardChange

protected void fireBoardChange(Board leaving,
                               Board entering)

Notify listeners that the board has changed.

fireCommandSetChange

protected void fireCommandSetChange(CommandSet oldSet,
                                    CommandSet newSet)

Notify listeners that the CommandSet has changed.

commandSet

public CommandSet commandSet()

Return the current command set.

Specified by:

commandSet in interface GameContext

setCommandSet

public void setCommandSet(CommandSet commandSet)

Set the current command set.

Specified by:

setCommandSet in interface GameContext

setMessageQueue

public void setMessageQueue(MessageQueue mq)

createPlugIns

public java.util.List<PlugIn> createPlugIns(java.lang.String path)

Create a Plug-in for key "plugindata" for each child node at path.

Specified by:

createPlugIns in interface GameContext

createPlugIn

public PlugIn createPlugIn(java.lang.String path)

Create a Plug-in for key "plugindata" without explicitly lookup up the node designated by path.

Specified by:

createPlugIn in interface GameContext

createPlugIn

public PlugIn createPlugIn(java.lang.String path,
                           java.lang.String key)

Create a Plug-in for a key without explicitly lookup up the node designated by path.

Specified by:

createPlugIn in interface GameContext

translation

public java.lang.String translation(java.lang.String path)

Convenience method to retrieve a translation at the given path for key "message".

Specified by:

translation in interface GameContext

translation

public java.lang.String translation(java.lang.String path,
                                    java.lang.String key)

Convenience method to retrieve a translation at the given path for the given key.

Specified by:

translation in interface GameContext