Package org.pepstock.charba.client.zoom

Class Zoom

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.zoom.AbstractConfigurationItem

org.pepstock.charba.client.zoom.Zoom

public final class Zoom
extends AbstractConfigurationItem

Base object to map zoom options for ZoomPlugin.ID plugin configuration.
It represents the container for ZOOM options.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields inherited from class org.pepstock.charba.client.zoom.AbstractConfigurationItem

DEFAULT_MODE, DEFAULT_OVER_SCALE_MODE, DEFAULT_SCALE_MODE

Method Summary

Modifier and Type	Method	Description
default CompletedCallback	getCompletedCallback()	Returns the callback called once zooming or panning is completed.
Drag	getDrag()	Returns the drag-to-zoom effect.
default Mode	getMode()	Returns the element (panning or zooming) directions.
default ModeCallback	getModeCallback()	Returns the element (panning or zooming) directions callback, to set the mode at runtime.
default Mode	getOverScaleMode()	Returns which of the enabled zooming directions should only be available when the mouse cursor is over one of scale.
default ModeCallback	getOverScaleModeCallback()	Returns the element (panning or zooming) directions callback, to set the mode at runtime, which of the enabled zooming directions should only be available when the mouse cursor is over one of scale
Pinch	getPinch()	Returns the pinch-to-zoom effect.
default ProgressCallback	getProgressCallback()	Returns the callback called while the user is zooming or panning.
default RejectedCallback	getRejectedCallback()	Returns the callback called once zooming or panning is rejected.
default Mode	getScaleMode()	Returns panning over a scale for that axis (regardless of mode).
default ModeCallback	getScaleModeCallback()	Returns the element directions callback, to enable panning over a scale for that axis (regardless of mode).
default StartCallback	getStartCallback()	Returns the callback called once zooming or panning is started.
Wheel	getWheel()	Returns the wheel-to-zoom effect.

Methods inherited from class org.pepstock.charba.client.zoom.AbstractConfigurationItem

getCompletedCallback, getMode, getModeCallback, getOverScaleMode, getOverScaleModeCallback, getProgressCallback, getRejectedCallback, getScaleMode, getScaleModeCallback, getStartCallback, setCompletedCallback, setMode, setMode, setMode, setOverScaleMode, setOverScaleMode, setOverScaleMode, setProgressCallback, setRejectedCallback, setScaleMode, setScaleMode, setScaleMode, setStartCallback

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, 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

checkAndGetColor, 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, 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, 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

Method Detail

getWheel

public Wheel getWheel()

Returns the wheel-to-zoom effect.

Returns:

the wheel-to-zoom effect

getDrag

public Drag getDrag()

Returns the drag-to-zoom effect.

Returns:

the drag-to-zoom effect

getPinch

public Pinch getPinch()

Returns the pinch-to-zoom effect.

Returns:

the pinch-to-zoom effect

getMode

public default Mode getMode()

Returns the element (panning or zooming) directions.

Returns:

the element (panning or zooming) directions

getScaleMode

public default Mode getScaleMode()

Returns panning over a scale for that axis (regardless of mode).

Returns:

panning over a scale for that axis (regardless of mode).

getOverScaleMode

public default Mode getOverScaleMode()

Returns which of the enabled zooming directions should only be available when the mouse cursor is over one of scale.

Returns:

which of the enabled zooming directions should only be available when the mouse cursor is over one of scale

getModeCallback

public default ModeCallback getModeCallback()

Returns the element (panning or zooming) directions callback, to set the mode at runtime.

Returns:

the element (panning or zooming) directions callback

getScaleModeCallback

public default ModeCallback getScaleModeCallback()

Returns the element directions callback, to enable panning over a scale for that axis (regardless of mode).

Returns:

the element directions callback

getOverScaleModeCallback

public default ModeCallback getOverScaleModeCallback()

Returns the element (panning or zooming) directions callback, to set the mode at runtime, which of the enabled zooming directions should only be available when the mouse cursor is over one of scale

Returns:

the element (panning or zooming) directions callback

getProgressCallback

public default ProgressCallback getProgressCallback()

Returns the callback called while the user is zooming or panning.

Returns:

the callback called while the user is zooming or panning

getCompletedCallback

public default CompletedCallback getCompletedCallback()

Returns the callback called once zooming or panning is completed.

Returns:

the callback called once zooming or panning is completed

getRejectedCallback

public default RejectedCallback getRejectedCallback()

Returns the callback called once zooming or panning is rejected.

Returns:

the callback called once zooming or panning is rejected

getStartCallback

public default StartCallback getStartCallback()

Returns the callback called once zooming or panning is started.

Returns:

the callback called once zooming or panning is started