VASSAL.build.module.map.LayeredPieceCollection

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class LayeredPieceCollection
extends AbstractConfigurable

Defines PieceCollection in which pieces are assigned to an arbitrary number of layers according to a property setting

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`LayeredPieceCollection.Collection`	The PieceCollection class used by the map to which a LayeredPieceCollection has been added

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`protected LayeredPieceCollection.Collection`	`collection`
`static String`	`LAYER_ORDER`
`protected Map`	`map`
`static String`	`PROPERTY_NAME`
`protected TemporaryToolBar`	`tempToolBar`

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor Description

LayeredPieceCollection()

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable parent)`	Adds this component to its parent.
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String key)`	Return a String representation of the attribute with the given name.
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`Map`	`getMap()`
`CompoundPieceCollection`	`getPieceCollection()`
`JToolBar`	`getToolBar()`
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details
- PROPERTY_NAME
  
  public static final String PROPERTY_NAME
  
  See Also:
  
  Constant Field Values
- LAYER_ORDER
  
  public static final String LAYER_ORDER
  
  See Also:
  
  Constant Field Values
- collection
  
  protected LayeredPieceCollection.Collection collection
- map
  
  protected Map map
- tempToolBar
  
  protected TemporaryToolBar tempToolBar
Constructor Details
- LayeredPieceCollection
  
  public LayeredPieceCollection()
Method Details
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from class: AbstractConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets an attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- addTo
  
  public void addTo(Buildable parent)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.
- getToolBar
  
  public JToolBar getToolBar()
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
- getMap
  
  public Map getMap()
- getPieceCollection
  
  public CompoundPieceCollection getPieceCollection()

Class LayeredPieceCollection