org.sonar.api.web

Enum DashboardLayout

java.lang.Object

java.lang.Enum<DashboardLayout>

org.sonar.api.web.DashboardLayout

All Implemented Interfaces:

Serializable, Comparable<DashboardLayout>

public enum DashboardLayout
extends Enum<DashboardLayout>

Possible layouts for a dashboard.

Since:

2.13

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_COLUMN Only 1 column that take all the page
TREE_COLUMNS 3 columns of the same width
TWO_COLUMNS 2 columns of the same width
TWO_COLUMNS_30_70 2 columns with the first one smaller than the second
TWO_COLUMNS_70_30 2 columns with the first one bigger than the second

Method Summary

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

ONE_COLUMN

public static final DashboardLayout ONE_COLUMN

Only 1 column that take all the page

TWO_COLUMNS

public static final DashboardLayout TWO_COLUMNS

2 columns of the same width

TWO_COLUMNS_30_70

public static final DashboardLayout TWO_COLUMNS_30_70

2 columns with the first one smaller than the second

TWO_COLUMNS_70_30

public static final DashboardLayout TWO_COLUMNS_70_30

2 columns with the first one bigger than the second

TREE_COLUMNS

public static final DashboardLayout TREE_COLUMNS

3 columns of the same width

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

getColumns

public int getColumns()

toString

public String toString()

Overrides:

toString in class Enum<DashboardLayout>