com.goldencode.p2j.ui.client

Class ImageHelper

java.lang.Object

com.goldencode.p2j.ui.client.ImageHelper

public class ImageHelper
extends java.lang.Object

Image helper methods to handle pending image loading.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ImageHelper.WorkArea Context state.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.Integer,java.lang.Object>	imgDownMap Map to store pending images for button widget down image.
private static java.util.Map<java.lang.Integer,java.lang.Object>	imgInsMap Map to store pending images for button widget disabled image.
private static java.util.Map<java.lang.Integer,java.lang.Object>	imgMap Map to store pending images for image widget.
private static java.util.Map<java.lang.Integer,java.lang.Object>	imgUpMap Map to store pending images for button widget up image.
private static java.util.Map<MousePointer,java.lang.String>	mousePointerFiles Map pre-defined MousePointers w/o AWT/JS counterparts to data files
private static java.util.Map<MousePointer,CursorType>	mousePointerTypes Map pre-defined MousePointers to AWT/JS ones
private static ContextLocal<ImageHelper.WorkArea>	wa Context state

Constructor Summary

Constructors

Constructor and Description
ImageHelper()

Method Summary

Modifier and Type	Method and Description
static void	addGlobalImage(int widgetId, ImageWrapper<?> image) Registers the image for the supplied widget in the security context.
static java.lang.String	cursorFile(MousePointer ptr) Get data to create cursor from pre-packaged resource for the mouse pointer.
static CursorType	cursorType(MousePointer ptr) Get AWT/JS cursor type for the mouse pointer
static ImageWrapper<?>	getGlobalImage(int widgetId, int uniqueId) Returns an image previously registered in the security context.
static ImageWrapper<?>	getImageByIndex(int widgetId, int idx) Returns an image previously registered in the security context.
static byte[]	getPendingImageData(int wId, int type) Gets the new image data byte array for loading at widget realization stage.
static java.lang.String	getPendingImageName(int wId, int type) Gets the new image file name for loading at widget realization stage.
static byte[]	getPrepackagedImageData(java.lang.String fileName) Gets the new image data byte array for prepackaged images.
static boolean	isPrepackaged(java.lang.String fileName) Checks if the given image file name belongs to the set of the prepackaged images embedded into project distribution.
static void	removeGlobalImages(int widgetId) Removes all previously registered images for the supplied widget.
static void	removeGlobalImages(int widgetId, java.util.Collection<java.lang.Integer> uniqueIds) Remove selected images for the supplied widget.
static boolean	storePendingImageData(int wId, int type, byte[] imageBytes) Saves the new image data byte array for further loading at widget realization stage.
static boolean	storePendingImageName(int wId, int type, java.lang.String fileName) Saves the new image name for further loading at widget realization stage.

Methods inherited from class java.lang.Object

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

Field Detail

imgMap

private static final java.util.Map<java.lang.Integer,java.lang.Object> imgMap

Map to store pending images for image widget.

imgUpMap

private static final java.util.Map<java.lang.Integer,java.lang.Object> imgUpMap

Map to store pending images for button widget up image.

imgDownMap

private static final java.util.Map<java.lang.Integer,java.lang.Object> imgDownMap

Map to store pending images for button widget down image.

imgInsMap

private static final java.util.Map<java.lang.Integer,java.lang.Object> imgInsMap

Map to store pending images for button widget disabled image.

mousePointerTypes

private static final java.util.Map<MousePointer,CursorType> mousePointerTypes

Map pre-defined MousePointers to AWT/JS ones

mousePointerFiles

private static final java.util.Map<MousePointer,java.lang.String> mousePointerFiles

Map pre-defined MousePointers w/o AWT/JS counterparts to data files

wa

private static ContextLocal<ImageHelper.WorkArea> wa

Context state

Constructor Detail

ImageHelper

public ImageHelper()

Method Detail

storePendingImageName

public static boolean storePendingImageName(int wId,
                                            int type,
                                            java.lang.String fileName)

Saves the new image name for further loading at widget realization stage.

Parameters:

wId - ID of the widget will own the image.

type - Image type to load. Up, Down or Insensitive for buttons or image.

fileName - The file name for the image to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

storePendingImageData

public static boolean storePendingImageData(int wId,
                                            int type,
                                            byte[] imageBytes)

Saves the new image data byte array for further loading at widget realization stage.

Parameters:

wId - ID of the widget will own the image.

type - Image type to load. Up, Down or Insensitive for buttons or image.

imageBytes - The byte array data for the image to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

getPendingImageData

public static byte[] getPendingImageData(int wId,
                                         int type)

Gets the new image data byte array for loading at widget realization stage.

Parameters:

wId - ID of the widget will own the image.

type - Image type to load. Up, Down or Insensitive for buttons or image.

Returns:

The byte array data for the image to be loaded or null if there is no data.

getPendingImageName

public static java.lang.String getPendingImageName(int wId,
                                                   int type)

Gets the new image file name for loading at widget realization stage.

Parameters:

wId - ID of the widget will own the image.

type - Image type to load. Up, Down or Insensitive for buttons or image.

Returns:

The file name for the image to be loaded and found in PROPATH directory.

isPrepackaged

public static boolean isPrepackaged(java.lang.String fileName)

Checks if the given image file name belongs to the set of the prepackaged images embedded into project distribution. Currently the embedded images includes: btn-up-arrow, btn-down-arrow, btn-left-arrow and btn-right-arrow.

Parameters:

fileName - The file name for the image to be checked.

Returns:

TRUE if given image is prepackaged FALSE otherwise.

getPrepackagedImageData

public static byte[] getPrepackagedImageData(java.lang.String fileName)

Gets the new image data byte array for prepackaged images.

Parameters:

fileName - The file name for the image to be loaded from p2j.jar.

Returns:

The byte array data for the image to be loaded or null if there is no data.

cursorType

public static CursorType cursorType(MousePointer ptr)

Get AWT/JS cursor type for the mouse pointer

Parameters:

ptr - mouse pointer

Returns:

AWT/JS cursor type

cursorFile

public static java.lang.String cursorFile(MousePointer ptr)

Get data to create cursor from pre-packaged resource for the mouse pointer.

Parameters:

ptr - mouse pointer

Returns:

the cursor resource file name or null if this cursor is not supported.

addGlobalImage

public static void addGlobalImage(int widgetId,
                                  ImageWrapper<?> image)

Registers the image for the supplied widget in the security context.

Parameters:

widgetId - Valid widget id.

image - An image to register.

getGlobalImage

public static ImageWrapper<?> getGlobalImage(int widgetId,
                                             int uniqueId)

Returns an image previously registered in the security context.

Parameters:

widgetId - Valid widget id.

uniqueId - Image unique id.

Returns:

registered image instance or null.

getImageByIndex

public static ImageWrapper<?> getImageByIndex(int widgetId,
                                              int idx)

Returns an image previously registered in the security context.

Parameters:

widgetId - Valid widget id.

idx - 0-based index in the widget image list.

Returns:

registered image instance or null.

removeGlobalImages

public static void removeGlobalImages(int widgetId,
                                      java.util.Collection<java.lang.Integer> uniqueIds)

Remove selected images for the supplied widget.

Parameters:

widgetId - Valid widget id.

uniqueIds - IDs of images to be removed

removeGlobalImages

public static void removeGlobalImages(int widgetId)

Removes all previously registered images for the supplied widget.

Parameters:

widgetId - A valid widget id.