Package org.pepstock.charba.client.options

Class AbstractScriptableFont<T extends ChartContext>

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractFont

org.pepstock.charba.client.options.AbstractScriptableFont<T>

Type Parameters:

T - type of scriptable context

All Implemented Interfaces:

IsDefaultFont, IsFont

Direct Known Subclasses:

Font, Font, Font

public abstract class AbstractScriptableFont<T extends ChartContext>
extends AbstractFont

Object can be provided with additional configuration by callbacks to define font options at runtime, and with the possibility to reset FontCallback if the IsScriptableFontProvider instance has been set with a FontCallback.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptableFont(IsScriptableFontProvider<T> scriptableFontProvider, IsDefaultFont defaultValues)	Creates an empty font to use for chart configuration.
protected	AbstractScriptableFont(IsScriptableFontProvider<T> scriptableFontProvider, IsDefaultFont defaultValues, NativeObject nativeObject)	Creates a font to use for chart configuration, wrapping a native object instance.

Method Summary

Modifier and Type	Method	Description
FontItem	create()	Creates a font options instance using default or cloning current instance.
String	getFamily()	Returns the font family, follows CSS font-family options.
double	getLineHeight()	Returns the height of an individual line of text.
String	getLineHeightAsString()	Returns the height of an individual line of text as string.
protected NativeObject	getObject()	Returns the native object instance.
int	getSize()	Returns the font size.
FontStyle	getStyle()	Returns the font style, follows CSS font-style options (i.e.
Weight	getWeight()	Returns the font weight, follows CSS font-style-weight options.
protected void	resetCallback()	Invokes when any property of the font is being set, in order to reset the FontCallback if exists
void	setFamily(String family)	Sets the font family, follows CSS font-family options.
void	setLineHeight(double lineHeight)	Sets the line height.
void	setLineHeight(String lineHeight)	Sets the line height.
void	setSize(int size)	Sets the font size.
void	setStyle(FontStyle style)	Sets the font style, follows CSS font-style options (i.e.
void	setWeight(Weight weight)	Sets the font weight, follows CSS font-style-weight options.

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultFont

create, create, getFamily, getLineHeight, getLineHeightAsString, getSize, getStyle, getWeight

Constructor Detail

AbstractScriptableFont

protected AbstractScriptableFont(IsScriptableFontProvider<T> scriptableFontProvider,
                                 IsDefaultFont defaultValues)

Creates an empty font to use for chart configuration.

Parameters:

scriptableFontProvider - the provider of font callback

defaultValues - default provider

AbstractScriptableFont

protected AbstractScriptableFont(IsScriptableFontProvider<T> scriptableFontProvider,
                                 IsDefaultFont defaultValues,
                                 NativeObject nativeObject)

Creates a font to use for chart configuration, wrapping a native object instance.

Parameters:

scriptableFontProvider - the provider of font callback

defaultValues - default provider

nativeObject - native object to map java script properties

Method Detail

setSize

public void setSize(int size)

Description copied from interface: IsFont

Sets the font size.

Specified by:

setSize in interface IsFont

Overrides:

setSize in class AbstractFont

Parameters:

size - the font size.

setStyle

public void setStyle(FontStyle style)

Description copied from interface: IsFont

Sets the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Specified by:

setStyle in interface IsFont

Overrides:

setStyle in class AbstractFont

Parameters:

style - Font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

setFamily

public void setFamily(String family)

Description copied from interface: IsFont

Sets the font family, follows CSS font-family options.

Specified by:

setFamily in interface IsFont

Overrides:

setFamily in class AbstractFont

Parameters:

family - Font family, follows CSS font-family options.

setWeight

public void setWeight(Weight weight)

Description copied from interface: IsFont

Sets the font weight, follows CSS font-style-weight options.

Specified by:

setWeight in interface IsFont

Overrides:

setWeight in class AbstractFont

Parameters:

weight - font weight, follows CSS font-style-weight options.

setLineHeight

public void setLineHeight(double lineHeight)

Description copied from interface: IsFont

Sets the line height.

Specified by:

setLineHeight in interface IsFont

Overrides:

setLineHeight in class AbstractFont

Parameters:

lineHeight - the line height.

setLineHeight

public void setLineHeight(String lineHeight)

Description copied from interface: IsFont

Sets the line height.

Specified by:

setLineHeight in interface IsFont

Overrides:

setLineHeight in class AbstractFont

Parameters:

lineHeight - the line height.

resetCallback

protected void resetCallback()

Invokes when any property of the font is being set, in order to reset the FontCallback if exists

getSize

public int getSize()

Description copied from interface: IsDefaultFont

Returns the font size.

Specified by:

getSize in interface IsDefaultFont

Returns:

the font size.

getStyle

public FontStyle getStyle()

Description copied from interface: IsDefaultFont

Returns the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Specified by:

getStyle in interface IsDefaultFont

Returns:

the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

getFamily

public String getFamily()

Description copied from interface: IsDefaultFont

Returns the font family, follows CSS font-family options.

Specified by:

getFamily in interface IsDefaultFont

Returns:

Font family, follows CSS font-family options.

getWeight

public Weight getWeight()

Description copied from interface: IsDefaultFont

Returns the font weight, follows CSS font-style-weight options.

Specified by:

getWeight in interface IsDefaultFont

Returns:

the font weight, follows CSS font-style-weight options.

getLineHeight

public double getLineHeight()

Description copied from interface: IsDefaultFont

Returns the height of an individual line of text.

Specified by:

getLineHeight in interface IsDefaultFont

Returns:

the height of an individual line of text.

getLineHeightAsString

public String getLineHeightAsString()

Description copied from interface: IsDefaultFont

Returns the height of an individual line of text as string.

Specified by:

getLineHeightAsString in interface IsDefaultFont

Returns:

the height of an individual line of text as string.

create

public FontItem create()

Description copied from interface: IsDefaultFont

Creates a font options instance using default or cloning current instance.

Specified by:

create in interface IsDefaultFont

Returns:

a font options instance using default or cloning current instance

getObject

protected final NativeObject getObject()

Returns the native object instance.

Returns:

the native object instance.