Package VASSAL.build.module.map

Class PieceRecenterer

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.PieceRecenterer

All Implemented Interfaces:

PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, ValidityChecker, DeckVisitor, PieceVisitor, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class PieceRecenterer
extends AbstractToolbarItem
implements DeckVisitor

Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the map

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PieceRecenterer.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractToolbarItem.IconConfig instead.

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_TEXT	Deprecated, for removal: This API element is subject to removal in a future version.
protected DeckVisitorDispatcher	dispatcher
static final String	HOTKEY	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
protected Map	map
static final String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class VASSAL.build.AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, NAME, property, PROPERTY_GATE, propertyGate, showDisabledOptions

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

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Default behavior adds the button to the parent component
Class<?>[]	getAllowableConfigureComponents()
static String	getConfigureTypeName()
HelpFile	getHelpFile()
Command	recenter(Map map)	Returns a Command that moves all pieces so that their centroid is centered on the map.
void	removeFrom(Buildable parent)	Remove from our parent
Object	visitDeck(Deck d)	Implements DeckVisitor.
Object	visitDefault(GamePiece p)	Implements DeckVisitor.
Object	visitStack(Stack s)	Implements DeckVisitor.

Methods inherited from class VASSAL.build.AbstractToolbarItem

addLocalImageNames, addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, getNameKey, getPropertyList, getRestoreCommand, isShowDisabledOptions, makeLaunchButton, propertyChange, removePropertyGateListener, setAttribute, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey, setup

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, 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

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

BUTTON_TEXT

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_TEXT

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

See Also:

• Constant Field Values

ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String ICON

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

See Also:

• Constant Field Values

HOTKEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String HOTKEY

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

See Also:

• Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

• Constant Field Values

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

map

protected Map map

dispatcher

protected DeckVisitorDispatcher dispatcher

Constructor Details

PieceRecenterer

public PieceRecenterer()

Method Details

recenter

public Command recenter(Map map)

Returns a Command that moves all pieces so that their centroid is centered on the map.

visitDeck

public Object visitDeck(Deck d)

Implements DeckVisitor. Returns Boolean.TRUE if the piece should be moved

Specified by:

visitDeck in interface DeckVisitor

visitDefault

public Object visitDefault(GamePiece p)

Implements DeckVisitor. Returns Boolean.TRUE if the piece should be moved

Specified by:

visitDefault in interface PieceVisitor

visitStack

public Object visitStack(Stack s)

Implements DeckVisitor. Returns Boolean.TRUE if the piece should be moved

Specified by:

visitStack in interface PieceVisitor

getConfigureTypeName

public static String getConfigureTypeName()

addTo

public void addTo(Buildable parent)

Description copied from class: AbstractToolbarItem

Default behavior adds the button to the parent component

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

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.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

parent - parent