Package org.pepstock.charba.client.zoom

Class AbstractConfigurationItem

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.zoom.AbstractConfigurationItem

Direct Known Subclasses:

Pan, Zoom

public abstract class AbstractConfigurationItem
extends AbstractNode

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	Description
static Mode	DEFAULT_MODE	Default mode directions, Mode.XY.
static Mode	DEFAULT_OVER_SCALE_MODE	Default mode directions, when over the scale, Mode.XY.

Method Summary

Modifier and Type	Method	Description
CompletedCallback	getCompletedCallback()	Returns the callback called once zooming or panning is completed.
Mode	getMode()	Returns the element (panning or zooming) directions.
ModeCallback	getModeCallback()	Returns the element (panning or zooming) directions callback, to set the mode at runtime.
Mode	getOverScaleMode()	Returns which of the enabled zooming directions should only be available when the mouse cursor is over one of scale.
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
ProgressCallback	getProgressCallback()	Returns the callback called while the user is zooming or panning.
RejectedCallback	getRejectedCallback()	Returns the callback called once zooming or panning is completed.
StartCallback	getStartCallback()	Returns the callback called once zooming or panning is started.
void	setCompletedCallback(CompletedCallback completeCallback)	Sets the callback called once zooming or panning is completed.
void	setMode(NativeCallback modeCallback)	Sets the element (panning or zooming) directions callback, to set the mode at runtime.
void	setMode(ModeCallback modeCallback)	Sets the element (panning or zooming) directions callback, to set the mode at runtime.
void	setMode(Mode mode)	Sets the element (panning or zooming) directions.
void	setOverScaleMode(NativeCallback modeCallback)	Sets 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
void	setOverScaleMode(ModeCallback modeCallback)	Sets 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
void	setOverScaleMode(Mode mode)	Sets which of the enabled zooming directions should only be available when the mouse cursor is over one of scale. If under mouse hasn't scale, then return all other scales which 'mode' is different with overScaleMode. So 'overScaleMode' works as a limiter to scale the user-selected scale (in 'mode') only when the cursor is under the scale, and other directions in 'mode' works as before.
void	setProgressCallback(ProgressCallback progressCallback)	Sets the callback called while the user is zooming or panning.
void	setRejectedCallback(RejectedCallback rejectCallback)	Sets the callback called once zooming or panning is rejected.
void	setStartCallback(StartCallback startCallback)	Sets the callback called once zooming or panning is started.

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

Field Detail

DEFAULT_MODE

public static final Mode DEFAULT_MODE

Default mode directions, Mode.XY.

DEFAULT_OVER_SCALE_MODE

public static final Mode DEFAULT_OVER_SCALE_MODE

Default mode directions, when over the scale, Mode.XY.

Method Detail

setMode

public final void setMode(Mode mode)

Sets the element (panning or zooming) directions.

Parameters:

mode - the element (panning or zooming) directions

getMode

public final Mode getMode()

Returns the element (panning or zooming) directions.

Returns:

the element (panning or zooming) directions

setOverScaleMode

public final void setOverScaleMode(Mode mode)

Sets which of the enabled zooming directions should only be available when the mouse cursor is over one of scale.
If under mouse hasn't scale, then return all other scales which 'mode' is different with overScaleMode.
So 'overScaleMode' works as a limiter to scale the user-selected scale (in 'mode') only when the cursor is under the scale, and other directions in 'mode' works as before.

Parameters:

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

getOverScaleMode

public final 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 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

setMode

public final void setMode(NativeCallback modeCallback)

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

Parameters:

modeCallback - the element (panning or zooming) directions callback

getOverScaleModeCallback

public final 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

setOverScaleMode

public final void setOverScaleMode(ModeCallback modeCallback)

Sets 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

Parameters:

modeCallback - the element (panning or zooming) directions callback

setOverScaleMode

public final void setOverScaleMode(NativeCallback modeCallback)

Sets 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

Parameters:

modeCallback - the element (panning or zooming) directions callback

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

getCompletedCallback

public final CompletedCallback getCompletedCallback()

Returns the callback called once zooming or panning is completed.

Returns:

the callback called once zooming or panning is completed

setCompletedCallback

public final void setCompletedCallback(CompletedCallback completeCallback)

Sets the callback called once zooming or panning is completed.

Parameters:

completeCallback - the callback called once zooming or panning is completed

getRejectedCallback

public final RejectedCallback getRejectedCallback()

Returns the callback called once zooming or panning is completed.

Returns:

the callback called once zooming or panning is completed

setRejectedCallback

public final void setRejectedCallback(RejectedCallback rejectCallback)

Sets the callback called once zooming or panning is rejected.

Parameters:

rejectCallback - the callback called once zooming or panning is rejected

getStartCallback

public final StartCallback getStartCallback()

Returns the callback called once zooming or panning is started.

Returns:

the callback called once zooming or panning is started

setStartCallback

public final void setStartCallback(StartCallback startCallback)

Sets the callback called once zooming or panning is started.

Parameters:

startCallback - the callback called once zooming or panning is started