Package com.jbstrap.ui.components.charts.params.enums

Enum Class TooltipType

java.lang.Object

java.lang.Enum<TooltipType>

com.jbstrap.ui.components.charts.params.enums.TooltipType

All Implemented Interfaces:

Serializable, Comparable<TooltipType>, Constable

public enum TooltipType
extends Enum<TooltipType>

The types of tooltip that appear on the chart

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM	Custom tooltip.
DOT	Point tooltip.
LINE	Line tooltip.
SIMPLE	Simple tooltip

Method Summary

Modifier and Type	Method	Description
static TooltipType	fromName(String name)	Determines the tooltip type by its name.
String	toString()
static TooltipType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TooltipType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SIMPLE

public static final TooltipType SIMPLE

Simple tooltip

LINE

public static final TooltipType LINE

Line tooltip. If more than one series is displayed on the chart, all series data is displayed on the tooltip.

DOT

public static final TooltipType DOT

Point tooltip. Only the data value of the selected point on the chart is visible on the tooltip.

CUSTOM

public static final TooltipType CUSTOM

Custom tooltip. Users can specify a custom HTML that is displayed on the tooltip, or use the tooltip renderer, which can also be used to display components in the tooltip. More on the renderer in the ChartCanvas.setToolTipRenderer() method description.

Method Details

values

public static TooltipType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TooltipType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<TooltipType>

fromName

public static TooltipType fromName(String name)

Determines the tooltip type by its name.

Parameters:

name - Tooltip type

Returns:

Tooltip type corresponding the specified name or null if there is no tooltip type for the specified name