org.pepstock.charba.client.options

Class Padding

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Padding

All Implemented Interfaces:

IsDefaultPadding

public final class Padding
extends NativeObjectContainer

It is applied to all sides of the chart (left, top, right, bottom).

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.
int	getBottom() Returns the padding bottom in pixel.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
int	getLeft() Returns the padding left in pixel.
protected P	getParent() Returns the parent element.
int	getRight() Returns the padding right in pixel.
int	getTop() Returns the padding top in pixel.
void	set(int padding) Sets the padding size to all dimensions.
void	setBottom(int padding) Sets the padding bottom in pixel.
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.
void	setLeft(int padding) Sets the padding left in pixel.
void	setRight(int padding) Sets the padding right in pixel.
void	setTop(int padding) Sets the padding top in pixel.

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

Method Detail

set

public final void set(int padding)

Sets the padding size to all dimensions.

Parameters:

padding - padding size to apply to all dimensions.

setLeft

public final void setLeft(int padding)

Sets the padding left in pixel.

Parameters:

padding - the padding left in pixel.

getLeft

public final int getLeft()

Returns the padding left in pixel.

Specified by:

getLeft in interface IsDefaultPadding

Returns:

the padding left in pixel.

setRight

public final void setRight(int padding)

Sets the padding right in pixel.

Parameters:

padding - the padding right in pixel.

getRight

public final int getRight()

Returns the padding right in pixel.

Specified by:

getRight in interface IsDefaultPadding

Returns:

the padding right in pixel.

setTop

public final void setTop(int padding)

Sets the padding top in pixel.

Parameters:

padding - the padding top in pixel.

getTop

public final int getTop()

Returns the padding top in pixel.

Specified by:

getTop in interface IsDefaultPadding

Returns:

the padding top in pixel.

setBottom

public final void setBottom(int padding)

Sets the padding bottom in pixel.

Parameters:

padding - the padding bottom in pixel.

getBottom

public final int getBottom()

Returns the padding bottom in pixel.

Specified by:

getBottom in interface IsDefaultPadding

Returns:

the padding bottom in pixel.

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.