com.codename1.components

Class ReplaceableImage

java.lang.Object

com.codename1.ui.Image

com.codename1.ui.EncodedImage

com.codename1.components.ReplaceableImage

All Implemented Interfaces:

ActionSource

public class ReplaceableImage
extends EncodedImage

Allows the image data to be replaced at runtime when a different image is available. The only limitation is that the image width/height must be identical and opacity status can't change (an opaque image can't be made translucent and visa versa).

Author:

Shai Almog

Method Summary

Modifier and Type	Method and Description
boolean	animate()
static ReplaceableImage	create(EncodedImage placeholder) Creates an encoded image that can later be replaced with a different image
byte[]	getImageData() Returns the byte array data backing the image allowing the image to be stored and discarded completely from RAM.
boolean	isAnimation() Returns true if this is an animated image
boolean	isOpaque() Indicates whether this image is opaque or not
void	replace(EncodedImage newImage) Replaces the current image with the new image which must match the dimensions etc.

Methods inherited from class com.codename1.ui.EncodedImage

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

Methods inherited from class com.codename1.ui.Image

addActionListener, 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.

replace

public void replace(EncodedImage newImage)

Replaces the current image with the new image which must match the dimensions etc. of the previous image.

Parameters:

newImage - the image to apply

create

public static ReplaceableImage create(EncodedImage placeholder)

Creates an encoded image that can later be replaced with a different image

Parameters:

placeholder - a temporary image

Returns:

image that will be replaceable later on

animate

public boolean animate()

Overrides:

animate in class Image

isAnimation

public boolean isAnimation()

Returns true if this is an animated image

Overrides:

isAnimation in class EncodedImage

Returns:

true if this image represents an animation

isOpaque

public boolean isOpaque()

Indicates whether this image is opaque or not

Overrides:

isOpaque in class EncodedImage

Returns:

true if the image is completely opqaque which allows for some heavy optimizations