Class ColorConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.ColorConfigurer

public class ColorConfigurer
extends Configurer

Configurer for Color values.

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.configure.Configurer

Configurer.ContextLevel

Field Summary

Fields inherited from class VASSAL.configure.Configurer

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

Constructor Summary

Constructors

Constructor	Description
ColorConfigurer(Color val)
ColorConfigurer(String key, String name)
ColorConfigurer(String key, String name, Color val)

Method Summary

Modifier and Type	Method	Description
static String	colorToString(Color c)
Component	getControls()	GUI interface for setting the option in an editing window
String	getValueString()
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String
static Color	stringToColor(String s)

Methods inherited from class VASSAL.configure.Configurer

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

Methods inherited from class java.lang.Object

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

Constructor Details

ColorConfigurer

public ColorConfigurer(String key,
 String name)

ColorConfigurer

public ColorConfigurer(String key,
 String name,
 Color val)

ColorConfigurer

public ColorConfigurer(Color val)

Method Details

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

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

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

colorToString

public static String colorToString(Color c)

stringToColor

public static Color stringToColor(String s)

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