Package VASSAL.configure
Class BooleanConfigurer
java.lang.Object
VASSAL.configure.Configurer
VASSAL.configure.BooleanConfigurer
Configurer for Boolean values
-
Field Summary
Fields inherited from class VASSAL.configure.Configurer
changeSupport, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value
-
Constructor Summary
ConstructorDescriptionBooleanConfigurer(boolean val)
Create a new-style labeless configurerBooleanConfigurer(Boolean val)
Create a new-style labeless configurerBooleanConfigurer(String key, String name)
Create an old-style configurer with inbuilt labelBooleanConfigurer(String key, String name, boolean val)
Create an old-style configurer with inbuilt labelBooleanConfigurer(String key, String name, Boolean val)
Create an old-style configurer with inbuilt label -
Method Summary
Modifier and TypeMethodDescriptionGUI interface for setting the option in an editing windowboolean
void
setLabelVisibile(boolean visible)
Show/Hide the internal label maintained by this Configurer.void
void
Set the Object valuevoid
Set the Object value from a StringMethods inherited from class VASSAL.configure.Configurer
addFocusListener, addPropertyChangeListener, fireUpdate, getHint, getKey, getName, getScreenSize, getValue, isFrozen, isHighlighted, removeFocusListener, removePropertyChangeListener, repack, repack, requestFocus, setFrozen, setHighlighted, setHint, setHintKey
-
Field Details
-
p
-
-
Constructor Details
-
BooleanConfigurer
Create an old-style configurer with inbuilt label- Parameters:
key
- Configurer keyname
- Label textval
- Initial value
-
BooleanConfigurer
Create an old-style configurer with inbuilt label- Parameters:
key
- Configurer keyname
- Label textval
- Initial value
-
BooleanConfigurer
Create an old-style configurer with inbuilt label- Parameters:
key
- Configurer keyname
- Label text
-
BooleanConfigurer
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
- Specified by:
getValueString
in classConfigurer
- Returns:
- a String representation of the Object value
-
getValueBoolean
public boolean getValueBoolean() -
setValue
Description copied from class:Configurer
Set the Object value- Overrides:
setValue
in classConfigurer
-
setValue
Description copied from class:Configurer
Set the Object value from a String- Specified by:
setValue
in classConfigurer
-
setName
- Overrides:
setName
in classConfigurer
-
getControls
Description copied from class:Configurer
GUI interface for setting the option in an editing window- Specified by:
getControls
in classConfigurer
-
booleanValue
-
setLabelVisibile
public void setLabelVisibile(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 configsPrefsEditor.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:
setLabelVisibile
in classConfigurer
- Parameters:
visible
- Hide label if true
-