org.pepstock.charba.client.commons.ArrayImage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation
Show all versions of charba Show documentation
Charba - J2CL and GWT charts library based on CHART.JS
/**
Copyright 2017 Andrea "Stock" Stocchero
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUint WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.pepstock.charba.client.commons;
import java.util.List;
import org.pepstock.charba.client.dom.elements.Img;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsPackage;
import jsinterop.annotations.JsType;
/**
* Array object which maps the java script object.
* A simple wrapper around a homogeneous native array of object (ImageElement) values.
*
* @author Andrea "Stock" Stocchero
*/
@JsType(isNative = true, name = NativeName.ARRAY, namespace = JsPackage.GLOBAL)
public final class ArrayImage extends Array {
/**
* This method creates new array instance with a variable number of ImageElement arguments.
*
* @param items ImageElement items to create new array
* @return new array instance of images.
*/
private static native ArrayImage of(Img... items);
/**
* To avoid any instantiation
*/
ArrayImage() {
}
/**
* This method creates new array instance with a variable number of ImageElement arguments.
*
* @param items ImageElement items to create new array
* @return new array instance of images or null if argument is null or length to 0
*/
@JsOverlay
public static ArrayImage fromOrNull(Img... items) {
// checks if consistent
if (items == null || items.length == 0) {
// returns an empty array
return null;
}
// returns array
return ArrayImage.of(items);
}
/**
* This method creates new array instance with a variable number of ImageElement arguments.
*
* @param items ImageElement items to create new array
* @return new array instance of images or an empty array if argument is null or length to 0
*/
@JsOverlay
public static ArrayImage fromOrEmpty(Img... items) {
// checks if consistent
if (items == null || items.length == 0) {
// returns an empty array
return new ArrayImage();
}
// returns array
return ArrayImage.of(items);
}
/**
* Creates a java script array of images starting from list of images.
*
* @param items list of images to load into new java script array.
* @return new array instance of images or null if argument is null or empty
*/
@JsOverlay
public static ArrayImage fromOrNull(List![]()
items) {
// checks if list is null
if (items == null || items.isEmpty()) {
return null;
}
// checks if is already a list with array
if (items instanceof ArrayImageList) {
// casts to array list
ArrayImageList list = (ArrayImageList) items;
// returns array
return list.getArray();
}
// creates the array
ArrayImage result = new ArrayImage();
// scans all items of list
for (Img value : items) {
// adds elements
result.push(value);
}
// returns the array
return result;
}
/**
* Creates a java script array of images starting from list of images.
*
* @param items list of images to load into new java script array.
* @return new array instance of images or an empty array if argument is null or empty
*/
@JsOverlay
public static ArrayImage fromOrEmpty(List![]()
items) {
// checks if is already a list with array
if (items instanceof ArrayImageList) {
// casts to array list
ArrayImageList list = (ArrayImageList) items;
// returns array
return list.getArray();
}
// creates the array
ArrayImage result = new ArrayImage();
// checks if list is null
if (items == null || items.isEmpty()) {
return result;
}
// scans all items of list
for (Img value : items) {
// adds elements
result.push(value);
}
// returns the array
return result;
}
/**
* Returns the index of the last occurrence of the specified element in this array, or -1 if this array does not contain the element.
*
* @param value element to search for
* @return the index of the last occurrence of the specified element in this array, or -1 if this array does not contain the element
*/
native int lastIndexOf(Object value);
/**
* Returns the index of the first occurrence of the specified element in this array, or -1 if this array does not contain the element.
*
* @param value element to search for
* @return the index of the first occurrence of the specified element in this array, or -1 if this array does not contain the element
*/
native int indexOf(Object value);
/**
* Returns a shallow copy of a portion of an array into a new array object selected from begin to end (end not included).
* The original array will not be modified.
*
* @param start Zero-based index at which to begin extraction.
* A negative index can be used, indicating an offset from the end of the sequence.
* If begin is undefined, slice begins from index 0.
* If begin is greater than the length of the sequence, an empty array is returned.
* @param end Zero-based index before which to end extraction. slice extracts up to but not including end.
* A negative index can be used, indicating an offset from the end of the sequence.
* If end is omitted, slice extracts through the end of the sequence (array.length()). If end is greater than the length of the sequence, slice extracts
* through to the end of the sequence (array.length()).
* @return A new array containing the extracted elements.
*/
native ArrayImage slice(int start, int end);
/**
* This method changes the contents of an array by removing existing elements and/or adding new elements.
*
* @param start index at which to start changing the array (with origin 0).
* If greater than the length of the array, actual starting index will be set to the length of the array.
* If negative, will begin that many elements from the end of the array (with origin -1) and
* will be set to 0 if absolute value is greater than the length of the array.
* @return an array containing the deleted elements.
* If only one element is removed, an array of one element is returned.
* If no elements are removed, an empty array is returned.
*/
native ArrayImage splice(int start);
/**
* This method changes the contents of an array by removing existing elements and/or adding new elements.
*
* @param start index at which to start changing the array (with origin 0).
* If greater than the length of the array, actual starting index will be set to the length of the array.
* If negative, will begin that many elements from the end of the array (with origin -1) and
* will be set to 0 if absolute value is greater than the length of the array.
* @param deleteCounts indicating the number of old array elements to remove.
* If deleteCount is omitted, or if its value is larger than array.length() - start (that is, if it is greater than the number of elements left in the array,
* starting at start), then all of the elements from start through the end of the array will be deleted.
* If deleteCount is 0 or negative, no elements are removed.
* @return an array containing the deleted elements.
* If only one element is removed, an array of one element is returned.
* If no elements are removed, an empty array is returned.
*/
native ArrayImage splice(int start, int deleteCounts);
/**
* This method changes the contents of an array by removing existing elements and/or adding new elements.
*
* @param start index at which to start changing the array (with origin 0).
* If greater than the length of the array, actual starting index will be set to the length of the array.
* If negative, will begin that many elements from the end of the array (with origin -1) and
* will be set to 0 if absolute value is greater than the length of the array.
* @param deleteCounts indicating the number of old array elements to remove.
* If deleteCount is omitted, or if its value is larger than array.length() - start (that is, if it is greater than the number of elements left in the array,
* starting at start), then all of the elements from start through the end of the array will be deleted.
* If deleteCount is 0 or negative, no elements are removed.
* @param item the element to add to the array, beginning at the start index. If you don't specify any elements, will only remove elements from the array.
* @return an array containing the deleted elements.
* If only one element is removed, an array of one element is returned.
* If no elements are removed, an empty array is returned.
*/
native ArrayImage splice(int start, int deleteCounts, Img item);
/**
* Removes all of the elements from this object. The object will be empty after this call returns.
*/
@JsOverlay
void clear() {
splice(0, length());
}
/**
* Removes the element at the specified position in this array. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was
* removed from the array.
*
* @param index the index of the element to be removed
* @return the element previously at the specified position
*/
@JsOverlay
Img remove(int index) {
return splice(index, 1).get(0);
}
/**
* Inserts the specified element at the specified position in this array. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds
* one to their indices).
*
* @param index index at which the specified element is to be inserted
* @param item element to be inserted
*/
@JsOverlay
void insertAt(int index, Img item) {
splice(index, 0, item);
}
/**
* 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.
*
* @param index the index to be retrieved
* @return the value at the given index
*/
@JsOverlay
public Img get(int index) {
return slice(index, index + 1).pop();
}
/**
* Fills all the elements of an array from a start index to an end index with a passed value. The end index is not included.
*
* @param item value to fill an array.
* @param start Start index, defaults to 0.
* @param end End index, defaults to array.length().
*/
native void fill(Img item, int start, int end);
/**
* Adds one element to the end of an array and returns the new length of the array.
*
* @param item The element to add to the end of the array.
*/
native void push(Img item);
/**
* Removes the last element from an array and returns that element. This method changes the length of the array.
*
* @return The removed element from the array; null if the array is empty.
*/
native Img pop();
/**
* Sets the value value at a given index.
*
* If the index is out of bounds, the value will still be set. The array's length will be updated to encompass the bounds implied by the added value.
*
* @param index the index to be set
* @param item the value to be stored
*/
@JsOverlay
void set(int index, Img item) {
fill(item, index, index + 1);
}
}