org.pepstock.charba.client.commons

Class ArrayImage

java.lang.Object

org.pepstock.charba.client.commons.Array

org.pepstock.charba.client.commons.ArrayImage

@JsType(isNative=true,
        name="Array",
        namespace="<global>")
public final class ArrayImage
extends Array

Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (ImageElement) values.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static ArrayImage	from(ImageElement... items) This method creates new array instance with a variable number of ImageElement arguments.
static ArrayImage	from(List<ImageElement> items) Creates a java script array of images starting from list of images.
static ArrayImage	fromOrNull(ImageElement... items) This method creates new array instance with a variable number of ImageElement arguments.
static ArrayImage	fromOrNull(List<ImageElement> items) Creates a java script array of images starting from list of images.
ImageElement	get(int index) Gets the value at a given index.

Methods inherited from class org.pepstock.charba.client.commons.Array

isArray, isEmpty, length

Methods inherited from class java.lang.Object

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

Method Detail

fromOrNull

@JsOverlay
public static ArrayImage fromOrNull(ImageElement... items)

This method creates new array instance with a variable number of ImageElement arguments.

Parameters:

items - ImageElement items to create new array

Returns:

new array instance of images or null if argument is null or length to 0

from

@JsOverlay
public static ArrayImage from(ImageElement... items)

This method creates new array instance with a variable number of ImageElement arguments.

Parameters:

items - ImageElement items to create new array

Returns:

new array instance of images or an empty array if argument is null or length to 0

fromOrNull

@JsOverlay
public static ArrayImage fromOrNull(List<ImageElement> items)

Creates a java script array of images starting from list of images.

Parameters:

items - list of images to load into new java script array.

Returns:

new array instance of images or null if argument is null or empty

from

@JsOverlay
public static ArrayImage from(List<ImageElement> items)

Creates a java script array of images starting from list of images.

Parameters:

items - list of images to load into new java script array.

Returns:

new array instance of images or an empty array if argument is null or empty

get

@JsOverlay
public ImageElement get(int index)

Gets the value at a given index. If no value exists at the given index, a type-conversion error will occur in Development Mode and unpredictable behavior may occur in Production Mode. If the numeric value returned is non-integral, it will cause a warning in Development Mode, and may affect the results of mathematical expressions.

Parameters:

index - the index to be retrieved

Returns:

the value at the given index