org.pepstock.charba.client.zoom

Class AbstractConfigurationItem

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.zoom.AbstractConfigurationItem

Direct Known Subclasses:

Pan, Zoom

public abstract class AbstractConfigurationItem
extends NativeObjectContainer

Abstract element used by pan and zoom object in order to enable to provide the configuration of ZoomPlugin.ID.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED Default enabled, false.
static InteractionAxis	DEFAULT_MODE Default mode directions, InteractionAxis.XY.

Method Summary

Modifier and Type	Method and Description
CompleteCallback	getCompleteCallback() Returns the callback called once zooming or panning is completed.
InteractionAxis	getMode() Returns the element (panning or zooming) directions.
ModeCallback	getModeCallback() Returns the element (panning or zooming) directions callback, to set the mode at runtime.
ProgressCallback	getProgressCallback() Returns the callback called while the user is zooming or panning.
Range	getRangeMax() Returns the maximum element (panning or zooming) range depending on scale type.
Range	getRangeMin() Returns the minimum element (panning or zooming) range depending on scale type.
boolean	isEnabled() Returns true to enable element (panning or zooming).
void	setCompleteCallback(CompleteCallback completeCallback) Sets the callback called once zooming or panning is completed.
void	setEnabled(boolean enabled) Sets true to enable element (panning or zooming).
void	setMode(InteractionAxis mode) Sets the element (panning or zooming) directions.
void	setMode(ModeCallback modeCallback) Sets the element (panning or zooming) directions callback, to set the mode at runtime.
void	setProgressCallback(ProgressCallback progressCallback) Sets the callback called while the user is zooming or panning.

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

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default enabled, false.

See Also:

Constant Field Values

DEFAULT_MODE

public static final InteractionAxis DEFAULT_MODE

Default mode directions, InteractionAxis.XY.

Method Detail

setEnabled

public final void setEnabled(boolean enabled)

Sets true to enable element (panning or zooming).

Parameters:

enabled - true to enable element (panning or zooming)

isEnabled

public final boolean isEnabled()

Returns true to enable element (panning or zooming).

Returns:

true to enable element (panning or zooming)

setMode

public final void setMode(InteractionAxis mode)

Sets the element (panning or zooming) directions.

Parameters:

mode - the element (panning or zooming) directions

getMode

public final InteractionAxis getMode()

Returns the element (panning or zooming) directions.

Returns:

the element (panning or zooming) directions

getModeCallback

public final ModeCallback getModeCallback()

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

Returns:

the element (panning or zooming) directions callback

setMode

public final void setMode(ModeCallback modeCallback)

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

Parameters:

modeCallback - the element (panning or zooming) directions callback

getRangeMin

public final Range getRangeMin()

Returns the minimum element (panning or zooming) range depending on scale type.

Returns:

the minimum element (panning or zooming) range depending on scale type

getRangeMax

public final Range getRangeMax()

Returns the maximum element (panning or zooming) range depending on scale type.

Returns:

the maximum element (panning or zooming) range depending on scale type

getProgressCallback

public final ProgressCallback getProgressCallback()

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

Returns:

the callback called while the user is zooming or panning

setProgressCallback

public final void setProgressCallback(ProgressCallback progressCallback)

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

Parameters:

progressCallback - the callback called while the user is zooming or panning

getCompleteCallback

public final CompleteCallback getCompleteCallback()

Returns the callback called once zooming or panning is completed.

Returns:

the callback called once zooming or panning is completed

setCompleteCallback

public final void setCompleteCallback(CompleteCallback completeCallback)

Sets the callback called once zooming or panning is completed.

Parameters:

completeCallback - the callback called once zooming or panning is completed