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 int
COL_DTM
static int
COL_HANDLE
static int
COL_NAME
static int
COL_REVEALED
static String
COMMAND_PREFIX
static DateFormat
INTERNAL_DATE_FORMATTER
static DateFormat
LOCAL_DATE_FORMATTER
-
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 aCommand
String
encode(Command c)
Translate aCommand
into a StringJComponent
getControls()
SecretNote
getNoteForName(String s)
Command
getRestoreCommand()
When saving a game, each GameComponent should return aCommand
that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return nullvoid
restoreState()
Command
save()
void
setup(boolean gameStarting)
Notify the GameComponent that a game has started/ended
-
Field Details
-
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
-
LOCAL_DATE_FORMATTER
-
-
Constructor Details
-
SecretNotesController
public SecretNotesController()
-
-
Method Details
-
getRestoreCommand
Description copied from interface:GameComponent
When saving a game, each GameComponent should return aCommand
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 interfaceGameComponent
-
setup
public void setup(boolean gameStarting)Description copied from interface:GameComponent
Notify the GameComponent that a game has started/ended- Specified by:
setup
in interfaceGameComponent
- Parameters:
gameStarting
- if true, a game is starting. If false, then a game is ending
-
decode
Description copied from interface:CommandEncoder
Translate a String into aCommand
- Specified by:
decode
in interfaceCommandEncoder
-
encode
Description copied from interface:CommandEncoder
Translate aCommand
into a String- Specified by:
encode
in interfaceCommandEncoder
-
addSecretNote
- Specified by:
addSecretNote
in interfaceAddSecretNoteCommand.Interface
-
getControls
-
save
-
captureState
public void captureState() -
restoreState
public void restoreState() -
getNoteForName
-