Class ImageSaver

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.map.ImageSaver

All Implemented Interfaces:

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

public class ImageSaver
extends AbstractToolbarItem

This allows the user to capture a snapshot of the entire map into a PNG file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageSaver.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 AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

Modifier and Type	Class	Description
static class	AbstractToolbarItem.FormattedStringConfig

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BUTTON_TEXT
protected static final String	DEFAULT_ICON
protected static ProgressDialog	dialog
protected static final String	HOTKEY
protected static final String	ICON_NAME
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
protected boolean	promptToSplit
protected static final String	TOOLTIP

Fields inherited from class AbstractToolbarItem

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

Modifier and Type	Field	Description
static final String	CAN_DISABLE
protected boolean	canDisable
static final String	DISABLED_ICON
protected IconConfigurer	disabledIconConfig
static final String	HIDE_WHEN_DISABLED
protected boolean	hideWhenDisabled
static final String	ICON
static final String	NAME
protected MutableProperty.Impl	property
static final String	PROPERTY_GATE
protected String	propertyGate
protected boolean	showDisabledOptions

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ImageSaver()
ImageSaver(Map m)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Expects to be added to a Map.
Class<?>[]	getAllowableConfigureComponents()
static String	getConfigureTypeName()
HelpFile	getHelpFile()
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	removeFrom(Buildable b)	Remove from our parent
void	writeMapAsImage()	Write a PNG-encoded snapshot of the map.
protected void	writeMapRectAsImage(File file, int x, int y, int w, int h)	Helper method for writing images.

Methods inherited from class 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

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractBuildable should override this method in order to add the names of any image files they use to the collection.
protected void	addPropertyGateListener()
protected void	addPropertyGateListener(boolean dontCheck)	If we have a disable-this-button property, set a listener on it
void	checkDisabled()	Check our disable-this-button property and enable/disable our button as appropriate based on its value
void	disableIfTrue(boolean disable)
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
VisibilityCondition	getAttributeVisibility(String key)	By default, all attributes are visible
protected Component	getComponent()	The component to be added to the control window toolbar
LaunchButton	getLaunchButton()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
protected String	getNameKey()
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
boolean	isShowDisabledOptions()
protected LaunchButton	makeLaunchButton(String tooltip, String button_text, String iconFile, ActionListener action)	Create a standard toolbar launcher button for this item
void	propertyChange(PropertyChangeEvent evt)	Listens to our disable-this-button property; enables/disables our button as appropriate when it changes
protected void	removePropertyGateListener()	Remove any existing disable-this-button property
void	setAttribute(String key, Object value)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
protected void	setButtonTextKey(String buttonTextKey)
protected void	setHotKeyKey(String hotKeyKey)
protected void	setIconKey(String iconKey)
protected void	setLaunchButton(LaunchButton launch)	Sets launch button for this toolbar item
protected void	setNameKey(String nameKey)
protected void	setNamePrompt(String namePrompt)
protected void	setShowDisabledOptions(boolean show)
protected void	setTooltipKey(String tooltipKey)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class AbstractConfigurable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMovable

Modifier and Type	Method	Description
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?

Field Details

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

promptToSplit

protected boolean promptToSplit

DEFAULT_ICON

protected static final String DEFAULT_ICON

See Also:

• Constant Field Values

BUTTON_TEXT

protected static final String BUTTON_TEXT

See Also:

• Constant Field Values

dialog

protected static ProgressDialog dialog

HOTKEY

protected static final String HOTKEY

See Also:

• Constant Field Values

TOOLTIP

protected static final String TOOLTIP

See Also:

• Constant Field Values

ICON_NAME

protected static final String ICON_NAME

See Also:

• Constant Field Values

Constructor Details

ImageSaver

public ImageSaver()

ImageSaver

public ImageSaver(Map m)

Method Details

addTo

public void addTo(Buildable b)

Expects to be added to a Map. Adds a button to the map window toolbar that initiates the capture

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

removeFrom

public void removeFrom(Buildable b)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

b - parent

writeMapAsImage

public void writeMapAsImage()

Write a PNG-encoded snapshot of the map.

writeMapRectAsImage

protected void writeMapRectAsImage(File file,
 int x,
 int y,
 int w,
 int h)

Helper method for writing images.

Parameters:

file - the file to write

x - the left edge of the map area to write

y - the top edge of the map area to write

w - the width of the map area to write

h - the height of the map area to write

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

getConfigureTypeName

public static String getConfigureTypeName()

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.

isMandatory

public boolean isMandatory()

Description copied from interface: Buildable

Is this component a reqired component within its parent?

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?

Returns: