Package VASSAL.build.module.map

Class Scroller

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.map.Scroller

All Implemented Interfaces:

KeyListener, EventListener, Buildable, PropertyNameSource, ValidityChecker, Auditable, ImageSearchTarget

public class Scroller
extends AbstractBuildable
implements KeyListener

This component listens to key events on a Map window and scrolls the map. Depending on the USE_ARROWS attribute, will use number keypad or arrow keys, or will offer a preferences setting for the user to choose

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALWAYS
static final String	NEVER
static final String	PROMPT
static final String	USE_ARROWS	The attribute name for whether to use arrow keys instead of number keypad.
protected String	usingArrows
protected int	xStep
protected int	yStep

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
Scroller()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Add a Buildable object to this object
void	addTo(Buildable parent)	Adds this component to its parent.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String name)
boolean	isMandatory()	Is this component a reqired component within its parent?
boolean	isUnique()	Does this component need to be unique within it's parent?
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.

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

isMovable

Field Details

USE_ARROWS

public static final String USE_ARROWS

The attribute name for whether to use arrow keys instead of number keypad. Should be one of ALWAYS, NEVER, or PROMPT

See Also:

• Constant Field Values

ALWAYS

public static final String ALWAYS

See Also:

• Constant Field Values

NEVER

public static final String NEVER

See Also:

• Constant Field Values

PROMPT

public static final String PROMPT

See Also:

• Constant Field Values

usingArrows

protected String usingArrows

xStep

protected int xStep

yStep

protected int yStep

Constructor Details

Scroller

public Scroller()

Method Details

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 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.

Specified by:

addTo in interface Buildable

Parameters:

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

add

public void add(Buildable b)

Description copied from class: AbstractBuildable

Add a Buildable object to this object

Specified by:

add in interface Buildable

Overrides:

add in class AbstractBuildable

Parameters:

b - Child to attach to this buildable as a subcomponent

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 class AbstractBuildable

Returns:

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

setAttribute

public void setAttribute(String name,
 Object value)

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 class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

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

getAttributeValueString

public String getAttributeValueString(String name)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

name - 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.

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

isMandatory

public boolean isMandatory()

Description copied from interface: Buildable

Is this component a reqired component within its parent?

Specified by:

isMandatory in interface Buildable

Returns:

true if component is mandatory

isUnique

public boolean isUnique()

Description copied from interface: Buildable

Does this component need to be unique within it's parent?

Specified by:

isUnique in interface Buildable

Returns: