com.codename1.components

Class StorageImage

java.lang.Object

com.codename1.ui.Image

com.codename1.ui.EncodedImage

com.codename1.components.StorageImage

All Implemented Interfaces:

ActionSource

public class StorageImage
extends EncodedImage

An encoded image that stores the actual data of the encoded image in storage.

Author:

Shai Almog

Method Summary

Modifier and Type	Method and Description
static StorageImage	create(String fileName, byte[] data, int width, int height) Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed.
static StorageImage	create(String fileName, byte[] data, int width, int height, boolean keep) Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed.
static StorageImage	create(String fileName, InputStream data, int width, int height) Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed.
static StorageImage	create(String fileName, int width, int height) Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed.
static StorageImage	create(String fileName, int width, int height, boolean keep) Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed.
byte[]	getImageData() Returns the byte array data backing the image allowing the image to be stored and discarded completely from RAM.

Methods inherited from class com.codename1.ui.EncodedImage

asyncLock, create, create, create, create, create, createFromImage, createFromRGB, createMulti, drawImage, drawImage, getGraphics, getHeight, getImage, getInternal, getWidth, isAnimation, isLocked, isOpaque, lock, modifyAlpha, modifyAlpha, resetCache, rotate, scale, scaled, scaledEncoded, scaledHeight, scaledSmallerRatio, scaledWidth, subImage, toRGB, unlock

Methods inherited from class com.codename1.ui.Image

addActionListener, animate, applyMask, applyMask, applyMaskAutoScale, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createIndexed, createMask, createSVG, dispose, exifRotation, exifRotation, exifRotation, fill, fireChangedEvent, flipHorizontally, flipVertically, getExifOrientationTag, getExifOrientationTag, getImageName, getRGB, getRGB, getRGBCached, getSVGDocument, isAlphaMutableImageSupported, isJPEG, isPNG, isSVG, isSVGSupported, mirror, modifyAlphaWithTranslucency, removeActionListener, requiresDrawImage, rotate180Degrees, rotate270Degrees, rotate90Degrees, scaledLargerRatio, setImageName

Methods inherited from class java.lang.Object

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

Method Detail

getImageData

public byte[] getImageData()

Returns the byte array data backing the image allowing the image to be stored and discarded completely from RAM.

Overrides:

getImageData in class EncodedImage

Returns:

byte array used to create the image, e.g. encoded PNG, JPEG etc.

create

public static StorageImage create(String fileName,
                                  byte[] data,
                                  int width,
                                  int height)

Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed. This only works reasonably well for very small files.

Parameters:

fileName - the name of the storage file

data - the data

width - the width of the file or -1 if unknown (notice that this will improve performance)

height - the height of the file or -1 if unknown (notice that this will improve performance)

Returns:

image that will load the file seamlessly or null if the storage failed

create

public static StorageImage create(String fileName,
                                  byte[] data,
                                  int width,
                                  int height,
                                  boolean keep)

Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed. This only works reasonably well for very small files.

Parameters:

fileName - the name of the storage file

data - the data

width - the width of the file or -1 if unknown (notice that this will improve performance)

height - the height of the file or -1 if unknown (notice that this will improve performance)

keep - if set to true keeps the file in RAM once loaded

Returns:

image that will load the file seamlessly or null if the storage failed

create

public static StorageImage create(String fileName,
                                  InputStream data,
                                  int width,
                                  int height)
                           throws IOException

Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed. This only works reasonably well for very small files.

Parameters:

fileName - the name of the storage file

data - the stream to cache

width - the width of the file or -1 if unknown (notice that this will improve performance)

height - the height of the file or -1 if unknown (notice that this will improve performance)

Returns:

image that will load the file seamlessly

Throws:

IOException

create

public static StorageImage create(String fileName,
                                  int width,
                                  int height)

Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed. This only works reasonably well for very small files.

Parameters:

fileName - the name of the storage file

width - the width of the file or -1 if unknown (notice that this will improve performance)

height - the height of the file or -1 if unknown (notice that this will improve performance)

Returns:

image that will load the file seamlessly

create

public static StorageImage create(String fileName,
                                  int width,
                                  int height,
                                  boolean keep)

Creates an encoded image that maps to a storage file thus allowing to seamlessly cache images as needed. This only works reasonably well for very small files.

Parameters:

fileName - the name of the storage file

width - the width of the file or -1 if unknown (notice that this will improve performance)

height - the height of the file or -1 if unknown (notice that this will improve performance)

keep - if set to true keeps the file in RAM once loaded

Returns:

image that will load the file seamlessly