org.pepstock.charba.client.defaults.globals

Class DefaultTooltips

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultTooltips

All Implemented Interfaces:

IsDefaultTooltips

public final class DefaultTooltips
extends Object
implements IsDefaultTooltips

CHART.JS default values for TOOLTIPS element.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DefaultTooltips()

Method Summary

Modifier and Type	Method and Description
String	getBackgroundColorAsString() Returns the background color of the tooltip.
TextAlign	getBodyAlign() Returns the body alignment.
String	getBodyFontColorAsString() Returns the body font color.
String	getBodyFontFamily() Returns the body line font.
int	getBodyFontSize() Returns the body font size.
FontStyle	getBodyFontStyle() Returns the body font style.
int	getBodySpacing() Returns the spacing to add to top and bottom of each tooltip item.
String	getBorderColorAsString() Returns the color of the border.
int	getBorderWidth() Returns the size of the border.
int	getCaretPadding() Returns the extra distance to move the end of the tooltip arrow away from the tooltip point.
int	getCaretSize() Returns the size, in px, of the tooltip arrow.
int	getCornerRadius() Returns the radius of tooltip corner curves.
TextAlign	getFooterAlign() Returns the footer alignment.
String	getFooterFontColorAsString() Returns the footer font color.
String	getFooterFontFamily() Returns the footer font.
int	getFooterFontSize() Returns the footer font size.
FontStyle	getFooterFontStyle() Returns the footer font style.
int	getFooterMarginTop() Returns the margin to add before drawing the footer.
int	getFooterSpacing() Returns the spacing to add to top and bottom of each footer line.
InteractionMode	getMode() Returns which elements appear in the tooltip.
String	getMultiKeyBackgroundAsString() Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
TooltipPosition	getPosition() Returns the mode for positioning the tooltip.
TextAlign	getTitleAlign() Returns the title alignment.
String	getTitleFontColorAsString() Returns the title font color.
String	getTitleFontFamily() Returns the title font.
int	getTitleFontSize() Returns the title font size.
FontStyle	getTitleFontStyle() Returns the title font style.
int	getTitleMarginBottom() Returns the margin to add on bottom of title section.
int	getTitleSpacing() Returns the spacing to add to top and bottom of each title line.
int	getXPadding() Returns the padding to add on left and right of tooltip.
int	getYPadding() Returns the padding to add on top and bottom of tooltip.
boolean	isDisplayColors() If true, color boxes are shown in the tooltip.
boolean	isEnabled() Returns if tooltips are enabled.
boolean	isIntersect() if true, the tooltip mode applies only when the mouse position intersects with an element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTooltips

public DefaultTooltips()

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: IsDefaultTooltips

Returns if tooltips are enabled.

Specified by:

isEnabled in interface IsDefaultTooltips

Returns:

if tooltips are enabled.

getMode

public InteractionMode getMode()

Description copied from interface: IsDefaultTooltips

Returns which elements appear in the tooltip.

Specified by:

getMode in interface IsDefaultTooltips

Returns:

which elements appear in the tooltip.

isIntersect

public boolean isIntersect()

Description copied from interface: IsDefaultTooltips

if true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times.

Specified by:

isIntersect in interface IsDefaultTooltips

Returns:

if true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times.

getPosition

public TooltipPosition getPosition()

Description copied from interface: IsDefaultTooltips

Returns the mode for positioning the tooltip.

Specified by:

getPosition in interface IsDefaultTooltips

Returns:

mode for positioning the tooltip.

getBackgroundColorAsString

public String getBackgroundColorAsString()

Description copied from interface: IsDefaultTooltips

Returns the background color of the tooltip.

Specified by:

getBackgroundColorAsString in interface IsDefaultTooltips

Returns:

Background color of the tooltip.

getTitleFontFamily

public String getTitleFontFamily()

Description copied from interface: IsDefaultTooltips

Returns the title font.

Specified by:

getTitleFontFamily in interface IsDefaultTooltips

Returns:

the title font.

getTitleFontSize

public int getTitleFontSize()

Description copied from interface: IsDefaultTooltips

Returns the title font size.

Specified by:

getTitleFontSize in interface IsDefaultTooltips

Returns:

Title font size.

getTitleFontStyle

public FontStyle getTitleFontStyle()

Description copied from interface: IsDefaultTooltips

Returns the title font style.

Specified by:

getTitleFontStyle in interface IsDefaultTooltips

Returns:

title font style.

getTitleAlign

public TextAlign getTitleAlign()

Description copied from interface: IsDefaultTooltips

Returns the title alignment.

Specified by:

getTitleAlign in interface IsDefaultTooltips

Returns:

title alignment.

getTitleFontColorAsString

public String getTitleFontColorAsString()

Description copied from interface: IsDefaultTooltips

Returns the title font color.

Specified by:

getTitleFontColorAsString in interface IsDefaultTooltips

Returns:

title font color.

getTitleSpacing

public int getTitleSpacing()

Description copied from interface: IsDefaultTooltips

Returns the spacing to add to top and bottom of each title line.

Specified by:

getTitleSpacing in interface IsDefaultTooltips

Returns:

spacing to add to top and bottom of each title line.

getTitleMarginBottom

public int getTitleMarginBottom()

Description copied from interface: IsDefaultTooltips

Returns the margin to add on bottom of title section.

Specified by:

getTitleMarginBottom in interface IsDefaultTooltips

Returns:

margin to add on bottom of title section.

getBodyFontFamily

public String getBodyFontFamily()

