Class BooleanConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.BooleanConfigurer

public class BooleanConfigurer
extends Configurer

Configurer for Boolean values

Nested Class Summary

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 JPanel	p

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
BooleanConfigurer(boolean val)	Create a new-style labeless configurer
BooleanConfigurer(Boolean val)	Create a new-style labeless configurer
BooleanConfigurer(String key, String name)	Create an old-style configurer with inbuilt label
BooleanConfigurer(String key, String name, boolean val)	Create an old-style configurer with inbuilt label
BooleanConfigurer(String key, String name, Boolean val)	Create an old-style configurer with inbuilt label

Method Summary

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
Boolean	booleanValue()
Component	getControls()	GUI interface for setting the option in an editing window
boolean	getValueBoolean()
String	getValueString()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
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	setName(String s)
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String

Methods inherited from class Configurer

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

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	requestFocus()	Move the cursor to the first input field of this Configurer
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	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
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.

Methods inherited from class Object

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

Field Details

p

protected JPanel p

Constructor Details

BooleanConfigurer

public BooleanConfigurer(String key,
 String name,
 Boolean val)

Create an old-style configurer with inbuilt label

Parameters:

key - Configurer key

name - Label text

val - Initial value

BooleanConfigurer

public BooleanConfigurer(String key,
 String name,
 boolean val)

Create an old-style configurer with inbuilt label

Parameters:

key - Configurer key

name - Label text

val - Initial value

BooleanConfigurer

public BooleanConfigurer(String key,
 String name)

Create an old-style configurer with inbuilt label

Parameters:

key - Configurer key

name - Label text

BooleanConfigurer

public BooleanConfigurer(Boolean val)

Create a new-style labeless configurer

Parameters:

val - Initial value

BooleanConfigurer

public BooleanConfigurer(boolean val)

Create a new-style labeless configurer

Parameters:

val - Initial value

Method Details

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

getValueBoolean

public boolean getValueBoolean()

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

setValue in class Configurer

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

setName

public void setName(String s)

Overrides:

setName in class Configurer

getControls

public Component getControls()

Description copied from class: Configurer

GUI interface for setting the option in an editing window

Specified by:

getControls in class Configurer

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 Configurer

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 Configurer

Parameters:

listener - Focus Listener

booleanValue

public Boolean booleanValue()

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: Configurer

Enable or Disable the action of this configurer/

Overrides:

setEnabled in class Configurer

Parameters:

enabled -

setLabelVisible

public void setLabelVisible(boolean visible)

Description copied from class: Configurer

Show/Hide the internal label maintained by this Configurer. It is up to individual Configurers to track and hide the label (if they can). This method is currently only utilized by the Preference configs PrefsEditor.addOption(String, Configurer) to extract an existing label in a configurer, display correctly aligned and suppress the original label. This keeps compatibility with custom module code setting up preferences. This method only needs to be implemented in Configurers that are added as preferences.

Overrides:

setLabelVisible in class Configurer

Parameters:

visible - Hide label if true