Package org.pepstock.charba.client.commons
Core classes to manage the inter-operations with java script code. Contains also common classes to use on all packages.
- Author:
- Andrea "Stock" Stocchero
-
Interface Summary Interface Description ArrayObject.ArrayFilterCallback Java script FUNCTION callback called to filter the array.ArrayObject.ArrayFindCallback Java script FUNCTION callback called to find an element in the array.CallbackProxy.Proxy It's a java script function which maps the functionproxy
implemented in the additional java script source.Envelop This is the interface to map the envelop.
It adds helpful methods to check the envelop.HasCallbackScope Interface to manage the scope of the options, which is the options are used for defaults, chart defaults or chart.IsBuilder Represents an options builder.
Needed to check the consistency of builder after build.IsJSType Empty interface to define native object as native in order to useReflect
to set and get objects inNativeObject
.IsPoint This interface is defining an object which represents a point, with x and y coordinates.Key Represents the property key of a JavaScript object.
Used for enum.KeyFactory<T extends Key> Interface to be implemented to load keys from an array of native object.NativeArrayContainerFactory<A extends Array,T extends NativeArrayContainer<A>> Interface to be implemented to load elements from an array of native array.NativeObject Base object for all native objects implemented in Charba.
it wraps java script object with and withoutprototype
.
It's also mapping the java scriptproxy
, used by CHART.JS.
PAY ATTENTION that the java script object class name is "?" because otherwise J2CL is not able to cast to an object.
Please be also aware that you can not useinstanceof
against this class.NativeObjectContainerFactory<T extends NativeObjectContainer> Interface to be implemented to load elements from an array of native object.PropertyKey Represents the key of property of a java-script object. -
Class Summary Class Description AbstractBaseBuilder base calss to implement builder classes in order to use a builder in consistent manner, a builder instance for a result object one.AbstractNode Base class for all options nodes, which will wraps a native object and manages the relations about parent and children elements.AbstractPoint This object is wrapping the native java script object to map a point.AbstractReadOnlyPoint This object is wrapping the native java script object to map a point, in READ-ONLY mode.Array Array object which maps the java script object.ArrayCanvas Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (HTMLCanvasElement) values.ArrayCanvasList An ordered collection (also known as a sequence).ArrayChart Array object which maps the java script object.
A simple wrapper around a homogeneous native array of chart values.ArrayDouble Array object which maps the java script object.
A simple wrapper around a homogeneous native array of numeric (doubles) values.ArrayDoubleArray Array object which maps the java script object.
A simple wrapper around a homogeneous native array of arrays of numeric (doubles) values.ArrayDoubleArrayList<E extends NativeArrayContainer<ArrayDouble>> An ordered collection (also known as a sequence).ArrayDoubleList The user of this interface has precise control over where in the list each element is inserted.ArrayEnumList<E extends Key> The user of this interface has precise control over where in the list each element is inserted.ArrayGradient Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (CanvasGradientItem) values.ArrayImage Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (ImageElement) values.ArrayImageList An ordered collection (also known as a sequence).ArrayInteger Array object which maps the java script object.
A simple wrapper around a homogeneous native array of numeric (int) values.ArrayIntegerList The user of this interface has precise control over where in the list each element is inserted.ArrayKeyList<E extends Key> The user of this interface has precise control over where in the list each element is inserted.ArrayKeySet<E extends Key> A collection that contains no duplicate elements.
More formally, sets contain no pair of elementse1
ande2
such thate1.equals(e2)
, and at most one null element.ArrayListHelper Utility to create array list objects from java script arrays.ArrayMixedObject Array object which maps the java script object.
A simple wrapper around a homogeneous array of mixed type of object (extension of java script objects) values.ArrayObject Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (extension of java script objects) values.ArrayObjectContainerList<E extends NativeObjectContainer> An ordered collection (also known as a sequence).ArrayObjectList An ordered collection (also known as a sequence).ArrayPattern Array object which maps the java script object.
A simple wrapper around a homogeneous native array of object (CanvasPatternItem) values.ArraySetHelper Utility to create array set objects from java script arrays.ArrayString Array object which maps the java script object.
A simple wrapper around a homogeneous native array of string values.ArrayStringList An ordered collection (also known as a sequence).ArrayStringSet A collection that contains no duplicate elements.
More formally, sets contain no pair of elementse1
ande2
such thate1.equals(e2)
, and at most one null element.ArrayUtil Utility to transform arrays and list of objects to primitives.
The code has been changed in order to be aligned with internal needs, taking the source from ArrayUtils of Apache common lang3..BaseEnvelop<T> This object is a container of hidden object.CallbackPropertyHandler<T> It is managing property where can set a callback.
It uses a cache in order to be able to use the callback even if defined at default or chart options level, both for chart or plugin options.CallbackProxy<T> This is a native object which wraps a java script object created byJsHelper
.
This object is used to get a proxy instance which is able to call a java script function passing alsothis
java script value, to maintain the environment when required.Checker Utility which provides a set o methods to check the values of numbers.ConfigurationLoader Utility to load java script object in the CHART-JS configuration.
This utility needs to reduce visibility on java script objects for configuration.Constants Contains all constants where values can be used in different packages.ImmutableDate Class acting as an immutable date class based on theDate
class.
ThrowsUnsupportedOperationException
when mutable methods are invoked.ImmutableEnvelop<T> This object is a container of hidden object which can set by constructor and immutable afterwards.IteratorImpl<E> Custom iterator over a collection.JsHelper This is a singleton wrapper for Java native object which is wrapping a CHARBA java script object implementation with some utilities to act on java script objects.ListIteratorImpl<E> An iterator for lists that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list.Merger Singleton utility to merge java script object in the another one and provide the service to get the chart options with all defaults.NativeArrayContainer<T extends Array> Base class for all classes which are wrapping a native java script array.NativeArrayDoubleContainer Extends the base class of an array container where the wrapped array is an array of doubles.NativeName Constants with java script object name to use in theJsType
native objects.NativeObjectContainer Base class for all classes which are wrapping a native java script object.PropertyHandler<D> Base object to to manage common properties in the options or configuration.
To reduce the duplication of code, this calls helps to manage the same property or properties on different objects, without extending them.StandardKey This is a standard implementation of a key of property inside a Java script object.
The standard is the key name is a String. -
Enum Summary Enum Description Id Enums the property ID used by CHARBA to identify the chart.ObjectType Enumerates all java script types.
The latest ECMAScript standard defines seven data types:
Six data types that are primitives:
Boolean Function Undefined Number String Symbol
and other 2 objects types:
Object Array
See https://developer.mozilla.org/it/docs/Web/JavaScript/Reference/Operators/typeof