Package org.pepstock.charba.client.data

Class BarBorderWidth

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.BarBorderWidth

public final class BarBorderWidth
extends NativeObjectContainer

Defines the border width for BAR data set (left, top, right, bottom).

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BarBorderWidth.BarBorderWidthFactory	Inner class to create bar border width object by a native object.

Field Summary

Fields

Modifier and Type	Field	Description
static BarBorderWidth.BarBorderWidthFactory	FACTORY	Public factory to create a border width object from a native object.

Constructor Summary

Constructors

Constructor	Description
BarBorderWidth()	Creates the object with an empty native object instance.
BarBorderWidth(int borderWidth)	Creates the object using the argument to set the border width size to all corners of the rectangle.

Method Summary

Modifier and Type	Method	Description
boolean	areValuesEquals()	Returns true if all values of object are equals.
int	average()	Returns the average value of all values managed by object.
int	getBottom()	Returns the border width bottom in pixel.
int	getLeft()	Returns the border width left in pixel.
int	getRight()	Returns the border width right in pixel.
int	getTop()	Returns the border width top in pixel.
NativeObject	nativeObject()	Returns the native object instance.
void	set(int borderWidth)	Sets the border width size to all dimensions.
void	setBottom(int borderWidth)	Sets the border width bottom in pixel.
void	setLeft(int borderWidth)	Sets the border width left in pixel.
void	setRight(int borderWidth)	Sets the border width right in pixel.
void	setTop(int borderWidth)	Sets the border width top in pixel.

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

FACTORY

public static final BarBorderWidth.BarBorderWidthFactory FACTORY

Public factory to create a border width object from a native object.

Constructor Detail

BarBorderWidth

public BarBorderWidth()

Creates the object with an empty native object instance.

BarBorderWidth

public BarBorderWidth(int borderWidth)

Creates the object using the argument to set the border width size to all corners of the rectangle.

Parameters:

borderWidth - border width size to apply to all dimensions.

Method Detail

set

public void set(int borderWidth)

Sets the border width size to all dimensions.

Parameters:

borderWidth - border width size to apply to all dimensions.

setLeft

public void setLeft(int borderWidth)

Sets the border width left in pixel.

Parameters:

borderWidth - the border width left in pixel.

getLeft

public int getLeft()

Returns the border width left in pixel.

Returns:

the border width left in pixel.

setRight

public void setRight(int borderWidth)

Sets the border width right in pixel.

Parameters:

borderWidth - the border width right in pixel.

getRight

public int getRight()

Returns the border width right in pixel.

Returns:

the border width right in pixel.

setTop

public void setTop(int borderWidth)

Sets the border width top in pixel.

Parameters:

borderWidth - the border width top in pixel.

getTop

public int getTop()

Returns the border width top in pixel.

Returns:

the border width top in pixel.

setBottom

public void setBottom(int borderWidth)

Sets the border width bottom in pixel.

Parameters:

borderWidth - the border width bottom in pixel.

getBottom

public int getBottom()

Returns the border width bottom in pixel.

Returns:

the border width bottom in pixel.

areValuesEquals

public final boolean areValuesEquals()

Returns true if all values of object are equals.

Returns:

true if all values of object are equals

average

public final int average()

Returns the average value of all values managed by object.

Returns:

the average value of all values managed by object

nativeObject

public final NativeObject nativeObject()

Returns the native object instance.

Returns:

the native object instance.