Class BeanShellExpressionConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.StringConfigurer

VASSAL.configure.BeanShellExpressionConfigurer

public class BeanShellExpressionConfigurer
extends StringConfigurer

A Configurer for Java Expressions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BeanShellExpressionConfigurer.Option	enum describing any special processing that needs to be done for particular expression types NONE = No special handling PME = Property Match Expression handling.

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

Modifier and Type	Field	Description
protected FunctionBuilder	builder
protected JPanel	detailPanel
protected boolean	displayOnly
protected Icon	down
protected StringConfigurer	errorMessage
protected JPanel	expressionPanel
protected JButton	extraDetails
protected JLabel	methods
protected JTextArea	nameField
protected BeanShellExpressionConfigurer.Option	option
protected String	selectedText
protected EditablePiece	target
protected Icon	up
protected VASSAL.configure.BeanShellExpressionConfigurer.Validator	validator
protected JLabel	variables

Fields inherited from class StringConfigurer

DEFAULT_LENGHTH, DEFAULT_LENGTH, length, 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 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
BeanShellExpressionConfigurer(String key, String name, String val, GamePiece piece)	Create a labeled BeanShellConfigurer with an initial value and target piece
BeanShellExpressionConfigurer(String key, String name, String val, GamePiece piece, BeanShellExpressionConfigurer.Option option)
BeanShellExpressionConfigurer(String key, String name, String val, GamePiece piece, BeanShellExpressionConfigurer.Option option, boolean displayOnly)
BeanShellExpressionConfigurer(String key, String name, String val, GamePiece piece, BeanShellExpressionConfigurer.Option option, FunctionBuilder builder)
BeanShellExpressionConfigurer(String val, GamePiece piece)	Create an unlabeled BeanShellConfigurer with an initial value and target piece

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
protected String	cleanName(String name)
protected void	doPopup()
Component	getControls()	GUI interface for setting the option in an editing window
BeanShellExpressionConfigurer.Option	getOption()
String	getSelectedText()
protected Component	getTopLevelAncestor()
String	getValueString()
protected void	insertName(String name)
protected void	insertPropertyName(String name)	Insert a property name into the expression
boolean	isDisplayOnly()
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
protected void	setDetails()
protected void	setDetails(String error, List<String> v, List<String> m)
void	setDisplayOnly(boolean displayOnly)
void	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setOption(BeanShellExpressionConfigurer.Option option)
void	setSelectedText(String selectedText)
void	setValue(String s)	Set the Object value from a String
protected void	strip()
protected void	updateParentBuilder()	If we are the child of a FunctionBuilder, notify it we have changed.
void	validate()

Methods inherited from class StringConfigurer

buildTextField, getGrowthConstraint, setEnabled, setLabelVisible, updateHint

Modifier and Type	Method	Description
protected JTextField	buildTextField()
protected String	getGrowthConstraint()
void	setEnabled(boolean enabled)	Enable or Disable the action of this configurer/
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
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

Field Details

expressionPanel

protected JPanel expressionPanel

detailPanel

protected JPanel detailPanel

validator

protected VASSAL.configure.BeanShellExpressionConfigurer.Validator validator

extraDetails

protected JButton extraDetails

up

protected Icon up

down

protected Icon down

errorMessage

protected StringConfigurer errorMessage

variables

protected JLabel variables

methods

protected JLabel methods

target

protected EditablePiece target

option

protected BeanShellExpressionConfigurer.Option option

selectedText

protected String selectedText

displayOnly

protected boolean displayOnly

builder

protected FunctionBuilder builder

nameField

protected JTextArea nameField

Constructor Details

BeanShellExpressionConfigurer

public BeanShellExpressionConfigurer(String val,
 GamePiece piece)

Create an unlabeled BeanShellConfigurer with an initial value and target piece

Parameters:

val - Initial expression

piece - Target Piece

BeanShellExpressionConfigurer

public BeanShellExpressionConfigurer(String key,
 String name,
 String val,
 GamePiece piece)

Create a labeled BeanShellConfigurer with an initial value and target piece

Parameters:

key - Configurer Key

name - Label

val - Initial expression

piece - Target Piece

BeanShellExpressionConfigurer

public BeanShellExpressionConfigurer(String key,
 String name,
 String val,
 GamePiece piece,
 BeanShellExpressionConfigurer.Option option)

BeanShellExpressionConfigurer

public BeanShellExpressionConfigurer(String key,
 String name,
 String val,
 GamePiece piece,
 BeanShellExpressionConfigurer.Option option,
 FunctionBuilder builder)

BeanShellExpressionConfigurer

public BeanShellExpressionConfigurer(String key,
 String name,
 String val,
 GamePiece piece,
 BeanShellExpressionConfigurer.Option option,
 boolean displayOnly)

Method Details

strip

protected void strip()

getOption

public BeanShellExpressionConfigurer.Option getOption()

setOption

public void setOption(BeanShellExpressionConfigurer.Option option)

getValueString

public String getValueString()

Overrides:

getValueString in class StringConfigurer

Returns:

a String representation of the Object value

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Overrides:

setValue in class StringConfigurer

requestFocus

public void requestFocus()

Description copied from class: Configurer

Move the cursor to the first input field of this Configurer

Overrides:

requestFocus in class StringConfigurer

setHighlighted

public void setHighlighted(boolean highlighted)

Description copied from class: Configurer

Set the highlighted status of this configurer. It is up to individual Configurers to override this method and implement a suitable visual highlighting scheme Note: Cannot make this abstract as it will break custom code.

Overrides:

setHighlighted in class StringConfigurer

Parameters:

highlighted - New Highlighted status

addFocusListener

public void addFocusListener(FocusListener listener)

Description copied from class: Configurer

Add a FocusListener to the Swing Components that make up this Configurer.

Overrides:

addFocusListener in class StringConfigurer

Parameters:

listener - Focus Listener

removeFocusListener

public void removeFocusListener(FocusListener listener)

Description copied from class: Configurer

Remove a FocusListener from the Swing Components that make up this Configurer.

Overrides:

removeFocusListener in class StringConfigurer

Parameters:

listener - Focus Listener

getTopLevelAncestor

protected Component getTopLevelAncestor()

getControls

public Component getControls()

Description copied from class: Configurer

GUI interface for setting the option in an editing window

Overrides:

getControls in class StringConfigurer

validate

public void validate()

updateParentBuilder

protected void updateParentBuilder()

If we are the child of a FunctionBuilder, notify it we have changed.

doPopup

protected void doPopup()

insertPropertyName

protected void insertPropertyName(String name)

Insert a property name into the expression

Parameters:

name - property name

insertName

protected void insertName(String name)

cleanName

protected String cleanName(String name)

setDetails

protected void setDetails(String error,
 List<String> v,
 List<String> m)

setDetails

protected void setDetails()

getSelectedText

public String getSelectedText()

setSelectedText

public void setSelectedText(String selectedText)

isDisplayOnly

public boolean isDisplayOnly()

setDisplayOnly

public void setDisplayOnly(boolean displayOnly)