Package VASSAL.build.module.map

Class Zoomer

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.Zoomer

All Implemented Interfaces:

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

public class Zoomer
extends AbstractConfigurable
implements GameComponent

Controls the zooming in/out of a Map window.

Author:

Joel Uckelman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Zoomer.InIconConfig
static class	Zoomer.LevelConfig
protected static class	Zoomer.LevelConfigurer	The Configurer for ZOOM_LEVELS and ZOOM_START.
static class	Zoomer.OutIconConfig
static class	Zoomer.PickIconConfig
protected static class	Zoomer.State	Stores the state information for the Zoomer.
protected class	Zoomer.ZoomDialog	The dialog for setting custom zoom levels.
protected class	Zoomer.ZoomMenu	The menu which displays zoom levels.

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	defaultInitialZoomLevel
protected static double[]	defaultZoomLevels
protected static String	IN_BUTTON_TEXT
protected static String	IN_DEFAULT_ICON
protected static String	IN_ICON_NAME
protected static String	IN_TOOLTIP
protected MouseWheelListener	listener
protected Map	map
protected int	maxZoom	Deprecated, for removal: This API element is subject to removal in a future version.
protected static String	OUT_BUTTON_TEXT
protected static String	OUT_DEFAULT_ICON
protected static String	OUT_ICON_NAME
protected static String	OUT_TOOLTIP
protected static String	PICK_BUTTON_TEXT
protected static String	PICK_DEFAULT_ICON
protected static String	PICK_ICON_NAME
protected static String	PICK_TOOLTIP
protected Zoomer.State	state
protected double	zoom	Deprecated, for removal: This API element is subject to removal in a future version.
protected static String	ZOOM_IN
protected static String	ZOOM_LEVELS
protected static String	ZOOM_OUT
protected static String	ZOOM_PICK
protected static String	ZOOM_START
protected double[]	zoomFactor	Deprecated, for removal: This API element is subject to removal in a future version.
protected LaunchButton	zoomInButton
protected int	zoomLevel	Deprecated, for removal: This API element is subject to removal in a future version.
protected Zoomer.ZoomMenu	zoomMenu
protected LaunchButton	zoomOutButton
protected LaunchButton	zoomPickButton
protected int	zoomStart	Deprecated, for removal: This API element is subject to removal in a future version.

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

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Add our icons to the list of referenced images
void	addTo(Buildable b)	Adds this component to its parent.
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
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
protected Point	getMapCenter()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
double	getZoomFactor()
protected void	init()
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	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
void	setZoomFactor(double z)
void	setZoomLevel(int l)
protected void	updateZoomer(Point center)
void	zoomIn()
void	zoomOut()

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

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

Methods inherited from class VASSAL.search.AbstractImageFinder

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

build, getBuildElement

Field Details

map

protected Map map

zoom

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected double zoom

Deprecated, for removal: This API element is subject to removal in a future version.

zoomLevel

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected int zoomLevel

Deprecated, for removal: This API element is subject to removal in a future version.

zoomStart

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected int zoomStart

Deprecated, for removal: This API element is subject to removal in a future version.

zoomFactor

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected double[] zoomFactor

Deprecated, for removal: This API element is subject to removal in a future version.

maxZoom

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected int maxZoom

Deprecated, for removal: This API element is subject to removal in a future version.

zoomInButton

protected LaunchButton zoomInButton

zoomPickButton

protected LaunchButton zoomPickButton

zoomOutButton

protected LaunchButton zoomOutButton

zoomMenu

protected Zoomer.ZoomMenu zoomMenu

listener

protected MouseWheelListener listener

state

protected Zoomer.State state

defaultZoomLevels

protected static final double[] defaultZoomLevels

defaultInitialZoomLevel

protected static final int defaultInitialZoomLevel

See Also:

Constant Field Values

ZOOM_START

protected static final String ZOOM_START

See Also:

Constant Field Values

ZOOM_LEVELS

protected static final String ZOOM_LEVELS

See Also:

Constant Field Values

ZOOM_IN

protected static final String ZOOM_IN

See Also:

Constant Field Values

IN_TOOLTIP

protected static final String IN_TOOLTIP

See Also:

Constant Field Values

IN_BUTTON_TEXT

protected static final String IN_BUTTON_TEXT

See Also:

Constant Field Values

IN_ICON_NAME

protected static final String IN_ICON_NAME

See Also:

Constant Field Values

IN_DEFAULT_ICON

protected static final String IN_DEFAULT_ICON

See Also:

Constant Field Values

ZOOM_PICK

protected static final String ZOOM_PICK

See Also:

Constant Field Values

PICK_TOOLTIP

protected static final String PICK_TOOLTIP

See Also:

Constant Field Values

PICK_BUTTON_TEXT

protected static final String PICK_BUTTON_TEXT

See Also:

Constant Field Values

PICK_ICON_NAME

protected static final String PICK_ICON_NAME

See Also:

Constant Field Values

PICK_DEFAULT_ICON

protected static final String PICK_DEFAULT_ICON

See Also:

Constant Field Values

ZOOM_OUT

protected static final String ZOOM_OUT

See Also:

Constant Field Values

OUT_TOOLTIP

protected static final String OUT_TOOLTIP

See Also:

Constant Field Values

OUT_BUTTON_TEXT

protected static final String OUT_BUTTON_TEXT

See Also:

Constant Field Values

OUT_ICON_NAME

protected static final String OUT_ICON_NAME

See Also:

Constant Field Values

OUT_DEFAULT_ICON

protected static final String OUT_DEFAULT_ICON

See Also:

Constant Field Values

Constructor Details

Zoomer

public Zoomer()

Method Details

init

protected void init()

getConfigureTypeName

public static String getConfigureTypeName()

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.

Specified by:

addTo in interface Buildable

Parameters:

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

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

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getZoomFactor

public double getZoomFactor()

getMapCenter

protected Point getMapCenter()

updateZoomer

protected void updateZoomer(Point center)

setZoomLevel

public void setZoomLevel(int l)

setZoomFactor

public void setZoomFactor(double z)

zoomIn

public void zoomIn()

zoomOut

public void zoomOut()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class AbstractConfigurable

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractConfigurable

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractConfigurable

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Add our icons to the list of referenced images

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to