org.jowidgets.common.image

Interface IImageRegistry

public interface IImageRegistry

Method Summary

Methods

Modifier and Type	Method and Description
IImageHandle	getImageHandle(IImageConstant key) Gets the image handle for a image constant.
boolean	isImageAvailable(IImageConstant key) Checks if a image is available for a given key A image is available if the key is registered or if a image can be created from the key (e.g. because the key is a image provider).
boolean	isImageInitialized(IImageConstant key) Checks if an image is already initialized.
boolean	isImageRegistered(IImageConstant key) Checks if an image constant is already registered.
void	registerImageConstant(IImageConstant key, IImageConstant substitude) Registers an image constant with an substitude image constant The substitude must be available isImageAvailable(IImageConstant) and the value of the substitude becomes the new image for the key.
void	registerImageConstant(IImageConstant key, IImageDescriptor descriptor) Registers an image constant with an image descriptor value
void	registerImageConstant(IImageConstant key, IImageHandle imageHandle) Registers an image constant key with a image handle value A image handle provides native (ui framework dependent) information, so for writing spi independent code, this method normally will not be used.
void	registerImageConstant(IImageConstant key, IImageProvider provider) Registers an image constant with an image provider value
void	registerImageConstant(IImageConstant key, java.net.URL url) Registers an image constant with an url value
<T extends java.lang.Enum<?> & IImageUrlProvider> void	registerImageEnum(java.lang.Class<T> enumClass) Deprecated. The registration of an image enum is not necessary, because an image provider will be registered automatically at first use
void	registerImageProvider(IImageProvider provider) Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use
void	registerImageStream(IImageStreamProvider provider) Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use
void	registerImageUrl(IImageUrlProvider provider) Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use
void	unRegisterImage(IImageCommon image) Unregisters an image.
void	unRegisterImageConstant(IImageConstant key) Unregisters a image constant.

Method Detail

registerImageConstant

void registerImageConstant(IImageConstant key,
                         IImageDescriptor descriptor)

Registers an image constant with an image descriptor value

Parameters:

key - The key to use, must not be null

descriptor - The descriptor to use, must not be null

registerImageConstant

void registerImageConstant(IImageConstant key,
                         IImageProvider provider)

Registers an image constant with an image provider value

Parameters:

key - The key to use, must not be null

descriptor - The provider to use, must not be null

registerImageConstant

void registerImageConstant(IImageConstant key,
                         java.net.URL url)

Registers an image constant with an url value

Parameters:

key - The key to use, must not be null

descriptor - The url to use, must not be null

registerImageConstant

void registerImageConstant(IImageConstant key,
                         IImageConstant substitude)

Registers an image constant with an substitude image constant The substitude must be available isImageAvailable(IImageConstant) and the value of the substitude becomes the new image for the key.

Parameters:

key - The key to use, must not be null

substitude - The substitude to use, must not be null

registerImageConstant

void registerImageConstant(IImageConstant key,
                         IImageHandle imageHandle)

Registers an image constant key with a image handle value A image handle provides native (ui framework dependent) information, so for writing spi independent code, this method normally will not be used.

Parameters:

key - The key to use

imageHandle - The image handle to use

getImageHandle

IImageHandle getImageHandle(IImageConstant key)

Gets the image handle for a image constant. A image handle provides native (ui framework dependent) information, so for writing spi independent code, this method normally will not be used.

Parameters:

key - The key to get the handle for

Returns:

The image handle or null, if no handle was registered or can be created with the key.

unRegisterImageConstant

void unRegisterImageConstant(IImageConstant key)

Unregisters a image constant. This also disposes the image handle (and native image) if initialized and not already disposed. Be sure that the image handle currently registered for the key is no longer be used. If no image is registered for the key, the method returns without any effect

Parameters:

key - The image constant to unregister

unRegisterImage

void unRegisterImage(IImageCommon image)

Unregisters an image. This also disposes the image. After that the image can not be used anymore

Parameters:

image - The image to unregister

isImageAvailable

boolean isImageAvailable(IImageConstant key)

Checks if a image is available for a given key A image is available if the key is registered or if a image can be created from the key (e.g. because the key is a image provider). If an image is not available, the use of the key for anay widget may lead to an exception

Parameters:

key - The key to check if image is available for

Returns:

true if image is available, false if not

isImageRegistered

boolean isImageRegistered(IImageConstant key)

Checks if an image constant is already registered. Remark: A key may be available isImageAvailable(IImageConstant) even if it has not been registered yet

Parameters:

key - The key to check

Returns:

True if the image was already registered

isImageInitialized

boolean isImageInitialized(IImageConstant key)

Checks if an image is already initialized. A image is initialized if it is registered and the native image has already been created

Parameters:

key - The key to check

Returns:

True if the image was already initialized

registerImageEnum

@Deprecated
<T extends java.lang.Enum<?> & IImageUrlProvider> void registerImageEnum(java.lang.Class<T> enumClass)

Deprecated. The registration of an image enum is not necessary, because an image provider will be registered automatically at first use

Registers all images of a image url provider enum

Parameters:

enumClass - The enum to register

registerImageProvider

@Deprecated
void registerImageProvider(IImageProvider provider)

Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use

Registers an IImageStreamProvider

Parameters:

provider - The provider to register

registerImageUrl

@Deprecated
void registerImageUrl(IImageUrlProvider provider)

Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use

Registers an IImageUrlProvider

Parameters:

provider - The provider to register

registerImageStream

@Deprecated
void registerImageStream(IImageStreamProvider provider)

Deprecated. The registration of an image provider is not necessary, because an image provider will be registered automatically at first use

Registers an IImageStreamProvider

Parameters:

provider - The provider to register