Package VASSAL.build.module.map

Class ImageSaver

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.ImageSaver

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class ImageSaver
extends AbstractConfigurable

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

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BUTTON_TEXT
protected static String	DEFAULT_ICON
protected static ProgressDialog	dialog
protected static String	HOTKEY
protected static String	ICON_NAME
protected LaunchButton	launch
protected Map	map
protected boolean	promptToSplit
protected static String	TOOLTIP

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()	Return a list of valid sub-component Classes.
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 buildFile (XML) attributes of this component.
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()
HelpFile	getHelpFile()
void	removeFrom(Buildable b)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	writeImage(OutputStream[] out)	Deprecated, for removal: This API element is subject to removal in a future version. Use writeMapAsImage()
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.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

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

launch

protected LaunchButton launch

map

protected Map map

promptToSplit

protected boolean promptToSplit

DEFAULT_ICON

protected static final String DEFAULT_ICON

See Also:

Constant Field Values

dialog

protected static ProgressDialog dialog

HOTKEY

protected static final String HOTKEY

See Also:

Constant Field Values

BUTTON_TEXT

protected static final String BUTTON_TEXT

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

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

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 class: AbstractConfigurable

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

setAttribute

public void setAttribute(String key,
Object value)

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

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

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 attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

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

writeImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void writeImage(OutputStream[] out)
                throws IOException

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

Use writeMapAsImage()

Write a PNG-encoded snapshot of the map to the given OutputStreams, dividing the map into vertical sections, one per stream

Throws:

IOException

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

getConfigureTypeName

public static String getConfigureTypeName()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Description copied from interface: Configurable

Return 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 Configuration Window.