com.lf.commons.gui

Class ImageFactory

java.lang.Object

com.lf.commons.lang.ManagedFactory

com.lf.commons.gui.ImageFactory

public class ImageFactory
extends ManagedFactory

Factory class for vending various images (here of type ImageIcon).

Whenever possible, this factory will hand out references to shared instances. Use this if you need many, many image objects while running your application and it is acceptable for you to continously use a certain amount of memory for the cached object. If you only use instances once then you should either install an object as usual (by calling new), or let this factory create a shared instance and flush the factory after you're finished with the object. The garbage collector will then release memory on-the-fly as the objects are no longer referenced so the overall memory footprint can be very small.

TODO: A special VFSImageFactory would also be nice since VFS loading might be quite slow.

Since:

1.6

Version:

$Revision: 1.12 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	ERROR_ICON Icon provided if images cannot be loaded.
protected static ImageFactory	sharedInstance Shared ImageFactory instance.

Fields inherited from class com.lf.commons.lang.ManagedFactory

cacheObjectByID

Constructor Summary

Constructors

Constructor and Description
ImageFactory() Constructs an instance of this factory.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRelease(java.lang.String id) Checks whether a factory shared object can be released or not.
void	cleanup(java.lang.String id) Perform optional cleanup tasks like closing database connections or disposing dialogs.
static javax.swing.ImageIcon	getIcon(java.lang.String id) Convenience method to get a certain image from the shared instance of this factory.
static javax.swing.ImageIcon	getIcon(java.lang.String id, javax.swing.ImageIcon fallback) Convenience method to get a certain image from the shared instance of this factory.
static ImageFactory	getSharedInstance() Provides the shared instance of the factory implementation.
java.lang.Object	request(java.lang.String id) Create the factory shared object, recycle if already existing.

Methods inherited from class com.lf.commons.lang.ManagedFactory

getRegisteredObjects, hasSharedInstance, release, releaseByStrategy, releaseForced, set

Methods inherited from class java.lang.Object

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

Field Detail

sharedInstance

protected static ImageFactory sharedInstance

Shared ImageFactory instance.

ERROR_ICON

public static final java.net.URL ERROR_ICON

Icon provided if images cannot be loaded.

Constructor Detail

ImageFactory

public ImageFactory()

Constructs an instance of this factory.

Since:

1.6

Method Detail

getSharedInstance

public static ImageFactory getSharedInstance()

Provides the shared instance of the factory implementation.

Returns:

Shared instance of the factory

Since:

1.6

request

public java.lang.Object request(java.lang.String id)

Create the factory shared object, recycle if already existing.

This method can only be done by the sub classes since every shared object can have its own specialities needed for creation.

Specified by:

request in class ManagedFactory

Parameters:

id - The factory-unique identifier of the shared object

Returns:

The shared object, null if none could be created

Since:

1.6

canRelease

public boolean canRelease(java.lang.String id)

Checks whether a factory shared object can be released or not.

Specified by:

canRelease in class ManagedFactory

Parameters:

id - The factory-unique identifier of the shared object

Returns:

Can the object be released according to the factories needs?

Since:

1.6

cleanup

public void cleanup(java.lang.String id)

Perform optional cleanup tasks like closing database connections or disposing dialogs.

Specified by:

cleanup in class ManagedFactory

Parameters:

id - The factory-unique identifier of the shared object

Since:

1.6

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String id)

Convenience method to get a certain image from the shared instance of this factory.

Parameters:

id - The factory-unique identifier of the shared object

Returns:

The shared icon, default icon if none could be created

Since:

1.6

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String id,
                            javax.swing.ImageIcon fallback)

Convenience method to get a certain image from the shared instance of this factory.

Parameters:

id - The factory-unique identifier of the shared object

fallback - Returned if desired icon is not available

Returns:

The shared icon, fallback icon if none could be created

Since:

1.6