se.entra.phantom.client

Class ImageManager

java.lang.Object

se.entra.phantom.client.ImageManager

All Implemented Interfaces:

IImageManager

public class ImageManager
extends Object
implements IImageManager

The image manager handles loading of all images either from the document base or from a specified resource directory (optional protocol/port may be specified).

Method Summary

Modifier and Type	Method and Description
ImageIcon	getCachedImage(String name) Get the ImageIcon if it is available in the cache.
ClassLoader	getClassLoader() Gets the class loader for resources, null for none (i.e.
ImageIcon	getImage(String name) Gets a cached image from the resource URL.
ImageIcon	getImage(String name, boolean keepInCache) Gets a [cached] image from the resource URL.
ImageIcon	getImage(URL url) Gets a non-cached image from the resource URL.
URL	getResourceURL() Gets the resource URL.
double	getScaleX() Gets the scaling factor for images in X.
double	getScaleY() Gets the scaling factor for images in X.
void	setImageScaling(double x, double y) Assigns the image scaling and clears the image cache (that might contain [scaled] images), if the values are different.
void	setResourceURL(String resDir) Sets the resource URL.
void	setTemporaryResourceURL(String resDir) Sets a temporary relative resource URL.

Methods inherited from class java.lang.Object

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

Method Detail

setTemporaryResourceURL

public void setTemporaryResourceURL(String resDir)

Sets a temporary relative resource URL. Empty string or null sets it back to the normal value for the application.

setImageScaling

public void setImageScaling(double x,
                            double y)

Assigns the image scaling and clears the image cache (that might contain [scaled] images), if the values are different.

Parameters:

x - The X-scaling factor, must be greater than zero.

y - The Y-scaling factor, must be greater than zero.

Throws:

IllegalArgumentException - for x or y zero or smaller.

setResourceURL

public void setResourceURL(String resDir)

Sets the resource URL. If null or empty string, use default. Optional protocol/port may be specified.

If the resource URL contains the tag "@**SERVER@", the tag will be substituted with the host name for the host currently used. This makes it possible to have the resource URL follow to a backup server and load balancing.

If the resource URL contains the tag "@**PORT@", the tag will be substituted with the port number for the host currently used. This makes it possible to have the resource URL follow to a backup server and load balancing.

Parameters:

resDir - The resource URL.

getClassLoader

public ClassLoader getClassLoader()

Gets the class loader for resources, null for none (i.e. the current loader).

getResourceURL

public URL getResourceURL()

Gets the resource URL. If null or empty string, use default. Optional protocol/port may be specified.

getScaleX

public double getScaleX()

Gets the scaling factor for images in X.

Specified by:

getScaleX in interface IImageManager

Returns:

Scaling factor, never zero, 1.0 for none.

getScaleY

public double getScaleY()

Gets the scaling factor for images in X.

Specified by:

getScaleY in interface IImageManager

Returns:

Scaling factor, never zero, 1.0 for none.

getImage

public ImageIcon getImage(URL url)

Gets a non-cached image from the resource URL.

Parameters:

url - The URL to load the image from.

Returns:

An image, perhaps with zero-size if it fails loading.

getCachedImage

public ImageIcon getCachedImage(String name)

Get the ImageIcon if it is available in the cache.

Specified by:

getCachedImage in interface IImageManager

Parameters:

name - The image name.

Returns:

image icon in the cache, null if non-existent.

getImage

public ImageIcon getImage(String name)

Gets a cached image from the resource URL.

Specified by:

getImage in interface IImageManager

Parameters:

name - The image name.

Returns:

An image, perhaps with zero-size if it fails loading.

getImage

public ImageIcon getImage(String name,
                          boolean keepInCache)

Gets a [cached] image from the resource URL.

Specified by:

getImage in interface IImageManager

Parameters:

name - The image name.

keepInCache - Flag to keep image in cache or not.

Returns:

An image, perhaps with zero-size if it fails loading.