Class ScenarioPropertiesOptionTab

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.ScenarioPropertiesOptionTab

All Implemented Interfaces:

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

public class ScenarioPropertiesOptionTab
extends AbstractConfigurable
implements MutablePropertiesContainer, CommandEncoder, GameComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScenarioPropertiesOptionTab.AlignConfig
static class	ScenarioPropertiesOptionTab.ChangeOptionConfig
static class	ScenarioPropertiesOptionTab.LockScenarioOptionsTab	A Command to record the lock status of an individual Scenario Options tab
static class	ScenarioPropertiesOptionTab.TextConfig

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

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer

MutablePropertiesContainer.Impl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIGN_LABELS_RIGHT
static final String	CENTER
static final char	COMMAND_DELIMITER
static final String	COMMAND_PREFIX
protected String	description
static final String	DESCRIPTION
protected Map<String,VASSAL.build.module.properties.ScenarioPropertiesOptionTab.Entry>	entries
protected String	heading
static final String	HEADING
static final String	LEFT
static final String	LEFT_COLUMN_ALIGNMENT
protected String	leftColumnAlignment
protected JButton	lockButton
protected String	lockedBypw	Password of User that locked this tab
protected String	lockedByuser	Username that locked this tab
protected String	lockedDt	UTD Date/Time tab was locked
protected JLabel	lockLabel
static final String	NAME
protected Buildable	parent
protected MutablePropertiesContainer	parentContainer
static final String	REPORT
static final String	REPORT_NEW_VALUE
static final String	REPORT_OLD_VALUE
static final String	REPORT_PROMPT
static final String	REPORT_PROP_NAME
static final String	REPORT_TAB
protected FormattedString	reportFormat
static final String	RIGHT
protected JPanel	uiPanel
protected boolean	uiTabLock	Current locked status of the tab recorded in the UI, but not yet saved
protected String	uiTabLockDt	Date/Time of lock
protected String	uiTabLockPw
protected String	uiTabLockUser	User and password who locked the UI
protected JButton	unlockButton
protected JLabel	unlockLabel

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
ScenarioPropertiesOptionTab()

Method Summary

Modifier and Type	Method	Description
void	addMutableProperty(String key, MutableProperty p)	Add a property under the given key
void	addTo(Buildable parent)	Adds this component to its parent.
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getLeftColumnAlignment()
String	getLockedBypw()
String	getLockedByuser()
Component	getLockUI()	Return a UI that displays and manipulates the Locked status of this tab.
String	getMutablePropertiesContainerId()	Return a unique Id for the container
MutableProperty	getMutableProperty(String propertyName)	Find a GlobalProperty object with the given name
Buildable	getParent()
List<String>	getPropertyList()	SearchTarget
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
FormattedString	getReportFormat()
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
Component	getUI()
boolean	isLocked()	Is this Options tab currently locked?
protected boolean	isLockingAllowed()	Is the current user allowed to change the locked state of a Scenario Option tab - A Locked tab can only be unlocked by the user who locked it
boolean	isUiLocked()	Is this options tab recorded as locked in the UI?
protected void	lockTab(boolean locking, String lockDt)	Lock or unlock the tab.
protected void	lockUi(boolean lock)	Update the locked status of the UI for this tab.
void	processChanges()	Process any changes made to this Tab and it's options.
protected void	rebuildUI()
protected void	refreshLockUI()	Refresh the accessibility of all UI components
void	removeFrom(Buildable parent)	Remove this component from its parent
MutableProperty	removeMutableProperty(String key)	Remove the property with the given key
protected void	resetTab()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setLeftColumnAlignment(String leftColumnAlignment)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, 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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

COMMAND_DELIMITER

public static final char COMMAND_DELIMITER

See Also:

• Constant Field Values

COMMAND_PREFIX

public static final String COMMAND_PREFIX

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

REPORT

public static final String REPORT

See Also:

• Constant Field Values

ALIGN_LABELS_RIGHT

public static final String ALIGN_LABELS_RIGHT

See Also:

• Constant Field Values

HEADING

public static final String HEADING

See Also:

• Constant Field Values

LEFT_COLUMN_ALIGNMENT

public static final String LEFT_COLUMN_ALIGNMENT

See Also:

• Constant Field Values

LEFT

public static final String LEFT

See Also:

• Constant Field Values

CENTER

public static final String CENTER

See Also:

• Constant Field Values

RIGHT

public static final String RIGHT

See Also:

• Constant Field Values

REPORT_PROP_NAME

public static final String REPORT_PROP_NAME

See Also:

• Constant Field Values

REPORT_OLD_VALUE

public static final String REPORT_OLD_VALUE

See Also:

• Constant Field Values

REPORT_NEW_VALUE

