Package org.patternfly.component.navigation

Enum Class NavigationType.Vertical

java.lang.Object

java.lang.Enum<NavigationType.Vertical>

org.patternfly.component.navigation.NavigationType.Vertical

All Implemented Interfaces:

Serializable, Comparable<NavigationType.Vertical>, Constable, NavigationType

Enclosing interface:

NavigationType

public static enum NavigationType.Vertical
extends Enum<NavigationType.Vertical>
implements NavigationType

Different variations of NavigationGroups and NavigationItems possible.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.patternfly.component.navigation.NavigationType

NavigationType.Horizontal, NavigationType.Vertical

Enum Constant Summary

Enum Constants

Enum Constant	Description
drillDown
expandable	Mixed content of NavigationGroups and NavigationItems allowed.
flat	No groups, only one level of NavigationItems allowed.
flyout
grouped	Only NavigationGroups with one level of NavigationItems allowed.

Method Summary

Modifier and Type	Method	Description
static NavigationType.Vertical	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NavigationType.Vertical[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

flat

public static final NavigationType.Vertical flat

No groups, only one level of NavigationItems allowed.

navigation(flat)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addDivider()
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"));

grouped

public static final NavigationType.Vertical grouped

Only NavigationGroups with one level of NavigationItems allowed. No mixed content.

navigation(grouped)
        .addGroup(navigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addGroup(navigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-2-itm-3", "Item 3", "#grp-2-itm-3")));

expandable

public static final NavigationType.Vertical expandable

Mixed content of NavigationGroups and NavigationItems allowed. More than one level of nesting possible.

navigation(expandable)
        .addItem(navigationItem("itm-1", "Item 1", "#itm-1"))
        .addDivider()
        .addGroup(expandableNavigationGroup("grp-1", "Group 1")
                .addItem(navigationItem("grp-1-itm-1", "Item 1", "#grp-1-itm-1"))
                .addItem(navigationItem("grp-1-itm-2", "Item 2", "#grp-1-itm-2"))
                .addDivider()
                .addItem(navigationItem("grp-1-itm-3", "Item 3", "#grp-1-itm-3")))
        .addItem(navigationItem("itm-2", "Item 2", "#itm-2"))
        .addItem(navigationItem("itm-3", "Item 3", "#itm-3"))
        .addGroup(expandableNavigationGroup("grp-2", "Group 2")
                .addItem(navigationItem("grp-2-itm-1", "Item 1", "#grp-2-itm-1"))
                .addItem(navigationItem("grp-2-itm-2", "Item 2", "#grp-2-itm-2"))
                .addGroup(expandableNavigationGroup("nested-grp-1", "Nested Group")
                        .addItem(navigationItem("nested-grp-1-itm-1", "Item 1", "#nested-grp-1-itm-1"))
                        .addDivider()
                        .addItem(navigationItem("nested-grp-1-itm-2", "Item 2", "#nested-grp-1-itm-2"))));

flyout

public static final NavigationType.Vertical flyout

drillDown

public static final NavigationType.Vertical drillDown

Method Details

values

public static NavigationType.Vertical[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NavigationType.Vertical valueOf(String name)

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

NullPointerException - if the argument is null