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 VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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

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 VASSAL.build.AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, ICON, 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
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 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, isMovable

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: