Class LayoutConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.build.module.gamepieceimage.LayoutConfigurer

public class LayoutConfigurer
extends Configurer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	LayoutConfigurer.ItemPanel
protected static class	LayoutConfigurer.NewIntConfigurer

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 static final String	ADD_IMAGE
protected static final String	ADD_SHAPE
protected static final String	ADD_SYMBOL
protected static final String	ADD_TEXT
protected static final String	ADD_TEXTBOX
protected int	currentItem
protected Component	currentItemControls
protected StringConfigurer	defName
protected static final String	DOWN
protected Box	filler
protected LayoutConfigurer.NewIntConfigurer	height
protected JPanel	itemConfigPanel
protected LayoutConfigurer.ItemPanel	itemPanel
protected GamePieceLayout	layout
protected static final int	NO_CURRENT_ITEM
protected JPanel	panel
protected static final String	REMOVE
protected static final String	UP
protected Box	visBox
protected JLabel	visLabel
protected Visualizer	visualizer
protected LayoutConfigurer.NewIntConfigurer	width

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LayoutConfigurer()
protected	LayoutConfigurer(String key, String name, GamePieceLayout def)

Method Summary

Modifier and Type	Method	Description
Component	getControls()	GUI interface for setting the option in an editing window
Object	getValue()	The Object value May be null if the Object has not been initialized
String	getValueString()
protected void	repack()	Repack the current configurer
void	setValue(String s)	Set the Object value from a String

Methods inherited from class Configurer

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

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
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.
void	initCustomControls(JDialog d, Configurable target)	Initialize any custom controls / keystrokes
boolean	isFrozen()
boolean	isHighlighted()	Return the current highlighted status
boolean	isPieceContext()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
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(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	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	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
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)
void	setValue(Object o)	Set the Object value

Methods inherited from class Object

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

Field Details

ADD_SYMBOL

protected static final String ADD_SYMBOL

ADD_IMAGE

protected static final String ADD_IMAGE

ADD_TEXT

protected static final String ADD_TEXT

ADD_TEXTBOX

protected static final String ADD_TEXTBOX

ADD_SHAPE

protected static final String ADD_SHAPE

REMOVE

protected static final String REMOVE

UP

protected static final String UP

DOWN

protected static final String DOWN

NO_CURRENT_ITEM

protected static final int NO_CURRENT_ITEM

See Also:

• Constant Field Values

panel

protected JPanel panel

itemPanel

protected LayoutConfigurer.ItemPanel itemPanel

itemConfigPanel

protected JPanel itemConfigPanel

currentItemControls

protected Component currentItemControls

currentItem

protected int currentItem

visBox

protected Box visBox

visualizer

protected Visualizer visualizer

visLabel

protected JLabel visLabel

filler

protected Box filler

layout

protected GamePieceLayout layout

defName

protected StringConfigurer defName

height

protected LayoutConfigurer.NewIntConfigurer height

width

protected LayoutConfigurer.NewIntConfigurer width

Constructor Details

LayoutConfigurer

protected LayoutConfigurer()

LayoutConfigurer

protected LayoutConfigurer(String key,
 String name,
 GamePieceLayout def)

Method Details

getValue

public Object getValue()

Description copied from class: Configurer

The Object value May be null if the Object has not been initialized

Overrides:

getValue 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

getValueString

public String getValueString()

Specified by:

getValueString in class Configurer

Returns:

a String representation of the Object value

repack

protected void repack()

Description copied from class: Configurer

Repack the current configurer

Overrides:

repack in class Configurer