org.moxieapps.gwt.highcharts.client

Enum Legend.Layout

java.lang.Object

java.lang.Enum<Legend.Layout>

org.moxieapps.gwt.highcharts.client.Legend.Layout

All Implemented Interfaces:

Serializable, Comparable<Legend.Layout>

Enclosing class:

Legend

public static enum Legend.Layout
extends Enum<Legend.Layout>

An enumeration of supported legend layout types, which can be passed to methods like Legend.setLayout(Layout) method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HORIZONTAL Lay the legend items out in a horizontal row
VERTICAL Lay the legend items out in a vertical stack

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()
static Legend.Layout	valueOf(String name) Returns the enum constant of this type with the specified name.
static Legend.Layout[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HORIZONTAL

public static final Legend.Layout HORIZONTAL

Lay the legend items out in a horizontal row

VERTICAL

public static final Legend.Layout VERTICAL

Lay the legend items out in a vertical stack

Method Detail

values

public static Legend.Layout[] 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 (Legend.Layout c : Legend.Layout.values())
    System.out.println(c);

Returns:

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

valueOf

public static Legend.Layout 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

toString

public String toString()

Overrides:

toString in class Enum<Legend.Layout>