public static final String REPORT_NEW_VALUE

See Also:

• Constant Field Values

REPORT_PROMPT

public static final String REPORT_PROMPT

See Also:

• Constant Field Values

REPORT_TAB

public static final String REPORT_TAB

See Also:

• Constant Field Values

description

protected String description

heading

protected String heading

leftColumnAlignment

protected String leftColumnAlignment

parentContainer

protected MutablePropertiesContainer parentContainer

parent

protected Buildable parent

reportFormat

protected FormattedString reportFormat

lockedByuser

protected String lockedByuser

Username that locked this tab

lockedBypw

protected String lockedBypw

Password of User that locked this tab

lockedDt

protected String lockedDt

UTD Date/Time tab was locked

uiTabLock

protected boolean uiTabLock

Current locked status of the tab recorded in the UI, but not yet saved

uiTabLockUser

protected String uiTabLockUser

User and password who locked the UI

uiTabLockPw

protected String uiTabLockPw

uiTabLockDt

protected String uiTabLockDt

Date/Time of lock

lockLabel

protected JLabel lockLabel

lockButton

protected JButton lockButton

unlockLabel

protected JLabel unlockLabel

unlockButton

protected JButton unlockButton

uiPanel

protected JPanel uiPanel

entries

protected Map<String,VASSAL.build.module.properties.ScenarioPropertiesOptionTab.Entry> entries

Constructor Details

ScenarioPropertiesOptionTab

public ScenarioPropertiesOptionTab()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) 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:

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

value - 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 can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.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 AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

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

getParent

public Buildable getParent()

getReportFormat

public FormattedString getReportFormat()

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

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.

addMutableProperty

public void addMutableProperty(String key,
 MutableProperty p)

Description copied from interface: MutablePropertiesContainer

Add a property under the given key

Specified by:

addMutableProperty in interface MutablePropertiesContainer

Parameters:

key - key

p - property

removeMutableProperty

public MutableProperty removeMutableProperty(String key)

Description copied from interface: MutablePropertiesContainer

Remove the property with the given key

Specified by:

removeMutableProperty in interface MutablePropertiesContainer

Parameters:

key - key

getMutableProperty

public MutableProperty getMutableProperty(String propertyName)

Description copied from interface: MutablePropertiesContainer

Find a GlobalProperty object with the given name

Specified by:

getMutableProperty in interface MutablePropertiesContainer

getMutablePropertiesContainerId

public String getMutablePropertiesContainerId()

Description copied from interface: MutablePropertiesContainer

Return a unique Id for the container

Specified by:

getMutablePropertiesContainerId in interface MutablePropertiesContainer

getLeftColumnAlignment

public String getLeftColumnAlignment()

setLeftColumnAlignment

public void setLeftColumnAlignment(String leftColumnAlignment)

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

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

resetTab

protected void resetTab()

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

getUI

public Component getUI()

rebuildUI

protected void rebuildUI()

getLockUI

public Component getLockUI()

Return a UI that displays and manipulates the Locked status of this tab. The UI will be different for different users. a) Tab not locked - show a lock button b) Tab locked by me - show an unlock button c) Tab locked by other, just show

Returns:

generated UI

lockUi

protected void lockUi(boolean lock)

Update the locked status of the UI for this tab. The underlying tab will not be locked until user clicks OK on the enclosing dialog.

Parameters:

lock - lock status

refreshLockUI

protected void refreshLockUI()

Refresh the accessibility of all UI components

lockTab

protected void lockTab(boolean locking,
 String lockDt)

Lock or unlock the tab.

Parameters:

locking - true to lock

isLockingAllowed

protected boolean isLockingAllowed()

Is the current user allowed to change the locked state of a Scenario Option tab - A Locked tab can only be unlocked by the user who locked it. - An unlocked tab can only be locked by o A user with a real name specified o A user with a password specified o If Player sides are defined, then the player must be one of the defined sides.

Returns:

true if action allowed.

getLockedByuser

public String getLockedByuser()

getLockedBypw

public String getLockedBypw()

isLocked

public boolean isLocked()

Is this Options tab currently locked?

isUiLocked

public boolean isUiLocked()

Is this options tab recorded as locked in the UI?

processChanges

public void processChanges()

Process any changes made to this Tab and it's options. Called when OK is pressed on the main Options dialog. Logging has been paused by the level above, so we can just generate and log Commands as required. They will be grouped into a single undo at the level above.

getPropertyNames

public List<String> getPropertyNames()

Description copied from class: AbstractBuildable

Override this method to provide a list of properties to be exposed for use by expressions in the module.

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed

getPropertyList

public List<String> getPropertyList()

Description copied from class: AbstractConfigurable

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractConfigurable

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)