org.openstreetmap.josm.tools

Class ImageResource

java.lang.Object

org.openstreetmap.josm.tools.ImageResource

public class ImageResource
extends java.lang.Object

Holds data for one particular image. It can be backed by a svg or raster image. In the first case, svg is not null and in the latter case, baseImage is not null.

Since:

4271

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.Image	baseImage
static java.awt.Dimension	DEFAULT_DIMENSION Use this dimension to request original file dimension.
private java.util.Map<java.awt.Dimension,java.awt.Image>	imgCache Caches the image data for resized versions of the same image.
protected java.util.List<ImageOverlay>	overlayInfo ordered list of overlay images
private SVGDiagram	svg SVG diagram information in case of SVG vector image.

Constructor Summary

Constructors

Constructor and Description
ImageResource(java.awt.Image img) Constructs a new ImageResource from an image.
ImageResource(ImageResource res, java.util.List<ImageOverlay> overlayInfo) Constructs a new ImageResource from another one and sets overlays.
ImageResource(SVGDiagram svg) Constructs a new ImageResource from SVG data.

Method Summary

Modifier and Type	Method and Description
javax.swing.ImageIcon	getImageIcon() Returns the image icon at default dimension.
void	getImageIcon(javax.swing.AbstractAction a) Set both icons of an Action
javax.swing.ImageIcon	getImageIcon(java.awt.Dimension dim) Get an ImageIcon object for the image of this resource
javax.swing.ImageIcon	getImageIconBounded(java.awt.Dimension maxSize) Get image icon with a certain maximum size.

Methods inherited from class java.lang.Object

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

Field Detail

imgCache

private java.util.Map<java.awt.Dimension,java.awt.Image> imgCache

Caches the image data for resized versions of the same image.

svg

private SVGDiagram svg

SVG diagram information in case of SVG vector image.

DEFAULT_DIMENSION

public static final java.awt.Dimension DEFAULT_DIMENSION

Use this dimension to request original file dimension.

overlayInfo

protected java.util.List<ImageOverlay> overlayInfo

ordered list of overlay images

baseImage

private java.awt.Image baseImage

Constructor Detail

ImageResource

public ImageResource(java.awt.Image img)

Constructs a new ImageResource from an image.

Parameters:

img - the image

ImageResource

public ImageResource(SVGDiagram svg)

Constructs a new ImageResource from SVG data.

Parameters:

svg - SVG data

ImageResource

public ImageResource(ImageResource res,
                     java.util.List<ImageOverlay> overlayInfo)

Constructs a new ImageResource from another one and sets overlays.

Parameters:

res - the existing resource

overlayInfo - the overlay to apply

Since:

8095

Method Detail

getImageIcon

public javax.swing.ImageIcon getImageIcon()

Returns the image icon at default dimension.

Returns:

the image icon at default dimension

getImageIcon

public void getImageIcon(javax.swing.AbstractAction a)

Set both icons of an Action

Parameters:

a - The action for the icons

Since:

7693

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.awt.Dimension dim)

Get an ImageIcon object for the image of this resource

Parameters:

dim - The requested dimensions. Use (-1,-1) for the original size and (width, -1) to set the width, but otherwise scale the image proportionally.

Returns:

ImageIcon object for the image of this resource, scaled according to dim

getImageIconBounded

public javax.swing.ImageIcon getImageIconBounded(java.awt.Dimension maxSize)

Get image icon with a certain maximum size. The image is scaled down to fit maximum dimensions. (Keeps aspect ratio)

Parameters:

maxSize - The maximum size. One of the dimensions (width or height) can be -1, which means it is not bounded.

Returns:

ImageIcon object for the image of this resource, scaled down if needed, according to maxSize