Class PlayerIdFormattedExpressionConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.StringConfigurer

VASSAL.configure.FormattedStringConfigurer

VASSAL.configure.FormattedExpressionConfigurer

VASSAL.configure.PlayerIdFormattedExpressionConfigurer

All Implemented Interfaces:

ActionListener, FocusListener, EventListener

public class PlayerIdFormattedExpressionConfigurer
extends FormattedExpressionConfigurer

Utility subclass of FormattedStringConfigurer which includes variable keys for player name, side, and id

Nested Class Summary

Nested classes/interfaces inherited from class FormattedExpressionConfigurer

FormattedExpressionConfigurer.ExpressionButton

Modifier and Type	Class	Description
static class	FormattedExpressionConfigurer.ExpressionButton	A small 'Calculator' button added after the text to indicate this Configurer accepts Expressions.

Nested classes/interfaces inherited from class Configurer

Configurer.ContextLevel

Modifier and Type	Class	Description
static enum	Configurer.ContextLevel	The ContextLevel of a Configurer defines the level that it is defined at.

Field Summary

Fields inherited from class FormattedExpressionConfigurer

button, pieceTarget

Modifier and Type	Field	Description
protected FormattedExpressionConfigurer.ExpressionButton	button
protected EditablePiece	pieceTarget

Fields inherited from class StringConfigurer

DEFAULT_LENGHTH, DEFAULT_LENGTH, length, nameField, p, updateInProgress

Modifier and Type	Field	Description
protected static final int	DEFAULT_LENGHTH	Deprecated, for removal: This API element is subject to removal in a future version.
protected static final int	DEFAULT_LENGTH
protected int	length
protected JTextField	nameField
protected JPanel	p
protected boolean	updateInProgress

Fields inherited from class Configurer

changeSupport, context, contextLevel, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected AbstractBuildable	context
protected Configurer.ContextLevel	contextLevel
protected boolean	frozen	When frozen is true, setting the value programmatically will not result in a PropertyChangeEvent being fired
protected String	hint	A Hint to be displayed in an empty field
protected String	key	A String the uniquely identifies this property
static final Color	LIST_ENTRY_HIGHLIGHT_COLOR	Default Highlight Color for Configurable Lists
protected String	name	A String that provides a short description of the property to the user
static final String	NAME_PROPERTY
protected boolean	noUpdate	When noUpdate is true, setting the value programmatically will not result in an update of the GUI Component
protected Object	value	The value

Constructor Summary

Constructors

Constructor	Description
PlayerIdFormattedExpressionConfigurer(String[] options, String initialValue)
PlayerIdFormattedExpressionConfigurer(String[] options, String initialValue, GamePiece piece)
PlayerIdFormattedExpressionConfigurer(String key, String name, String[] options)

Method Summary

Methods inherited from class FormattedExpressionConfigurer

buildButton, getControls, storePiece

Modifier and Type	Method	Description
protected FormattedExpressionConfigurer.ExpressionButton	buildButton()
Component	getControls()	GUI interface for setting the option in an editing window
protected void	storePiece(GamePiece p)

Methods inherited from class FormattedStringConfigurer

actionPerformed, focusGained, focusLost, getOptions, setOptions

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	focusGained(FocusEvent arg0)
void	focusLost(FocusEvent arg0)
String[]	getOptions()
void	setOptions(String[] options)

Methods inherited from class StringConfigurer

addFocusListener, buildTextField, getGrowthConstraint, getValueString, removeFocusListener, requestFocus, setEnabled, setHighlighted, setLabelVisible, setValue, updateHint

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
protected JTextField	buildTextField()
protected String	getGrowthConstraint()
String	getValueString()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
void	requestFocus()	Move the cursor to the first input field of this Configurer
void	setEnabled(boolean enabled)	Enable or Disable the action of this configurer/
void	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setValue(String s)	Set the Object value from a String
void	updateHint(String hint)

Methods inherited from class Configurer

addPropertyChangeListener, fireUpdate, getContext, getContextLevel, getHint, getKey, getName, getScreenSize, getValue, initCustomControls, isFrozen, isHighlighted, isPieceContext, removePropertyChangeListener, repack, repack, setContext, setContext, setContext, setContextLevel, setFrozen, setHint, setHintKey, setLabelVisibile, setName, setValue

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a listener to be notified when the Object state changes
void	fireUpdate()	Fire a PropertyChangeEvent as if the value had been set from null
AbstractBuildable	getContext()	Get the Context for this Configurer
Configurer.ContextLevel	getContextLevel()
String	getHint()	Return the current hint String
String	getKey()	Unique identifier
String	getName()	Plain English description of the Object
protected Dimension	getScreenSize()	Return the current screen size for use by List type configurers to allow them to take up maximum screen real estate if needed.
Object	getValue()	The Object value May be null if the Object has not been initialized
void	initCustomControls(JDialog d, Configurable target)	Initialize any custom controls / keystrokes
boolean	isFrozen()
boolean	isHighlighted()	Return the current highlighted status
boolean	isPieceContext()
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	repack()	Repack the current configurer
protected void	repack(Component controls)	Repack a dialog or window
void	setContext(AbstractBuildable context)	Set the Context for this Configurer to the first ancestor that is of type GameModule or Map NOTE: The ContextLevel may already have been preset by the ConfigureFactory when the Configurer was created.
void	setContext(Buildable context)
void	setContext(Configurable context)
void	setContextLevel(Configurer.ContextLevel contextLevel)
void	setFrozen(boolean val)	If true, then don't fire PropertyChangeEvents when the value is reset
void	setHint(String hint)	Set the Hint String
void	setHintKey(String hintKey)	Set the Hint String via a I18n key
void	setLabelVisibile(boolean visible)	Deprecated, for removal: This API element is subject to removal in a future version. Use Configurer.setLabelVisible(boolean) instead.
void	setName(String s)
void	setValue(Object o)	Set the Object value

Methods inherited from class Object

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

Constructor Details

PlayerIdFormattedExpressionConfigurer

public PlayerIdFormattedExpressionConfigurer(String[] options,
 String initialValue,
 GamePiece piece)

PlayerIdFormattedExpressionConfigurer

public PlayerIdFormattedExpressionConfigurer(String[] options,
 String initialValue)

PlayerIdFormattedExpressionConfigurer

public PlayerIdFormattedExpressionConfigurer(String key,
 String name,
 String[] options)