org.pepstock.charba.client.options

Class AbstractElement<D extends IsDefaultOptionsElement>

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractElement<D>

Type Parameters:

D - defaults provider class

Direct Known Subclasses:

Arc, Line, Point, Rectangle

public abstract class AbstractElement<D extends IsDefaultOptionsElement>
extends NativeObjectContainer

Options can be configured for four different types of elements: arc, lines, points, and rectangles.
When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
IsColor	getBackgroundColor() Returns the background color.
String	getBackgroundColorAsString() Returns the background color.
IsColor	getBorderColor() Returns the border color.
String	getBorderColorAsString() Returns the border color.
int	getBorderWidth() Returns the border width.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
void	setBackgroundColor(IsColor backgroundColor) Sets the background color.
void	setBackgroundColor(String backgroundColor) Sets the background color.
void	setBorderColor(IsColor borderColor) Sets the border color.
void	setBorderColor(String borderColor) Sets the border color.
void	setBorderWidth(int borderWidth) Sets the border width.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.

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

checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

Method Detail

setBackgroundColor

public final void setBackgroundColor(IsColor backgroundColor)

Sets the background color.

Parameters:

backgroundColor - the background color.

setBackgroundColor

public final void setBackgroundColor(String backgroundColor)

Sets the background color.

Parameters:

backgroundColor - the background color.

getBackgroundColorAsString

public final String getBackgroundColorAsString()

Returns the background color.

Returns:

the background color.

getBackgroundColor

public final IsColor getBackgroundColor()

Returns the background color.

Returns:

the background color.

setBorderWidth

public final void setBorderWidth(int borderWidth)

Sets the border width.

Parameters:

borderWidth - the border width.

getBorderWidth

public final int getBorderWidth()

Returns the border width.

Returns:

the border width.

setBorderColor

public final void setBorderColor(IsColor borderColor)

Sets the border color.

Parameters:

borderColor - the border color.

setBorderColor

public final void setBorderColor(String borderColor)

Sets the border color.

Parameters:

borderColor - the border color.

getBorderColorAsString

public final String getBorderColorAsString()

Returns the border color.

Returns:

the border color.

getBorderColor

public final IsColor getBorderColor()

Returns the border color.

Returns:

the border color.

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.