org.pepstock.charba.client.enums

Enum TooltipAlign

java.lang.Object

java.lang.Enum<TooltipAlign>

org.pepstock.charba.client.enums.TooltipAlign

All Implemented Interfaces:

Serializable, Comparable<TooltipAlign>, Key

public enum TooltipAlign
extends Enum<TooltipAlign>
implements Key

Defines the position of the tooltip caret.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Default value and never stored in chart configuration.
BOTTOM The caret is positioned to the bottom.
CENTER The caret is centered.
LEFT The caret is positioned to the left.
RIGHT The caret is positioned to the right.
TOP The caret is positioned to the top.

Method Summary

Modifier and Type	Method and Description
boolean	isHorizontal() Returns true if it can be used for horizontal alignment.
boolean	isVertical() Returns true if it can be used for vertical alignment.
String	value() Returns the name value of property
static TooltipAlign	valueOf(String name) Returns the enum constant of this type with the specified name.
static TooltipAlign[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

CENTER

public static final TooltipAlign CENTER

The caret is centered.

RIGHT

public static final TooltipAlign RIGHT

The caret is positioned to the right.

BOTTOM

public static final TooltipAlign BOTTOM

The caret is positioned to the bottom.

LEFT

public static final TooltipAlign LEFT

The caret is positioned to the left.

TOP

public static final TooltipAlign TOP

The caret is positioned to the top.

AUTO

public static final TooltipAlign AUTO

Default value and never stored in chart configuration.

Method Detail

values

public static TooltipAlign[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TooltipAlign c : TooltipAlign.values())
    System.out.println(c);

Returns:

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

valueOf

public static TooltipAlign valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property

isHorizontal

public boolean isHorizontal()

Returns true if it can be used for horizontal alignment.

Returns:

true if it can be used for horizontal alignment

isVertical

public boolean isVertical()

Returns true if it can be used for vertical alignment.

Returns:

true if it can be used for vertical alignment