Interface IsDefaultTooltips
-
- All Superinterfaces:
IsDefaultAnimationContainer
,IsDefaultAnimationTransition
,IsDefaultBoxHandler
,IsDefaultEventHandler
,IsDefaultTextDirectionHandler
- All Known Implementing Classes:
DefaultChartTooltips
,DefaultTooltips
,Tooltips
public interface IsDefaultTooltips extends IsDefaultTextDirectionHandler, IsDefaultBoxHandler, IsDefaultAnimationContainer, IsDefaultEventHandler
Interface to define tooltips object defaults.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBackgroundColorAsString()
Returns the background color of the tooltip.TextAlign
getBodyAlign()
Returns the body alignment.String
getBodyColorAsString()
Returns the body font color as string.IsDefaultFont
getBodyFont()
Returns the body line font.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
getBoxPadding()
Returns the padding between the color box and the text.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
getFooterColorAsString()
Returns the footer font color as string.IsDefaultFont
getFooterFont()
Returns the footer font.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.IsDefaultPadding
getPadding()
Returns padding object defaults.IsTooltipPosition
getPosition()
Returns the mode for positioning the tooltip.TextAlign
getTitleAlign()
Returns the title alignment.String
getTitleColorAsString()
Returns the title font color as string.IsDefaultFont
getTitleFont()
Returns the title font.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.TooltipAlign
getXAlign()
Returns the alignment of the tooltip caret in the X direction.TooltipAlign
getYAlign()
Returns the alignment of the tooltip caret in the Y direction.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.boolean
isUsePointStyle()
Returns if to use the corresponding point style (from data set options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultAnimationContainer
getTransitions
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultAnimationTransition
getAnimation, getAnimations
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultBoxHandler
getBoxHeight, getBoxWidth
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultEventHandler
getEvents
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultTextDirectionHandler
getTextDirection, isRtl
-
-
-
-
Method Detail
-
getPadding
IsDefaultPadding getPadding()
Returns padding object defaults.- Returns:
- padding object defaults.
-
isEnabled
boolean isEnabled()
Returns if tooltips are enabled.- Returns:
- if tooltips are enabled.
-
getMode
InteractionMode getMode()
Returns which elements appear in the tooltip.- Returns:
- which elements appear in the tooltip.
-
isIntersect
boolean isIntersect()
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.- 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
IsTooltipPosition getPosition()
Returns the mode for positioning the tooltip.- Returns:
- mode for positioning the tooltip.
-
getBackgroundColorAsString
String getBackgroundColorAsString()
Returns the background color of the tooltip.- Returns:
- Background color of the tooltip.
-
getTitleFont
IsDefaultFont getTitleFont()
Returns the title font.- Returns:
- the title font.
-
getTitleColorAsString
String getTitleColorAsString()
Returns the title font color as string.- Returns:
- title font color as string
-
getTitleAlign
TextAlign getTitleAlign()
Returns the title alignment.- Returns:
- title alignment.
-
getTitleSpacing
int getTitleSpacing()
Returns the spacing to add to top and bottom of each title line.- Returns:
- spacing to add to top and bottom of each title line.
-
getTitleMarginBottom
int getTitleMarginBottom()
Returns the margin to add on bottom of title section.- Returns:
- margin to add on bottom of title section.
-
getBodyFont
IsDefaultFont getBodyFont()
Returns the body line font.- Returns:
- body line font.
-
getBodyColorAsString
String getBodyColorAsString()
Returns the body font color as string.- Returns:
- body font color as string
-
getBodyAlign
TextAlign getBodyAlign()
Returns the body alignment.- Returns:
- body alignment.
-
getBodySpacing
int getBodySpacing()
Returns the spacing to add to top and bottom of each tooltip item.- Returns:
- spacing to add to top and bottom of each tooltip item.
-
getFooterFont
IsDefaultFont getFooterFont()
Returns the footer font.- Returns:
- footer font.
-
getFooterColorAsString
String getFooterColorAsString()
Returns the footer font color as string.- Returns:
- footer font color as string
-
getFooterAlign
TextAlign getFooterAlign()
Returns the footer alignment.- Returns:
- footer alignment.
-
getFooterSpacing
int getFooterSpacing()
Returns the spacing to add to top and bottom of each footer line.- Returns:
- spacing to add to top and bottom of each footer line.
-
getFooterMarginTop
int getFooterMarginTop()
Returns the margin to add before drawing the footer.- Returns:
- margin to add before drawing the footer.
-
getCaretPadding
int getCaretPadding()
Returns the extra distance to move the end of the tooltip arrow away from the tooltip point.- Returns:
- extra distance to move the end of the tooltip arrow away from the tooltip point.
-
getCaretSize
int getCaretSize()
Returns the size, in px, of the tooltip arrow.- Returns:
- size, in px, of the tooltip arrow.
-
getCornerRadius
int getCornerRadius()
Returns the radius of tooltip corner curves.- Returns:
- radius of tooltip corner curves.
-
getMultiKeyBackgroundAsString
String getMultiKeyBackgroundAsString()
Returns the color to draw behind the colored boxes when multiple items are in the tooltip.- Returns:
- color to draw behind the colored boxes when multiple items are in the tooltip.
-
isDisplayColors
boolean isDisplayColors()
If true, color boxes are shown in the tooltip.- Returns:
- if true, color boxes are shown in the tooltip.
-
getBorderColorAsString
String getBorderColorAsString()
Returns the color of the border.- Returns:
- color of the border.
-
getBorderWidth
int getBorderWidth()
Returns the size of the border.- Returns:
- size of the border.
-
isUsePointStyle
boolean isUsePointStyle()
Returns if to use the corresponding point style (from data set options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).- Returns:
true
if to use the corresponding point style (from data set options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight)
-
getXAlign
TooltipAlign getXAlign()
Returns the alignment of the tooltip caret in the X direction.- Returns:
- the alignment of the tooltip caret in the X direction
-
getYAlign
TooltipAlign getYAlign()
Returns the alignment of the tooltip caret in the Y direction.- Returns:
- the alignment of the tooltip caret in the Y direction
-
getBoxPadding
int getBoxPadding()
Returns the padding between the color box and the text.- Returns:
- padding between the color box and the text
-
-