Class ZoneHighlight

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.boardPicker.board.mapgrid.ZoneHighlight

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class ZoneHighlight
extends AbstractConfigurable

A Class that defines a method of highlighting the a zone in a multi-zoned grid.

Author:

Brent Easton

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZoneHighlight.Coverage
static class	ZoneHighlight.OpacityConfig
class	ZoneHighlight.PercentageConfigurer
static class	ZoneHighlight.Style

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	color
static final String	COLOR
protected String	coverage
static final String	COVERAGE
static final String	COVERAGE_BORDER
static final String	COVERAGE_FULL
static final String	IMAGE
protected String	imageName
static final String	NAME
protected int	opacity
static final String	OPACITY
protected TexturePaint	paint
protected SourceOp	srcOp
protected String	style
static final String	STYLE
static final String	STYLE_CROSS
static final String	STYLE_IMAGE
static final String	STYLE_PLAIN
static final String	STYLE_STRIPES
protected int	width
static final String	WIDTH

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
ZoneHighlight()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
void	draw(Graphics2D g2d, Shape s, double scale)
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Color	getColor()
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getName()
protected Paint	getPaint()
void	removeFrom(Buildable b)	Remove this component from its parent
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	setOpacity(int o)

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

COLOR

public static final String COLOR

See Also:

• Constant Field Values

COVERAGE

public static final String COVERAGE

See Also:

• Constant Field Values

WIDTH

public static final String WIDTH

See Also:

• Constant Field Values

STYLE

public static final String STYLE

See Also:

• Constant Field Values

IMAGE

public static final String IMAGE

See Also:

• Constant Field Values

OPACITY

public static final String OPACITY

See Also:

• Constant Field Values

COVERAGE_FULL

public static final String COVERAGE_FULL

See Also:

• Constant Field Values

COVERAGE_BORDER

public static final String COVERAGE_BORDER

See Also:

• Constant Field Values

STYLE_PLAIN

public static final String STYLE_PLAIN

See Also:

• Constant Field Values

STYLE_STRIPES

public static final String STYLE_STRIPES

See Also:

• Constant Field Values

STYLE_CROSS

public static final String STYLE_CROSS

See Also:

• Constant Field Values

STYLE_IMAGE

public static final String STYLE_IMAGE

See Also:

• Constant Field Values

color

protected Color color

coverage

protected String coverage

width

protected int width

style

protected String style

imageName

protected String imageName

srcOp

protected SourceOp srcOp

opacity

protected int opacity

paint

protected TexturePaint paint

Constructor Details

ZoneHighlight

public ZoneHighlight()

Method Details

draw

public void draw(Graphics2D g2d,
 Shape s,
 double scale)

getPaint

protected Paint getPaint()

getName

public String getName()

getColor

public Color getColor()

setOpacity

public void setOpacity(int o)

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Parameters:

b - parent Buildable to add this component to as a subcomponent.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

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()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object val)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) 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()

val - 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 can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Returns:

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 Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.