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:
AutoConfigurable
,Buildable
,Configurable
,PropertyNameSource
,ValidityChecker
,DeckVisitor
,PieceVisitor
,Translatable
,ImageSearchTarget
,SearchTarget
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
Modifier and TypeClassDescriptionstatic class
Deprecated, for removal: This API element is subject to removal in a future version.Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable
AutoConfigurable.Util
-
Field Summary
Modifier and TypeFieldDescriptionstatic String
Deprecated, for removal: This API element is subject to removal in a future version.protected DeckVisitorDispatcher
static String
Deprecated, for removal: This API element is subject to removal in a future version.static String
Deprecated, for removal: This API element is subject to removal in a future version.protected LaunchButton
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclassprotected Map
static String
Deprecated, for removal: This API element is subject to removal in a future version.Fields inherited from class VASSAL.build.AbstractToolbarItem
NAME
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Default behavior adds the button to the module toolbar.Class<?>[]
static String
Returns a Command that moves all pieces so that their centroid is centered on the map.void
removeFrom(Buildable parent)
Default behavior assumes we are removing this from the module toolbarImplementsDeckVisitor
.ImplementsDeckVisitor
.visitStack(Stack s)
ImplementsDeckVisitor
.Methods inherited from class VASSAL.build.AbstractToolbarItem
addLocalImageNames, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, makeLaunchButton, setAttribute, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setTooltipKey
Methods inherited from class VASSAL.build.AbstractConfigurable
add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getPropertyList, 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
-
BUTTON_TEXT
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
ICON
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
HOTKEY
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
TOOLTIP
Deprecated, for removal: This API element is subject to removal in a future version.- See Also:
- Constant Field Values
-
launch
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclass -
map
-
dispatcher
-
-
Constructor Details
-
PieceRecenterer
public PieceRecenterer()
-
-
Method Details
-
recenter
Returns a Command that moves all pieces so that their centroid is centered on the map. -
visitDeck
ImplementsDeckVisitor
. Returns Boolean.TRUE if the piece should be moved- Specified by:
visitDeck
in interfaceDeckVisitor
-
visitDefault
ImplementsDeckVisitor
. Returns Boolean.TRUE if the piece should be moved- Specified by:
visitDefault
in interfacePieceVisitor
-
visitStack
ImplementsDeckVisitor
. Returns Boolean.TRUE if the piece should be moved- Specified by:
visitStack
in interfacePieceVisitor
-
getConfigureTypeName
-
addTo
Description copied from class:AbstractToolbarItem
Default behavior adds the button to the module toolbar.- Specified by:
addTo
in interfaceBuildable
- Overrides:
addTo
in classAbstractToolbarItem
- Parameters:
parent
- parent Buildable to add this component to as a subcomponent.
-
getAllowableConfigureComponents
- Specified by:
getAllowableConfigureComponents
in interfaceConfigurable
- 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
- Specified by:
getHelpFile
in interfaceConfigurable
- Returns:
- a HelpFile describing how to use and configure * this component
-
removeFrom
Description copied from class:AbstractToolbarItem
Default behavior assumes we are removing this from the module toolbar- Specified by:
removeFrom
in interfaceConfigurable
- Overrides:
removeFrom
in classAbstractToolbarItem
- Parameters:
parent
- parent
-