Package VASSAL.build.module

Class NotesWindow

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.NotesWindow

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

public class NotesWindow
extends AbstractToolbarItem
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	Deprecated, for removal: This API element is subject to removal in a future version.
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	Deprecated, for removal: This API element is subject to removal in a future version.
static String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	lastSavedPublicNotes
protected String	lastSavedScenarioNotes
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
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	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class VASSAL.build.AbstractToolbarItem

HOTKEY, NAME

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()
String	getAttributeValueString(String name)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
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)	Default behavior assumes we are removing this from the module toolbar
protected void	restoreState()
protected void	save()
void	setAttribute(String name, Object value)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
void	setup(boolean show)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.AbstractToolbarItem

addLocalImageNames, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, makeLaunchButton, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setTooltipKey

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

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

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

Constant Field Values

HOT_KEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String HOT_KEY

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

See Also:

Constant Field Values

ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String ICON

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

See Also:

Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

Constant Field Values

frame

protected JDialog frame

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

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

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 HelpFile describing how to use and configure * this component

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button. Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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

Overrides:

setAttribute in class AbstractToolbarItem

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractToolbarItem.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(String name)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractToolbarItem.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractToolbarItem.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

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

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Overrides:

getConfigureComponents in class AbstractConfigurable

Returns:

A list of all child components (i.e. subcomponents) of this component that are configurable.

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

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 Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

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

Overrides:

addTo in class AbstractToolbarItem

Parameters:

b - parent Buildable to add this component to as a subcomponent.

removeFrom

public void removeFrom(Buildable b)

Description copied from class: AbstractToolbarItem

Default behavior assumes we are removing this from the module toolbar

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

b - parent

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