org.jowidgets.tools.image

Class AbstractResourceImageInitializer

java.lang.Object

org.jowidgets.tools.image.AbstractResourceImageInitializer

public abstract class AbstractResourceImageInitializer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractResourceImageInitializer(java.lang.Class<?> resourceClass, IImageRegistry imageRegistry, java.lang.String resourcesPath) Creates a new instance
AbstractResourceImageInitializer(java.lang.ClassLoader resourceClassLoader, IImageRegistry imageRegistry, java.lang.String resourcesPath) Creates a new instance

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkEnumAvailability(java.lang.Class<? extends java.lang.Enum<? extends IImageConstant>> imageEnumType) Check if all keys of the given enum are available in the registry
abstract void	doRegistration() Does the image registration
protected java.util.List<IImageConstant>	getUnavailableKeys(java.lang.Class<? extends java.lang.Enum<? extends IImageConstant>> imageEnumType) Gets all unavailable keys of a given enum
protected void	registerResourceImage(IImageConstant key, java.lang.String resourceName) Register a image from the resources
protected void	registerSubstitudeIcon(IImageConstant key, IImageConstant substitude) Registers a image with help of another image key

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceImageInitializer

public AbstractResourceImageInitializer(java.lang.Class<?> resourceClass,
                                IImageRegistry imageRegistry,
                                java.lang.String resourcesPath)

Creates a new instance

Parameters:

resourceClass - A class that has the same class loader then the resources that holds the image file, e.g. the concrete class that is derived from this class

imageRegistry - The image registry to use

resourcesPath - The root path of the resources

AbstractResourceImageInitializer

public AbstractResourceImageInitializer(java.lang.ClassLoader resourceClassLoader,
                                IImageRegistry imageRegistry,
                                java.lang.String resourcesPath)

Creates a new instance

Parameters:

resourceClassLoader - The class loader to access the resources that holds the image file

imageRegistry - The image registry to use

resourcesPath - The root path of the resources

Method Detail

registerResourceImage

protected void registerResourceImage(IImageConstant key,
                         java.lang.String resourceName)

Register a image from the resources

Parameters:

key - The key of the image to register

resourceName - The name of the resource (will be appended to the resource path)

registerSubstitudeIcon

protected void registerSubstitudeIcon(IImageConstant key,
                          IImageConstant substitude)

Registers a image with help of another image key

Parameters:

key - The key to register

substitude - The (already available) image to use as substitude

checkEnumAvailability

protected void checkEnumAvailability(java.lang.Class<? extends java.lang.Enum<? extends IImageConstant>> imageEnumType)

Check if all keys of the given enum are available in the registry

Parameters:

imageEnumType - The enum to checks

getUnavailableKeys

protected java.util.List<IImageConstant> getUnavailableKeys(java.lang.Class<? extends java.lang.Enum<? extends IImageConstant>> imageEnumType)

Gets all unavailable keys of a given enum

Parameters:

imageEnumType - The enum to get the unavailable keys for

Returns:

The unavailable keys, never null but may be empty if all keys are available

doRegistration

public abstract void doRegistration()

Does the image registration