Package com.github.bordertech.wcomponents

Enum HeadingLevel

java.lang.Object

java.lang.Enum<HeadingLevel>

com.github.bordertech.wcomponents.HeadingLevel

All Implemented Interfaces:

Serializable, Comparable<HeadingLevel>

public enum HeadingLevel
extends Enum<HeadingLevel>

Heading level types.

Since:

1.0.0

Author:

Jonathan Austin

Enum Constant Summary

Enum Constants

Enum Constant	Description
H1	Heading - Level 1.
H2	Heading - Level 2.
H3	Heading - Level 3.
H4	Heading - Level 4.
H5	Heading - Level 5.
H6	Heading - Level 6.

Method Summary

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

Enum Constant Detail

H1

public static final HeadingLevel H1

Heading - Level 1.

H2

public static final HeadingLevel H2

Heading - Level 2.

H3

public static final HeadingLevel H3

Heading - Level 3.

H4

public static final HeadingLevel H4

Heading - Level 4.

H5

public static final HeadingLevel H5

Heading - Level 5.

H6

public static final HeadingLevel H6

Heading - Level 6.

Method Detail

values

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

Returns:

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

valueOf

public static HeadingLevel 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

getLevel

public int getLevel()

Returns:

the heading level