Class StringArrayConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.StringArrayConfigurer

All Implemented Interfaces:

ConfigurableList

Direct Known Subclasses:

FormattedStringArrayConfigurer

public class StringArrayConfigurer
extends Configurer
implements ConfigurableList

A Configurer that returns an array of Strings

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 JList<String>	list	Deprecated, for removal: This API element is subject to removal in a future version.
protected int	maxRows	Deprecated, for removal: This API element is subject to removal in a future version.
protected int	minRows	Deprecated, for removal: This API element is subject to removal in a future version.
protected DefaultListModel<String>	model	Deprecated, for removal: This API element is subject to removal in a future version.
protected JPanel	panel
protected JTextField	textField	Deprecated, for removal: This API element is subject to removal in a future version.

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

Fields inherited from interface ConfigurableList

DEFAULT_ICON_SIZE

Modifier and Type	Field	Description
static final int	DEFAULT_ICON_SIZE	The Default Icon Size to use for all Configurable List related button icons

Constructor Summary

Constructors

Constructor	Description
StringArrayConfigurer(Object val)
StringArrayConfigurer(String key, String name)
StringArrayConfigurer(String key, String name, Object val)

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.
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
protected void	addTextActionListener(ActionListener a)	Deprecated, for removal: This API element is subject to removal in a future version.
void	addValue(String s)	Deprecated, for removal: This API element is subject to removal in a future version.
static String	arrayToString(String[] s)
Configurer	buildChildConfigurer(Object value)
void	deleteEntry(ConfigurableListEntry entry)	Remove the specified entry from the list.
void	entryChanged(ConfigurableListEntry entry)	An entry has had it's value changed
Component	getControls()	GUI interface for setting the option in an editing window
List<VASSAL.configure.StringArrayConfigurer.StringEntry>	getEntries()
JComponent	getListController()	Return the ListController associated with this Configurable List
DefaultListModel<String>	getModel()	Deprecated, for removal: This API element is subject to removal in a future version.
int	getSelectedEntryIndex()	Return the index of the currently selected entry
String[]	getStringArray()
protected Component	getTextComponent()	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	getTextValue()	Deprecated, for removal: This API element is subject to removal in a future version.
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
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
void	removeValue(String s)
void	repack()	Repack the current configurer
void	selectEntry(ConfigurableListEntry entry)	Set the selection to the specified list entry.
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	setHighlighted(boolean highlighted)	Don't do anything special when highlighting, but deslect currently selected entry when unhighlighting
void	setSelectedEntryIndex(int index)	Set the currently selected entry
protected void	setTextValue(String s)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String
static String[]	stringToArray(String s)
protected void	updateModel()	Deprecated, for removal: This API element is subject to removal in a future version.
void	updateViewable(int rows)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class Configurer

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

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(Component controls)	Repack a dialog or window
void	requestFocus()	Move the cursor to the first input field of this Configurer
void	setContext(Buildable context)
void	setContext(Configurable context)
void	setContextLevel(Configurer.ContextLevel contextLevel)
void	setEnabled(boolean enabled)	Enable or Disable the action of this configurer/
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	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setName(String s)

Methods inherited from class Object

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

Field Details

list

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected JList<String> list

Deprecated, for removal: This API element is subject to removal in a future version.

model

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected DefaultListModel<String> model

Deprecated, for removal: This API element is subject to removal in a future version.

textField

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected JTextField textField

Deprecated, for removal: This API element is subject to removal in a future version.

minRows

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected int minRows

Deprecated, for removal: This API element is subject to removal in a future version.

maxRows

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected int maxRows

Deprecated, for removal: This API element is subject to removal in a future version.

panel

protected JPanel panel

Constructor Details

StringArrayConfigurer

public StringArrayConfigurer(String key,
 String name,
 Object val)

StringArrayConfigurer

public StringArrayConfigurer(Object val)

StringArrayConfigurer

public StringArrayConfigurer(String key,
 String name)

Method Details

getModel

@Deprecated(since="2020-11-12",
            forRemoval=true)
public DefaultListModel<String> getModel()

Deprecated, for removal: This API element is subject to removal in a future version.

addValue

@Deprecated(since="2020-11-12",
            forRemoval=true)
public void addValue(String s)

Deprecated, for removal: This API element is subject to removal in a future version.

removeValue

public void removeValue(String s)

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

updateViewable

@Deprecated(since="2020-11-12",
            forRemoval=true)
public void updateViewable(int rows)

Deprecated, for removal: This API element is subject to removal in a future version.

getTextComponent

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected Component getTextComponent()

Deprecated, for removal: This API element is subject to removal in a future version.

getTextValue

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected String getTextValue()

Deprecated, for removal: This API element is subject to removal in a future version.

setTextValue

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected void setTextValue(String s)

Deprecated, for removal: This API element is subject to removal in a future version.

addTextActionListener

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected void addTextActionListener(ActionListener a)

Deprecated, for removal: This API element is subject to removal in a future version.

getStringArray

public String[] getStringArray()

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

arrayToString

public static String arrayToString(String[] s)

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

stringToArray

public static String[] stringToArray(String s)

updateModel

@Deprecated(since="2020-11-12",
            forRemoval=true)
protected void updateModel()

Deprecated, for removal: This API element is subject to removal in a future version.

buildChildConfigurer

public Configurer buildChildConfigurer(Object value)

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.

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

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

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

repack

public void repack()

Description copied from class: Configurer

Repack the current configurer

Specified by:

repack in interface ConfigurableList

Overrides:

repack in class Configurer

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

setHighlighted

public void setHighlighted(boolean highlighted)

Don't do anything special when highlighting, but deslect currently selected entry when unhighlighting

Overrides:

setHighlighted in class Configurer

Parameters:

highlighted - New Highlighted status

getEntries

public List<VASSAL.configure.StringArrayConfigurer.StringEntry> getEntries()

setContext

public void setContext(AbstractBuildable context)

Description copied from class: Configurer

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. Don't let the AutoConfigurer over-write this

Overrides:

setContext in class Configurer

Parameters:

context - Owning Configurable