VASSAL.build.module.NotesWindow

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable

public class NotesWindow
extends AbstractConfigurable
implements GameComponent, CommandEncoder

This is a GameComponent that allows players to type and save text notes during a game. There is one set of shared public notes, and each player has a set of private notes visible only to him

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`NotesWindow.IconConfig`
`protected class`	`NotesWindow.NotesDialog`
`protected class`	`NotesWindow.SetPublicNote`
`protected class`	`NotesWindow.SetScenarioNote`

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BUTTON_TEXT`
`protected JDialog`	`frame`
`static String`	`HOT_KEY`
`static String`	`ICON`
`protected String`	`lastSavedPublicNotes`
`protected String`	`lastSavedScenarioNotes`
`protected LaunchButton`	`launch`
`protected PrivateNotesController`	`privateNotes`
`protected static String`	`PUBLIC_NOTE_COMMAND_PREFIX`
`protected TextConfigurer`	`publicNotes`
`protected static String`	`SCENARIO_NOTE_COMMAND_PREFIX`
`protected TextConfigurer`	`scenarioNotes`
`protected SecretNotesController`	`secretNotes`
`static String`	`TOOLTIP`

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor Description

NotesWindow()

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable b)`	Expects to be added to a `GameModule`.
`void`	`cancel()`
`protected void`	`captureState()`	Capture this object's state, to be restored if the user hits "Cancel"
`Command`	`decode(String command)`	Translate a String into a `Command`
`String`	`encode(Command c)`	Translate a `Command` into a String
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String name)`	Return a String representation of the attribute with the given name.
`Configurable[]`	`getConfigureComponents()`
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`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`	`removeFrom(Buildable b)`	Remove this component from its parent
`protected void`	`restoreState()`
`protected void`	`save()`
`void`	`setAttribute(String name, Object value)`	Sets an attribute value for this component.
`void`	`setup(boolean show)`	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details
- frame
  
  protected JDialog frame
- launch
  
  protected LaunchButton launch
- scenarioNotes
  
  protected TextConfigurer scenarioNotes
- publicNotes
  
  protected TextConfigurer publicNotes
- privateNotes
  
  protected PrivateNotesController privateNotes
- secretNotes
  
  protected SecretNotesController secretNotes
- SCENARIO_NOTE_COMMAND_PREFIX
  
  protected static final String SCENARIO_NOTE_COMMAND_PREFIX
  
  See Also:
  
  Constant Field Values
- PUBLIC_NOTE_COMMAND_PREFIX
  
  protected static final String PUBLIC_NOTE_COMMAND_PREFIX
  
  See Also:
  
  Constant Field Values
- HOT_KEY
  
  public static final String HOT_KEY
  
  See Also:
  
  Constant Field Values
- ICON
  
  public static final String ICON
  
  See Also:
  
  Constant Field Values
- BUTTON_TEXT
  
  public static final String BUTTON_TEXT
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  See Also:
  
  Constant Field Values
- lastSavedScenarioNotes
  
  protected String lastSavedScenarioNotes
- lastSavedPublicNotes
  
  protected String lastSavedPublicNotes
Constructor Details
- NotesWindow
  
  public NotesWindow()
Method Details
- captureState
  
  protected void captureState()
  
  Capture this object's state, to be restored if the user hits "Cancel"
- cancel
  
  public void cancel()
- restoreState
  
  protected void restoreState()
- save
  
  protected void save()
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- setAttribute
  
  public void setAttribute(String name, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets an attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getAttributeValueString
  
  public String getAttributeValueString(String name)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- encode
  
  public String encode(Command c)
  
  Description copied from interface: CommandEncoder
  
  Translate a Command into a String
  
  Specified by:
  
  encode in interface CommandEncoder
- decode
  
  public Command decode(String command)
  
  Description copied from interface: CommandEncoder
  
  Translate a String into a Command
  
  Specified by:
  
  decode in interface CommandEncoder
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from class: AbstractConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getConfigureComponents
  
  public Configurable[] getConfigureComponents()
  
  Specified by:
  
  getConfigureComponents in interface Configurable
  
  Overrides:
  
  getConfigureComponents in class AbstractConfigurable
  
  Returns:
  
  an array of Configurer objects representing the Configurable children of this Configurable object
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- addTo
  
  public void addTo(Buildable b)
  
  Expects to be added to a GameModule. Adds a button to the controls window toolbar to show the window containing the notes
  
  Specified by:
  
  addTo in interface Buildable
- removeFrom
  
  public void removeFrom(Buildable b)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- setup
  
  public void setup(boolean show)
  
  Description copied from interface: GameComponent
  
  Notify the GameComponent that a game has started/ended
  
  Specified by:
  
  setup in interface GameComponent
  
  Parameters:
  
  show - if true, a game is starting. If false, then a game is ending
- 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

Class NotesWindow