public final class Tooltips extends AbstractModel<Options,IsDefaultTooltips> implements IsDefaultTooltips
Modifier and Type | Method and Description |
---|---|
IsColor |
getBackgroundColor()
Returns the background color of the tooltip.
|
String |
getBackgroundColorAsString()
Returns the background color of the tooltip.
|
TextAlign |
getBodyAlign()
Returns the body alignment.
|
IsColor |
getBodyFontColor()
Returns the body font color.
|
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.
|
IsColor |
getBorderColor()
Returns the color of the border.
|
String |
getBorderColorAsString()
Returns the color of the border.
|
int |
getBorderWidth()
Returns the size of the border.
|
TooltipsCallbacks |
getCallbacks()
Returns the callbacks element.
|
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 pixels, 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.
|
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.
|
IsColor |
getMultiKeyBackground()
Returns the color to draw behind the colored boxes when multiple items are 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.
|
IsColor |
getTitleFontColor()
Returns the title font color.
|
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
true 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(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(String bodyFontColor)
Sets the body font color.
|
void |
setBodyFontFamily(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(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 pixels, 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
true if tooltips are enabled. |
void |
setFooterAlign(TextAlign align)
Sets the footer alignment.
|
void |
setFooterFontColor(IsColor footerFontColor)
Sets the footer font color.
|
void |
setFooterFontColor(String footerFontColor)
Sets the footer font color.
|
void |
setFooterFontFamily(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(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(String titleFontColor)
Sets the title font color.
|
void |
setTitleFontFamily(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, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel
getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
public TooltipsCallbacks getCallbacks()
public void setEnabled(boolean enabled)
true
if tooltips are enabled.enabled
- true
if tooltips are enabled.public boolean isEnabled()
true
if tooltips are enabled.isEnabled
in interface IsDefaultTooltips
true
if tooltips are enabled.public void setMode(InteractionMode mode)
mode
- which elements appear in the tooltip.public InteractionMode getMode()
getMode
in interface IsDefaultTooltips
public void setIntersect(boolean intersect)
true
, the tooltip mode applies only when the mouse position intersects with an element. If
false
, the mode will be applied at all times.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()
true
, the tooltip mode applies only when the mouse position intersects with an element. If
false
, the mode will be applied at all times.isIntersect
in interface IsDefaultTooltips
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 void setPosition(TooltipPosition position)
position
- the mode for positioning the tooltip.public TooltipPosition getPosition()
getPosition
in interface IsDefaultTooltips
public void setBackgroundColor(IsColor backgroundColor)
backgroundColor
- background color of the tooltip.public void setBackgroundColor(String backgroundColor)
backgroundColor
- background color of the tooltip.public String getBackgroundColorAsString()
getBackgroundColorAsString
in interface IsDefaultTooltips
public IsColor getBackgroundColor()
public void setTitleFontFamily(String titleFontFamily)
titleFontFamily
- title font.public String getTitleFontFamily()
getTitleFontFamily
in interface IsDefaultTooltips
public void setTitleFontSize(int titleFontSize)
titleFontSize
- title font size.public int getTitleFontSize()
getTitleFontSize
in interface IsDefaultTooltips
public void setTitleFontStyle(FontStyle titleFontStyle)
titleFontStyle
- title font style.public FontStyle getTitleFontStyle()
getTitleFontStyle
in interface IsDefaultTooltips
public void setTitleAlign(TextAlign align)
align
- title alignment.public TextAlign getTitleAlign()
getTitleAlign
in interface IsDefaultTooltips
public void setTitleFontColor(IsColor titleFontColor)
titleFontColor
- title font color.public void setTitleFontColor(String titleFontColor)
titleFontColor
- title font color.public String getTitleFontColorAsString()
getTitleFontColorAsString
in interface IsDefaultTooltips
public IsColor getTitleFontColor()
public void setTitleSpacing(int titleSpacing)
titleSpacing
- spacing to add to top and bottom of each title line.public int getTitleSpacing()
getTitleSpacing
in interface IsDefaultTooltips
public void setTitleMarginBottom(int titleMarginBottom)
titleMarginBottom
- margin to add on bottom of title section.public int getTitleMarginBottom()
getTitleMarginBottom
in interface IsDefaultTooltips
public void setBodyFontFamily(String bodyFontFamily)
bodyFontFamily
- body line font.public String getBodyFontFamily()
getBodyFontFamily
in interface IsDefaultTooltips
public void setBodyFontSize(int bodyFontSize)
bodyFontSize
- body font size.public int getBodyFontSize()
getBodyFontSize
in interface IsDefaultTooltips
public void setBodyFontStyle(FontStyle bodyFontStyle)
bodyFontStyle
- body font style.public FontStyle getBodyFontStyle()
getBodyFontStyle
in interface IsDefaultTooltips
public void setBodyAlign(TextAlign align)
align
- body alignment.public TextAlign getBodyAlign()
getBodyAlign
in interface IsDefaultTooltips
public void setBodyFontColor(IsColor bodyFontColor)
bodyFontColor
- body font color.public void setBodyFontColor(String bodyFontColor)
bodyFontColor
- body font color.public String getBodyFontColorAsString()
getBodyFontColorAsString
in interface IsDefaultTooltips
public IsColor getBodyFontColor()
public void setBodySpacing(int bodySpacing)
bodySpacing
- spacing to add to top and bottom of each tooltip item.public int getBodySpacing()
getBodySpacing
in interface IsDefaultTooltips
public void setFooterFontFamily(String footerFontFamily)
footerFontFamily
- footer font.public String getFooterFontFamily()
getFooterFontFamily
in interface IsDefaultTooltips
public void setFooterFontSize(int footerFontSize)
footerFontSize
- footer font size.public int getFooterFontSize()
getFooterFontSize
in interface IsDefaultTooltips
public void setFooterFontStyle(FontStyle footerFontStyle)
footerFontStyle
- the footer font style.public FontStyle getFooterFontStyle()
getFooterFontStyle
in interface IsDefaultTooltips
public void setFooterAlign(TextAlign align)
align
- footer alignment.public TextAlign getFooterAlign()
getFooterAlign
in interface IsDefaultTooltips
public void setFooterFontColor(IsColor footerFontColor)
footerFontColor
- footer font color.public void setFooterFontColor(String footerFontColor)
footerFontColor
- footer font color.public String getFooterFontColorAsString()
getFooterFontColorAsString
in interface IsDefaultTooltips
public IsColor getFooterFontColor()
public void setFooterSpacing(int footerSpacing)
footerSpacing
- spacing to add to top and bottom of each footer line.public int getFooterSpacing()
getFooterSpacing
in interface IsDefaultTooltips
public void setFooterMarginTop(int footerMarginTop)
footerMarginTop
- margin to add before drawing the footer.public int getFooterMarginTop()
getFooterMarginTop
in interface IsDefaultTooltips
public void setXPadding(int xPadding)
xPadding
- padding to add on left and right of tooltip.public int getXPadding()
getXPadding
in interface IsDefaultTooltips
public void setYPadding(int yPadding)
yPadding
- padding to add on top and bottom of tooltip.public int getYPadding()
getYPadding
in interface IsDefaultTooltips
public void setCaretPadding(int caretPadding)
caretPadding
- extra distance to move the end of the tooltip arrow away from the tooltip point.public int getCaretPadding()
getCaretPadding
in interface IsDefaultTooltips
public void setCaretSize(int caretSize)
caretSize
- size, in pixels, of the tooltip arrow.public int getCaretSize()
getCaretSize
in interface IsDefaultTooltips
public void setCornerRadius(int cornerRadius)
cornerRadius
- radius of tooltip corner curves.public int getCornerRadius()
getCornerRadius
in interface IsDefaultTooltips
public void setMultiKeyBackground(IsColor multiKeyBackground)
multiKeyBackground
- color to draw behind the colored boxes when multiple items are in the tooltip.public void setMultiKeyBackground(String multiKeyBackground)
multiKeyBackground
- color to draw behind the colored boxes when multiple items are in the tooltip.public String getMultiKeyBackgroundAsString()
getMultiKeyBackgroundAsString
in interface IsDefaultTooltips
public IsColor getMultiKeyBackground()
public void setDisplayColors(boolean displayColors)
true
, color boxes are shown in the tooltip.displayColors
- if true
, color boxes are shown in the tooltip.public boolean isDisplayColors()
true
, color boxes are shown in the tooltip.isDisplayColors
in interface IsDefaultTooltips
true
, color boxes are shown in the tooltip.public void setBorderColor(IsColor borderColor)
borderColor
- color of the border.public void setBorderColor(String borderColor)
borderColor
- color of the border.public String getBorderColorAsString()
getBorderColorAsString
in interface IsDefaultTooltips
public IsColor getBorderColor()
public void setBorderWidth(int borderWidth)
borderWidth
- size of the border.public int getBorderWidth()
getBorderWidth
in interface IsDefaultTooltips