org.pepstock.charba.client.annotation

Class AbstractAnnotation

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.annotation.AbstractAnnotation

Direct Known Subclasses:

BoxAnnotation, LineAnnotation

public abstract class AbstractAnnotation
extends AbstractPluginOptions

Base class to define an annotation into AnnotationPlugin.ID plugin.
It contains all commons properties to define an annotation (BoxAnnotation or LineAnnotation.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
IsColor	getBorderColor() Returns the color of the border of annotation.
String	getBorderColorAsString() Returns the color of the border of annotation.
int	getBorderWidth() Returns the width of the border in pixels.
ClickCallback	getClickCallback() Returns the callback called when a "click" event is occurring.
ContextMenuCallback	getContextMenuCallback() Returns the callback called when a "contextmenu" event is occurring.
DoubleClickCallback	getDoubleClickCallback() Returns the callback called when a "dblclick" event is occurring.
DrawTime	getDrawTime() Returns the draw time which defines when the annotations are drawn.
MouseDownCallback	getMouseDownCallback() Returns the callback called when a "mousedown" event is occurring.
MouseEnterCallback	getMouseEnterCallback() Returns the callback called when a "mouseenter" event is occurring.
MouseLeaveCallback	getMouseLeaveCallback() Returns the callback called when a "mouseleave" event is occurring.
MouseMoveCallback	getMouseMoveCallback() Returns the callback called when a "mousemove" event is occurring.
MouseOutCallback	getMouseOutCallback() Returns the callback called when a "mouseout" event is occurring.
MouseOverCallback	getMouseOverCallback() Returns the callback called when a "mouseover" event is occurring.
MouseUpCallback	getMouseUpCallback() Returns the callback called when a "mouseup" event is occurring.
String	getName() Returns the name of annotation.
AnnotationType	getType() Returns the type of annotation.
WheelCallback	getWheelCallback() Returns the callback called when a "wheel" event is occurring.
void	setBorderColor(IsColor borderColor) Sets the color of the border of annotation.
void	setBorderColor(String borderColor) Sets the color of the border of annotation.
void	setBorderWidth(int borderWidth) Sets the width of the border in pixels.
void	setClickCallback(ClickCallback clickCallback) Sets the callback called when a "click" event is occurring.
void	setContextMenuCallback(ContextMenuCallback contextmenuCallback) Sets the callback called when a "contextmenu" event is occurring.
void	setDoubleClickCallback(DoubleClickCallback dblclickCallback) Sets the callback called when a "dblclick" event is occurring.
void	setDrawTime(DrawTime drawTime) Sets the draw time which defines when the annotations are drawn.
void	setMouseDownCallback(MouseDownCallback mousedownCallback) Sets the callback called when a "mousedown" event is occurring.
void	setMouseEnterCallback(MouseEnterCallback mouseenterCallback) Sets the callback called when a "mouseenter" event is occurring.
void	setMouseLeaveCallback(MouseLeaveCallback mouseleaveCallback) Sets the callback called when a "mouseleave" event is occurring.
void	setMouseMoveCallback(MouseMoveCallback mousemoveCallback) Sets the callback called when a "mousemove" event is occurring.
void	setMouseOutCallback(MouseOutCallback mouseoutCallback) Sets the callback called when a "mouseout" event is occurring.
void	setMouseOverCallback(MouseOverCallback mouseoverCallback) Sets the callback called when a "mouseover" event is occurring.
void	setMouseUpCallback(MouseUpCallback mouseupCallback) Sets the callback called when a "mouseup" event is occurring.
void	setName(String name) Sets the name of annotation.
void	setWheelCallback(WheelCallback wheelCallback) Sets the callback called when a "wheel" event is occurring.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions

getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

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

checkValue, empty, getArrayValue, getNativeChart, 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, setArrayValue, setValue, 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

Method Detail

getType

public final AnnotationType getType()

Returns the type of annotation.

Returns:

the type of annotation

setName

public final void setName(String name)

Sets the name of annotation.

Parameters:

name - the name of annotation

getName

public final String getName()

Returns the name of annotation.

Returns:

the name of annotation

setDrawTime

public final void setDrawTime(DrawTime drawTime)

Sets the draw time which defines when the annotations are drawn.

Parameters:

drawTime - the draw time which defines when the annotations are drawn

getDrawTime

public final DrawTime getDrawTime()

Returns the draw time which defines when the annotations are drawn.

Returns:

the draw time which defines when the annotations are drawn

setBorderColor

public final void setBorderColor(IsColor borderColor)

Sets the color of the border of annotation.

Parameters:

borderColor - the color of the border of annotation

setBorderColor

public final void setBorderColor(String borderColor)

Sets the color of the border of annotation.

Parameters:

borderColor - the color of the border of annotation

getBorderColor

public final IsColor getBorderColor()

Returns the color of the border of annotation.

Returns:

the color of the border of annotation

setBorderWidth

public final void setBorderWidth(int borderWidth)

Sets the width of the border in pixels.

Parameters:

borderWidth - the width of the border in pixels.

getMouseEnterCallback

public final MouseEnterCallback getMouseEnterCallback()

Returns the callback called when a "mouseenter" event is occurring.

Returns:

the callback called when a "mouseenter" event is occurring

setMouseEnterCallback

public final void setMouseEnterCallback(MouseEnterCallback mouseenterCallback)

Sets the callback called when a "mouseenter" event is occurring.

Parameters:

mouseenterCallback - the callback called when a "mouseenter" event is occurring

getMouseOverCallback

public final MouseOverCallback getMouseOverCallback()

Returns the callback called when a "mouseover" event is occurring.

Returns:

the callback called when a "mouseover" event is occurring

setMouseOverCallback

public final void setMouseOverCallback(MouseOverCallback mouseoverCallback)

Sets the callback called when a "mouseover" event is occurring.

Parameters:

mouseoverCallback - the callback called when a "mouseover" event is occurring

getMouseLeaveCallback

public final MouseLeaveCallback getMouseLeaveCallback()

Returns the callback called when a "mouseleave" event is occurring.

Returns:

the callback called when a "mouseleave" event is occurring

setMouseLeaveCallback

public final void setMouseLeaveCallback(MouseLeaveCallback mouseleaveCallback)

Sets the callback called when a "mouseleave" event is occurring.

Parameters:

mouseleaveCallback - the callback called when a "mouseleave" event is occurring

getMouseOutCallback

public final MouseOutCallback getMouseOutCallback()

Returns the callback called when a "mouseout" event is occurring.

Returns:

the callback called when a "mouseout" event is occurring

setMouseOutCallback

public final void setMouseOutCallback(MouseOutCallback mouseoutCallback)

Sets the callback called when a "mouseout" event is occurring.

Parameters:

mouseoutCallback - the callback called when a "mouseout" event is occurring

getMouseMoveCallback

public final MouseMoveCallback getMouseMoveCallback()

Returns the callback called when a "mousemove" event is occurring.

Returns:

the callback called when a "mousemove" event is occurring

setMouseMoveCallback

public final void setMouseMoveCallback(MouseMoveCallback mousemoveCallback)

Sets the callback called when a "mousemove" event is occurring.

Parameters:

mousemoveCallback - the callback called when a "mousemove" event is occurring

getMouseDownCallback

public final MouseDownCallback getMouseDownCallback()

Returns the callback called when a "mousedown" event is occurring.

Returns:

the callback called when a "mousedown" event is occurring

setMouseDownCallback

public final void setMouseDownCallback(MouseDownCallback mousedownCallback)

Sets the callback called when a "mousedown" event is occurring.

Parameters:

mousedownCallback - the callback called when a "mousedown" event is occurring

getMouseUpCallback

public final MouseUpCallback getMouseUpCallback()

Returns the callback called when a "mouseup" event is occurring.

Returns:

the callback called when a "mouseup" event is occurring

setMouseUpCallback

public final void setMouseUpCallback(MouseUpCallback mouseupCallback)

Sets the callback called when a "mouseup" event is occurring.

Parameters:

mouseupCallback - the callback called when a "mouseup" event is occurring

getClickCallback

public final ClickCallback getClickCallback()

Returns the callback called when a "click" event is occurring.

Returns:

the callback called when a "click" event is occurring

setClickCallback

public final void setClickCallback(ClickCallback clickCallback)

Sets the callback called when a "click" event is occurring.

Parameters:

clickCallback - the callback called when a "click" event is occurring

getDoubleClickCallback

public final DoubleClickCallback getDoubleClickCallback()

Returns the callback called when a "dblclick" event is occurring.

Returns:

the callback called when a "dblclick" event is occurring

setDoubleClickCallback

public final void setDoubleClickCallback(DoubleClickCallback dblclickCallback)

Sets the callback called when a "dblclick" event is occurring.

Parameters:

dblclickCallback - the callback called when a "dblclick" event is occurring

getContextMenuCallback

public final ContextMenuCallback getContextMenuCallback()

Returns the callback called when a "contextmenu" event is occurring.

Returns:

the callback called when a "contextmenu" event is occurring

setContextMenuCallback

public final void setContextMenuCallback(ContextMenuCallback contextmenuCallback)

Sets the callback called when a "contextmenu" event is occurring.

Parameters:

contextmenuCallback - the callback called when a "contextmenu" event is occurring

getWheelCallback

public final WheelCallback getWheelCallback()

Returns the callback called when a "wheel" event is occurring.

Returns:

the callback called when a "wheel" event is occurring

setWheelCallback

public final void setWheelCallback(WheelCallback wheelCallback)

Sets the callback called when a "wheel" event is occurring.

Parameters:

wheelCallback - the callback called when a "wheel" event is occurring

getBorderColorAsString

public String getBorderColorAsString()

Returns the color of the border of annotation.

Returns:

the color of the border of annotation

getBorderWidth

public int getBorderWidth()

Returns the width of the border in pixels.

Returns:

the width of the border in pixels.