Package VASSAL.build.module.noteswindow

Class PrivateNotesController

java.lang.Object

VASSAL.build.module.noteswindow.PrivateNotesController

All Implemented Interfaces:

GameComponent, SetPrivateTextCommand.Interface, CommandEncoder

public class PrivateNotesController
extends Object
implements GameComponent, CommandEncoder, SetPrivateTextCommand.Interface

Holds PrivateText objects, only displaying the one owned by the current user

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMMAND_PREFIX

Constructor Summary

Constructors

Constructor	Description
PrivateNotesController()

Method Summary

Modifier and Type	Method	Description
void	addPrivateText(PrivateText p)
void	captureState()
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
Component	getControls()
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
void	restoreState()
Command	save()
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_PREFIX

public static final String COMMAND_PREFIX

See Also:

Constant Field Values

Constructor Details

PrivateNotesController

public PrivateNotesController()

Method Details

getControls

public Component getControls()

addPrivateText

public void addPrivateText(PrivateText p)

Specified by:

addPrivateText in interface SetPrivateTextCommand.Interface

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

save

public Command save()

captureState

public void captureState()

restoreState

public void restoreState()