public final class Tooltips extends AbstractItem
| Modifier and Type | Method and Description |
|---|---|
IsColor |
getBackgroundColor()
Returns the background color of the tooltip.
|
java.lang.String |
getBackgroundColorAsString()
Returns the background color of the tooltip.
|
TextAlign |
getBodyAlign()
Returns the body alignment.
|
IsColor |
getBodyFontColor()
Returns the body font color.
|
java.lang.String |
getBodyFontColorAsString()
Returns the body font color.
|
java.lang.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.
|
IsColor |
getBorderColor()
Returns the color of the border.
|
java.lang.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 body alignment.
|
IsColor |
getFooterFontColor()
Returns the footer font color.
|
java.lang.String |
getFooterFontColorAsString()
Returns the footer font color.
|
java.lang.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.
|
IsColor |
getMultiKeyBackground()
Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
|
java.lang.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.
|
IsColor |
getTitleFontColor()
Returns the title font color.
|
java.lang.String |
getTitleFontColorAsString()
Returns the title font color.
|
java.lang.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.
|
void |
setBackgroundColor(IsColor backgroundColor)
Sets the background color of the tooltip.
|
void |
setBackgroundColor(java.lang.String backgroundColor)
Sets the background color of the tooltip.
|
void |
setBodyAlign(TextAlign align)
Sets the body alignment.
|
void |
setBodyFontColor(IsColor bodyFontColor)
Sets the body font color.
|
void |
setBodyFontColor(java.lang.String bodyFontColor)
Sets the body font color.
|
void |
setBodyFontFamily(java.lang.String bodyFontFamily)
Sets the body line font.
|
void |
setBodyFontSize(int bodyFontSize)
Sets the body font size.
|
void |
setBodyFontStyle(FontStyle bodyFontStyle)
Sets the body font style.
|
void |
setBodySpacing(int bodySpacing)
Sets the spacing to add to top and bottom of each tooltip item.
|
void |
setBorderColor(IsColor borderColor)
Sets the color of the border.
|
void |
setBorderColor(java.lang.String borderColor)
Sets the color of the border.
|
void |
setBorderWidth(int borderWidth)
Sets the size of the border.
|
void |
setCaretPadding(int caretPadding)
Sets the extra distance to move the end of the tooltip arrow away from the tooltip point.
|
void |
setCaretSize(int caretSize)
Sets the size, in px, of the tooltip arrow.
|
void |
setCornerRadius(int cornerRadius)
Sets the radius of tooltip corner curves.
|
void |
setDisplayColors(boolean displayColors)
If true, color boxes are shown in the tooltip.
|
void |
setEnabled(boolean enabled)
Sets if tooltips are enabled.
|
void |
setFooterAlign(TextAlign align)
Sets the footer alignment.
|
void |
setFooterFontColor(IsColor footerFontColor)
Sets the footer font color.
|
void |
setFooterFontColor(java.lang.String footerFontColor)
Sets the footer font color.
|
void |
setFooterFontFamily(java.lang.String footerFontFamily)
Sets the footer font.
|
void |
setFooterFontSize(int footerFontSize)
Sets the footer font size.
|
void |
setFooterFontStyle(FontStyle footerFontStyle)
Sets the footer font style.
|
void |
setFooterMarginTop(int footerMarginTop)
Sets the margin to add before drawing the footer.
|
void |
setFooterSpacing(int footerSpacing)
Sets the spacing to add to top and bottom of each footer line.
|
void |
setIntersect(boolean intersect)
if true, the tooltip mode applies only when the mouse position intersects with an element.
|
void |
setMode(InteractionMode mode)
Sets which elements appear in the tooltip.
|
void |
setMultiKeyBackground(IsColor multiKeyBackground)
Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
|
void |
setMultiKeyBackground(java.lang.String multiKeyBackground)
Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
|
void |
setPosition(TooltipPosition position)
Sets the mode for positioning the tooltip.
|
void |
setTitleAlign(TextAlign align)
Sets the title alignment.
|
void |
setTitleFontColor(IsColor titleFontColor)
Sets the title font color.
|
void |
setTitleFontColor(java.lang.String titleFontColor)
Sets the title font color.
|
void |
setTitleFontFamily(java.lang.String titleFontFamily)
Sets the title font.
|
void |
setTitleFontSize(int titleFontSize)
Sets the title font size.
|
void |
setTitleFontStyle(FontStyle titleFontStyle)
Sets the title font style.
|
void |
setTitleMarginBottom(int titleMarginBottom)
Sets the margin to add on bottom of title section.
|
void |
setTitleSpacing(int titleSpacing)
Sets the spacing to add to top and bottom of each title line.
|
void |
setXPadding(int xPadding)
Sets the padding to add on left and right of tooltip.
|
void |
setYPadding(int yPadding)
Sets the padding to add on top and bottom of tooltip.
|
checkAndAddToParent, hasPropertycheckAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, typepublic void setEnabled(boolean enabled)
enabled - if tooltips are enabled.public boolean isEnabled()
public void setMode(InteractionMode mode)
mode - which elements appear in the tooltip.InteractionModepublic InteractionMode getMode()
InteractionMode.nearest.InteractionModepublic void setIntersect(boolean intersect)
intersect - 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.public boolean isIntersect()
public void setPosition(TooltipPosition position)
position - the mode for positioning the tooltip.TooltipPositionpublic TooltipPosition getPosition()
TooltipPosition.average.TooltipPositionpublic void setBackgroundColor(IsColor backgroundColor)
backgroundColor - background color of the tooltip.public void setBackgroundColor(java.lang.String backgroundColor)
backgroundColor - background color of the tooltip.public java.lang.String getBackgroundColorAsString()
public IsColor getBackgroundColor()
public void setTitleFontFamily(java.lang.String titleFontFamily)
titleFontFamily - title font.public java.lang.String getTitleFontFamily()
Options.getDefaultFontFamily().public void setTitleFontSize(int titleFontSize)
titleFontSize - Title font size.public int getTitleFontSize()
Options.getDefaultFontSize().public void setTitleFontStyle(FontStyle titleFontStyle)
titleFontStyle - title font style.FontStylepublic FontStyle getTitleFontStyle()
FontStyle.bold.FontStylepublic void setTitleAlign(TextAlign align)
align - title alignment.TextAlignpublic TextAlign getTitleAlign()
TextAlign.left.TextAlignpublic void setTitleFontColor(IsColor titleFontColor)
titleFontColor - title font color.public void setTitleFontColor(java.lang.String titleFontColor)
titleFontColor - title font color.public java.lang.String getTitleFontColorAsString()
public IsColor getTitleFontColor()
public void setTitleSpacing(int titleSpacing)
titleSpacing - spacing to add to top and bottom of each title line.public int getTitleSpacing()
public void setTitleMarginBottom(int titleMarginBottom)
titleMarginBottom - margin to add on bottom of title section.public int getTitleMarginBottom()
public void setBodyFontFamily(java.lang.String bodyFontFamily)
bodyFontFamily - body line font.public java.lang.String getBodyFontFamily()
Options.getDefaultFontFamily().public void setBodyFontSize(int bodyFontSize)
bodyFontSize - body font size.public int getBodyFontSize()
Options.getDefaultFontSize().public void setBodyFontStyle(FontStyle bodyFontStyle)
bodyFontStyle - body font style.FontStylepublic FontStyle getBodyFontStyle()
FontStyle.normal.FontStylepublic void setBodyAlign(TextAlign align)
align - body alignment.TextAlignpublic TextAlign getBodyAlign()
TextAlign.left.TextAlignpublic void setBodyFontColor(IsColor bodyFontColor)
bodyFontColor - body font color.public void setBodyFontColor(java.lang.String bodyFontColor)
bodyFontColor - body font color.public java.lang.String getBodyFontColorAsString()
public IsColor getBodyFontColor()
public void setBodySpacing(int bodySpacing)
bodySpacing - spacing to add to top and bottom of each tooltip item.public int getBodySpacing()
public void setFooterFontFamily(java.lang.String footerFontFamily)
footerFontFamily - footer font.public java.lang.String getFooterFontFamily()
Options.getDefaultFontFamily().public void setFooterFontSize(int footerFontSize)
footerFontSize - footer font size.public int getFooterFontSize()
Options.getDefaultFontSize().public void setFooterFontStyle(FontStyle footerFontStyle)
footerFontStyle - the footer font style.public FontStyle getFooterFontStyle()
FontStyle.normal.FontStylepublic void setFooterAlign(TextAlign align)
align - footer alignment.TextAlignpublic TextAlign getFooterAlign()
TextAlign.left.TextAlignpublic void setFooterFontColor(IsColor footerFontColor)
footerFontColor - footer font color.public void setFooterFontColor(java.lang.String footerFontColor)
footerFontColor - footer font color.public java.lang.String getFooterFontColorAsString()
public IsColor getFooterFontColor()
public void setFooterSpacing(int footerSpacing)
footerSpacing - spacing to add to top and bottom of each footer line.public int getFooterSpacing()
public void setFooterMarginTop(int footerMarginTop)
footerMarginTop - margin to add before drawing the footer.public int getFooterMarginTop()
public void setXPadding(int xPadding)
xPadding - padding to add on left and right of tooltip.public int getXPadding()
public void setYPadding(int yPadding)
yPadding - padding to add on top and bottom of tooltip.public int getYPadding()
public void setCaretPadding(int caretPadding)
caretPadding - extra distance to move the end of the tooltip arrow away from the tooltip point.public int getCaretPadding()
public void setCaretSize(int caretSize)
caretSize - size, in px, of the tooltip arrow.public int getCaretSize()
public void setCornerRadius(int cornerRadius)
cornerRadius - radius of tooltip corner curves.public int getCornerRadius()
public void setMultiKeyBackground(IsColor multiKeyBackground)
multiKeyBackground - color to draw behind the colored boxes when multiple items are in the tooltip.public void setMultiKeyBackground(java.lang.String multiKeyBackground)
multiKeyBackground - color to draw behind the colored boxes when multiple items are in the tooltip.public java.lang.String getMultiKeyBackgroundAsString()
public IsColor getMultiKeyBackground()
public void setDisplayColors(boolean displayColors)
displayColors - if true, color boxes are shown in the tooltip.public boolean isDisplayColors()
public void setBorderColor(IsColor borderColor)
borderColor - color of the border.public void setBorderColor(java.lang.String borderColor)
borderColor - color of the border.public java.lang.String getBorderColorAsString()
public IsColor getBorderColor()
public void setBorderWidth(int borderWidth)
borderWidth - size of the border.public int getBorderWidth()