Package org.linkki.core.ui.layout.annotation

Enum SectionLayout

java.lang.Object

java.lang.Enum<SectionLayout>

org.linkki.core.ui.layout.annotation.SectionLayout

All Implemented Interfaces:

Serializable, Comparable<SectionLayout>

public enum SectionLayout
extends Enum<SectionLayout>

The options for the layout pattern of a section

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLUMN	Deprecated. Use FORM instead
FORM	Displays section elements stacked in a column.
HORIZONTAL	Displays section elements next to each other in a row.
VERTICAL	Displays section elements stacked in a column.

Method Summary

Modifier and Type	Method	Description
SectionLayoutDefinition	getSectionLayoutDefinition()
List<String>	getThemeNames()
static SectionLayout	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SectionLayout[]	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

HORIZONTAL

public static final SectionLayout HORIZONTAL

Displays section elements next to each other in a row. Labels are displayed on top of the components.

Note that with this option, several components such as UIButton, UICheckBox, UILabel and UILink do not support labels.
UITextArea and UITextField will take up all available space by default. To change this, UITextArea.width() resp. UITextField.width() must be set to "".

COLUMN

@Deprecated(since="2.0.0")
public static final SectionLayout COLUMN

Deprecated.

Use FORM instead

Displays section elements stacked in a column. Labels are displayed on the left of the components.

Consider using UIFormSection instead.

FORM

public static final SectionLayout FORM

Displays section elements stacked in a column. Labels are displayed on the left of the components.

Consider using UIFormSection instead.

VERTICAL

public static final SectionLayout VERTICAL

Displays section elements stacked in a column. Labels are displayed on top of the component.

Note that with this option, several components such as UIButton, UICheckBox, UILabel and UILink do not support labels.

Method Detail

values

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

Returns:

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

valueOf

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

getSectionLayoutDefinition

public SectionLayoutDefinition getSectionLayoutDefinition()

getThemeNames

public List<String> getThemeNames()