Package org.pepstock.charba.client.options

Class ExtendedScale

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.options.AbstractModel<Options,IsDefaultScale>

org.pepstock.charba.client.options.AbstractScale

org.pepstock.charba.client.options.Scale

org.pepstock.charba.client.options.ExtendedScale

All Implemented Interfaces:

HasLabels, IsDefaultScale

public final class ExtendedScale
extends Scale

Scale options used internally inside the chart configuration.
Extends the normal scale options with all methods to add callbacks and events.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor	Description
ExtendedScale(ConfigurationEnvelop<Scale> envelop, IsDefaultScale defaultValues)	Creates a scale with the chart options scale as inner object.
ExtendedScale(ConfigurationEnvelop<ScaleId> envelop, AxisType type, AxisKind kind, IsDefaultScale defaultValues)	Creates a scale with default provider. The native object is created empty.

Method Summary

Modifier and Type	Method	Description
int	getCharbaId()	Returns the unique id of scale.
<T extends NativeObjectContainer> T	getRemappedOptions(ControllerMapperFactory<T> factory)	Returns the options, mapped with a custom object, used for controllers to map the options. It uses a factory instance to create a customized options. If factory argument is not consistent, null is returned.
void	setCallback(ConfigurationEnvelop<AbstractNode> envelop, Key property, NativeCallback callback)	Adds a native callback function to a element node instance.
void	setCallback(ConfigurationEnvelop<AbstractNode> envelop, Key property, CallbackProxy.Proxy proxy)	Adds a callback proxy function to a element node instance.

Methods inherited from class org.pepstock.charba.client.options.Scale

getAxis, getId, getType

Methods inherited from class org.pepstock.charba.client.options.AbstractScale

getAdapters, getAngleLines, getBackgroundColor, getBackgroundColorAsString, getBounds, getDisplay, getGrace, getGraceAsPercentage, getGrid, getLabelsHandler, getMax, getMaxAsDate, getMaxAsString, getMaxIndex, getMin, getMinAsDate, getMinAsString, getMinIndex, getPointLabels, getPosition, getStack, getStackWeight, getStartAngle, getSuggestedMax, getSuggestedMin, getTicks, getTime, getTitle, getWeight, isAlignToPixels, isAnimate, isBeginAtZero, isOffset, isReverse, isSingleStacked, isStacked, setAlignToPixels, setAnimate, setBackgroundColor, setBackgroundColor, setBeginAtZero, setBounds, setDisplay, setDisplay, setGrace, setGraceAsPercentage, setLabels, setLabels, setMax, setMax, setMax, setMaxIndex, setMin, setMin, setMin, setMinIndex, setOffset, setPosition, setReverse, setSingleStacked, setStack, setStacked, setStackWeight, setStartAngle, setSuggestedMax, setSuggestedMin, setWeight

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.data.HasLabels

getLabels, getLabels, setLabels

Constructor Detail

ExtendedScale

public ExtendedScale(ConfigurationEnvelop<ScaleId> envelop,
                     AxisType type,
                     AxisKind kind,
                     IsDefaultScale defaultValues)

Creates a scale with default provider.
The native object is created empty.

Parameters:

envelop - envelop with the scale id

type - scale type

kind - kind of axis

defaultValues - default provider.

ExtendedScale

public ExtendedScale(ConfigurationEnvelop<Scale> envelop,
                     IsDefaultScale defaultValues)

Creates a scale with the chart options scale as inner object.

Parameters:

envelop - envelop with the scale of chart options

defaultValues - default provider.

Method Detail

getCharbaId

public int getCharbaId()

Returns the unique id of scale.

Returns:

the unique id of scale

setCallback

public void setCallback(ConfigurationEnvelop<AbstractNode> envelop,
                        Key property,
                        CallbackProxy.Proxy proxy)

Adds a callback proxy function to a element node instance.

Parameters:

envelop - contains the element node instance to update

property - property name

proxy - the function proxy to activate

setCallback

public void setCallback(ConfigurationEnvelop<AbstractNode> envelop,
                        Key property,
                        NativeCallback callback)

Adds a native callback function to a element node instance.

Parameters:

envelop - contains the element node instance to update

property - property name

callback - the function callback to activate

getRemappedOptions

public final <T extends NativeObjectContainer> T getRemappedOptions(ControllerMapperFactory<T> factory)

Returns the options, mapped with a custom object, used for controllers to map the options.
It uses a factory instance to create a customized options.
If factory argument is not consistent, null is returned.

Type Parameters:

T - type of customized options to return

Parameters:

factory - factory instance to create a customized options

Returns:

customized options.
If factory argument is not consistent, null is returned.