Package org.vaadin.addons.componentfactory.sidenavrail

Enum Class PopoverOn

java.lang.Object

java.lang.Enum<PopoverOn>

org.vaadin.addons.componentfactory.sidenavrail.PopoverOn

All Implemented Interfaces:

Serializable, Comparable<PopoverOn>, Constable

public enum PopoverOn
extends Enum<PopoverOn>

Controls when the hover popover on a SideNavRailItem with children appears.

Has no effect on root items with children while SideNavRail.setChildrenOnlyInPopover(boolean) is enabled — that mode forces the popover on regardless of this enum.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_COLLAPSED_ITEMS	Popover appears for every non-expanded item with children, regardless of depth in the hierarchy and regardless of whether the nav is in rail mode.
ONLY_RAIL_MODE	Popover appears only when the nav as a whole is in rail mode (SideNavRail.isRailMode() == true).
ONLY_ROOT_COLLAPSED_ITEMS	Popover appears only for non-expanded items that are direct children of the SideNavRail — not for nested items further down the tree.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL_COLLAPSED_ITEMS

public static final PopoverOn ALL_COLLAPSED_ITEMS

Popover appears for every non-expanded item with children, regardless of depth in the hierarchy and regardless of whether the nav is in rail mode. This is the default and mirrors the customer-requested behaviour of SideNavRail.

ONLY_ROOT_COLLAPSED_ITEMS

public static final PopoverOn ONLY_ROOT_COLLAPSED_ITEMS

Popover appears only for non-expanded items that are direct children of the SideNavRail — not for nested items further down the tree. Useful when only top-level navigation should get the hover preview but deeper levels should behave like a plain SideNav.

In rail mode this is effectively the same as ALL_COLLAPSED_ITEMS because rail mode hides nested items anyway.

ONLY_RAIL_MODE

public static final PopoverOn ONLY_RAIL_MODE

Popover appears only when the nav as a whole is in rail mode (SideNavRail.isRailMode() == true). Inline-closed items in normal mode behave like a standard SideNav — they only open on click.

Method Details

values

public static PopoverOn[] 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 PopoverOn 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