Package VASSAL.build.module.noteswindow

Class SecretNotesController

java.lang.Object

VASSAL.build.module.noteswindow.SecretNotesController

All Implemented Interfaces:

GameComponent, AddSecretNoteCommand.Interface, CommandEncoder

public class SecretNotesController
extends Object
implements GameComponent, CommandEncoder, AddSecretNoteCommand.Interface

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COL_DTM
static final int	COL_HANDLE
static final int	COL_NAME
static final int	COL_REVEALED
static final String	COMMAND_PREFIX
static final DateFormat	INTERNAL_DATE_FORMATTER	Deprecated, for removal: This API element is subject to removal in a future version.
static final DateFormat	LOCAL_DATE_FORMATTER	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
SecretNotesController()

Method Summary

Modifier and Type	Method	Description
void	addSecretNote(SecretNote note)
void	captureState()
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
JComponent	getControls()
SecretNote	getNoteForName(String s)
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

COL_HANDLE

public static final int COL_HANDLE

See Also:

• Constant Field Values

COL_DTM

public static final int COL_DTM

See Also:

• Constant Field Values

COL_NAME

public static final int COL_NAME

See Also:

• Constant Field Values

COL_REVEALED

public static final int COL_REVEALED

See Also:

• Constant Field Values

INTERNAL_DATE_FORMATTER

@Deprecated(since="2023-02-27",
            forRemoval=true)
public static final DateFormat INTERNAL_DATE_FORMATTER

Deprecated, for removal: This API element is subject to removal in a future version.

Date formatter to save and restore date/times in the save file. Not thread-safe!

LOCAL_DATE_FORMATTER

@Deprecated(since="2023-02-27",
            forRemoval=true)
public static final DateFormat LOCAL_DATE_FORMATTER

Deprecated, for removal: This API element is subject to removal in a future version.

Date formatter to display date/time to the player. Not thread-safe!

Constructor Details

SecretNotesController

public SecretNotesController()

Method Details

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

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

addSecretNote

public void addSecretNote(SecretNote note)

Specified by:

addSecretNote in interface AddSecretNoteCommand.Interface

getControls

public JComponent getControls()

save

public Command save()

captureState

public void captureState()

restoreState

public void restoreState()

getNoteForName

public SecretNote getNoteForName(String s)