Package VASSAL.configure

Class ParameterListConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.ParameterListConfigurer

All Implemented Interfaces:

ConfigurableList

public class ParameterListConfigurer
extends Configurer
implements ConfigurableList

Configurer for a List of Parameters The object stored in the value of the Configurer is a List

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

Fields inherited from interface VASSAL.configure.ConfigurableList

DEFAULT_ICON_SIZE

Constructor Summary

Constructors

Constructor	Description
ParameterListConfigurer(String key, String name)
ParameterListConfigurer(String key, String name, List<Parameter> params)
ParameterListConfigurer(List<Parameter> params)

Method Summary

Modifier and Type	Method	Description
void	addEntry()	Add a new list entry after the currently selected entry, or at the bottom of the list if no entries selected.
static List<Parameter>	decode(String s)
void	deleteEntry(ConfigurableListEntry entry)	Remove the specified entry from the list.
static String	encode(List<Parameter> parameters)
void	entryChanged(ConfigurableListEntry entry)	An entry has had it's value changed
Component	getControls()	GUI interface for setting the option in an editing window
JComponent	getListController()	Return the ListController associated with this Configurable List
List<Object>	getListValue()
List<Parameter>	getParameterList()
List<Parameter>	getParameterListValue()
List<String>	getParameterNames()	Return a list of the Parameter names in the current configurer value
List<String>	getParameterValues()	Return a list of the Parameter values in the current configurer value
int	getSelectedEntryIndex()	Return the index of the currently selected entry
String	getValueString()
void	moveEntryDown()	Move the currently selected list entry down one position The moved entry should retain the selection
void	moveEntryUp()	Move the currently selected list entry up one position The moved entry should retain the selection
protected void	rebuildControls()
void	repack()	Repack the current configurer
void	selectEntry(ConfigurableListEntry entry)	Set the selection to the specified list entry.
void	setSelectedEntryIndex(int index)	Set the currently selected entry
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String

Methods inherited from class VASSAL.configure.Configurer

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

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterListConfigurer

public ParameterListConfigurer(String key,
 String name,
 List<Parameter> params)

ParameterListConfigurer

public ParameterListConfigurer(String key,
 String name)

ParameterListConfigurer

public ParameterListConfigurer(List<Parameter> params)

Method Details

encode

public static String encode(List<Parameter> parameters)

decode

public static List<Parameter> decode(String s)

getParameterNames

public List<String> getParameterNames()

Return a list of the Parameter names in the current configurer value

Returns:

Parameter names

getParameterList

public List<Parameter> getParameterList()

getParameterValues

public List<String> getParameterValues()

Return a list of the Parameter values in the current configurer value

Returns:

Parameter values

moveEntryUp

public void moveEntryUp()

Description copied from interface: ConfigurableList

Move the currently selected list entry up one position The moved entry should retain the selection

Specified by:

moveEntryUp in interface ConfigurableList

moveEntryDown

public void moveEntryDown()

Description copied from interface: ConfigurableList

Move the currently selected list entry down one position The moved entry should retain the selection

Specified by:

moveEntryDown in interface ConfigurableList

addEntry

public void addEntry()

Description copied from interface: ConfigurableList

Add a new list entry after the currently selected entry, or at the bottom of the list if no entries selected. The new entry should be selected.

Specified by:

addEntry in interface ConfigurableList

deleteEntry

public void deleteEntry(ConfigurableListEntry entry)

Description copied from interface: ConfigurableList

Remove the specified entry from the list. The entry following the removed entry should be selected, or the last entry in the list if the deleted entry was last.

Specified by:

deleteEntry in interface ConfigurableList

Parameters:

entry - Entry to delete.

selectEntry

public void selectEntry(ConfigurableListEntry entry)

Description copied from interface: ConfigurableList

Set the selection to the specified list entry.

Specified by:

selectEntry in interface ConfigurableList

Parameters:

entry - Entry to select

setSelectedEntryIndex

public void setSelectedEntryIndex(int index)

Description copied from interface: ConfigurableList

Set the currently selected entry

Specified by:

setSelectedEntryIndex in interface ConfigurableList

Parameters:

index - Index of currently selected entry

getSelectedEntryIndex

public int getSelectedEntryIndex()

Description copied from interface: ConfigurableList

Return the index of the currently selected entry

Specified by:

getSelectedEntryIndex in interface ConfigurableList

Returns:

currently selected entry index

entryChanged

public void entryChanged(ConfigurableListEntry entry)

Description copied from interface: ConfigurableList

An entry has had it's value changed

Specified by:

entryChanged in interface ConfigurableList

Parameters:

entry - Changed Entry

getListController

public JComponent getListController()

Description copied from interface: ConfigurableList

Return the ListController associated with this Configurable List

Specified by:

getListController in interface ConfigurableList

Returns:

List Controller

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

getListValue

public List<Object> getListValue()

getParameterListValue

public List<Parameter> getParameterListValue()

setValue

public void setValue(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

setValue

public void setValue(Object o)

Description copied from class: Configurer

Set the Object value

Overrides:

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

rebuildControls

protected void rebuildControls()

repack

public void repack()

Description copied from class: Configurer

Repack the current configurer

Specified by:

repack in interface ConfigurableList

Overrides:

repack in class Configurer