Package VASSAL.build.module.map
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:
AutoConfigurable
,Buildable
,Configurable
,PropertyNameSource
,ValidityChecker
,Translatable
,ImageSearchTarget
,SearchTarget
This allows the user to capture a snapshot of the entire map into
a PNG file.
-
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 TypeFieldDescriptionprotected static String
protected static String
protected static ProgressDialog
protected static String
protected static String
protected LaunchButton
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclassprotected Map
protected boolean
protected static String
Fields inherited from class VASSAL.build.AbstractToolbarItem
ICON, 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
Expects to be added to aMap
.Class<?>[]
static String
void
removeFrom(Buildable b)
Default behavior assumes we are removing this from the module toolbarvoid
writeImage(OutputStream[] out)
Deprecated, for removal: This API element is subject to removal in a future version.void
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, 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
-
launch
Deprecated, for removal: This API element is subject to removal in a future version.use launch from the superclass -
map
-
promptToSplit
protected boolean promptToSplit -
DEFAULT_ICON
- See Also:
- Constant Field Values
-
BUTTON_TEXT
- See Also:
- Constant Field Values
-
dialog
-
HOTKEY
- See Also:
- Constant Field Values
-
TOOLTIP
- See Also:
- Constant Field Values
-
ICON_NAME
- See Also:
- Constant Field Values
-
-
Constructor Details
-
ImageSaver
public ImageSaver() -
ImageSaver
-
-
Method Details
-
addTo
Expects to be added to aMap
. Adds a button to the map window toolbar that initiates the capture- Specified by:
addTo
in interfaceBuildable
- Overrides:
addTo
in classAbstractToolbarItem
- Parameters:
b
- parent Buildable to add this component to as a subcomponent.
-
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:
b
- parent
-
writeMapAsImage
public void writeMapAsImage()Write a PNG-encoded snapshot of the map. -
writeMapRectAsImage
Helper method for writing images.- Parameters:
file
- the file to writex
- the left edge of the map area to writey
- the top edge of the map area to writew
- the width of the map area to writeh
- the height of the map area to write
-
writeImage
@Deprecated(since="2020-08-06", forRemoval=true) public void writeImage(OutputStream[] out) throws IOExceptionDeprecated, for removal: This API element is subject to removal in a future version.Write a PNG-encoded snapshot of the map to the given OutputStreams, dividing the map into vertical sections, one per stream- Throws:
IOException
-
getHelpFile
- Returns:
- a HelpFile describing how to use and configure * this component
-
getConfigureTypeName
-
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.
-