Description copied from interface: IsDefaultTooltips

Returns the body line font.

Specified by:

getBodyFontFamily in interface IsDefaultTooltips

Returns:

body line font.

getBodyFontSize

public int getBodyFontSize()

Description copied from interface: IsDefaultTooltips

Returns the body font size.

Specified by:

getBodyFontSize in interface IsDefaultTooltips

Returns:

body font size.

getBodyFontStyle

public FontStyle getBodyFontStyle()

Description copied from interface: IsDefaultTooltips

Returns the body font style.

Specified by:

getBodyFontStyle in interface IsDefaultTooltips

Returns:

body font style.

getBodyAlign

public TextAlign getBodyAlign()

Description copied from interface: IsDefaultTooltips

Returns the body alignment.

Specified by:

getBodyAlign in interface IsDefaultTooltips

Returns:

body alignment.

getBodyFontColorAsString

public String getBodyFontColorAsString()

Description copied from interface: IsDefaultTooltips

Returns the body font color.

Specified by:

getBodyFontColorAsString in interface IsDefaultTooltips

Returns:

body font color.

getBodySpacing

public int getBodySpacing()

Description copied from interface: IsDefaultTooltips

Returns the spacing to add to top and bottom of each tooltip item.

Specified by:

getBodySpacing in interface IsDefaultTooltips

Returns:

spacing to add to top and bottom of each tooltip item.

getFooterFontFamily

public String getFooterFontFamily()

Description copied from interface: IsDefaultTooltips

Returns the footer font.

Specified by:

getFooterFontFamily in interface IsDefaultTooltips

Returns:

footer font.

getFooterFontSize

public int getFooterFontSize()

Description copied from interface: IsDefaultTooltips

Returns the footer font size.

Specified by:

getFooterFontSize in interface IsDefaultTooltips

Returns:

footer font size.

getFooterFontStyle

public FontStyle getFooterFontStyle()

Description copied from interface: IsDefaultTooltips

Returns the footer font style.

Specified by:

getFooterFontStyle in interface IsDefaultTooltips

Returns:

footer font style.

getFooterAlign

public TextAlign getFooterAlign()

Description copied from interface: IsDefaultTooltips

Returns the footer alignment.

Specified by:

getFooterAlign in interface IsDefaultTooltips

Returns:

footer alignment.

getFooterFontColorAsString

public String getFooterFontColorAsString()

Description copied from interface: IsDefaultTooltips

Returns the footer font color.

Specified by:

getFooterFontColorAsString in interface IsDefaultTooltips

Returns:

footer font color.

getFooterSpacing

public int getFooterSpacing()

Description copied from interface: IsDefaultTooltips

Returns the spacing to add to top and bottom of each footer line.

Specified by:

getFooterSpacing in interface IsDefaultTooltips

Returns:

spacing to add to top and bottom of each footer line.

getFooterMarginTop

public int getFooterMarginTop()

Description copied from interface: IsDefaultTooltips

Returns the margin to add before drawing the footer.

Specified by:

getFooterMarginTop in interface IsDefaultTooltips

Returns:

margin to add before drawing the footer.

getXPadding

public int getXPadding()

Description copied from interface: IsDefaultTooltips

Returns the padding to add on left and right of tooltip.

Specified by:

getXPadding in interface IsDefaultTooltips

Returns:

padding to add on left and right of tooltip.

getYPadding

public int getYPadding()

Description copied from interface: IsDefaultTooltips

Returns the padding to add on top and bottom of tooltip.

Specified by:

getYPadding in interface IsDefaultTooltips

Returns:

padding to add on top and bottom of tooltip.

getCaretPadding

public int getCaretPadding()

Description copied from interface: IsDefaultTooltips

Returns the extra distance to move the end of the tooltip arrow away from the tooltip point.

Specified by:

getCaretPadding in interface IsDefaultTooltips

Returns:

extra distance to move the end of the tooltip arrow away from the tooltip point.

getCaretSize

public int getCaretSize()

Description copied from interface: IsDefaultTooltips

Returns the size, in px, of the tooltip arrow.

Specified by:

getCaretSize in interface IsDefaultTooltips

Returns:

size, in px, of the tooltip arrow.

getCornerRadius

public int getCornerRadius()

Description copied from interface: IsDefaultTooltips

Returns the radius of tooltip corner curves.

Specified by:

getCornerRadius in interface IsDefaultTooltips

Returns:

radius of tooltip corner curves.

getMultiKeyBackgroundAsString

public String getMultiKeyBackgroundAsString()

Description copied from interface: IsDefaultTooltips

Returns the color to draw behind the colored boxes when multiple items are in the tooltip.

Specified by:

getMultiKeyBackgroundAsString in interface IsDefaultTooltips

Returns:

color to draw behind the colored boxes when multiple items are in the tooltip.

isDisplayColors

public boolean isDisplayColors()

Description copied from interface: IsDefaultTooltips

If true, color boxes are shown in the tooltip.

Specified by:

isDisplayColors in interface IsDefaultTooltips

Returns:

if true, color boxes are shown in the tooltip.

getBorderColorAsString

public String getBorderColorAsString()

Description copied from interface: IsDefaultTooltips

Returns the color of the border.

Specified by:

getBorderColorAsString in interface IsDefaultTooltips

Returns:

color of the border.

getBorderWidth

public int getBorderWidth()

Description copied from interface: IsDefaultTooltips

Returns the size of the border.

Specified by:

getBorderWidth in interface IsDefaultTooltips

Returns:

size of the border.