Class ListConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.ListConfigurer

All Implemented Interfaces:

PropertyChangeListener, EventListener

Direct Known Subclasses:

DoActionButton.NamedHotkeyListConfigurer

public abstract class ListConfigurer
extends Configurer
implements PropertyChangeListener

Configures a variable-length list of objects

Author:

rkinney

Nested Class Summary

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

Configurer.ContextLevel

Field Summary

Fields

Modifier and Type	Field	Description
protected JPanel	configControls
protected List<Configurer>	configurers
protected JPanel	controls
protected Dimension	fixedSize
protected JPanel	panel

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
ListConfigurer(String key, String name)
ListConfigurer(String key, String name, List<?> val)

Method Summary

Modifier and Type	Method	Description
protected abstract Configurer	buildChildConfigurer()	The objects in the list are specified by the Configurer returned here
boolean	equals(Object obj)
Component	getControls()	GUI interface for setting the option in an editing window
List<Object>	getListValue()
String	getValueString()
int	hashCode()
void	propertyChange(PropertyChangeEvent evt)
void	repack()	Repack the current configurer
void	resize()	Resize the overall Configurer to only show Scroll bars if getting close to full screen height
void	setValue(Object o)	Set the Object value
void	setValue(String s)	Set the Object value from a String
protected void	updateControls()
protected void	updateValue()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

controls

protected JPanel controls

configControls

protected JPanel configControls

panel

protected JPanel panel

fixedSize

protected Dimension fixedSize

configurers

protected List<Configurer> configurers

Constructor Details

ListConfigurer

public ListConfigurer(String key,
 String name)

ListConfigurer

public ListConfigurer(String key,
 String name,
 List<?> 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(String s)

Description copied from class: Configurer

Set the Object value from a String

Specified by:

setValue in class Configurer

updateValue

protected void updateValue()

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

getListValue

public List<Object> getListValue()

buildChildConfigurer

protected abstract Configurer buildChildConfigurer()

The objects in the list are specified by the Configurer returned here

Returns:

objects in the list

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

updateControls

protected void updateControls()

resize

public void resize()

Resize the overall Configurer to only show Scroll bars if getting close to full screen height

repack

public void repack()

Description copied from class: Configurer

Repack the current configurer

Overrides:

repack in class Configurer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object