Index (SideNav Rail 1.0.0 API)

A F G I L N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form

A

addItem(SideNavItem...) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail
addItem(SideNavItem...) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
addItemAsFirst(SideNavItem) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail
addItemAsFirst(SideNavItem) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
addItemAtIndex(int, SideNavItem) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail
addItemAtIndex(int, SideNavItem) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
addRailModeChangedListener(ComponentEventListener<RailModeChangedEvent>) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Registers a listener for RailModeChangedEvent.
ALL - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested: Override is always active, regardless of rail mode.
ALL_COLLAPSED_ITEMS - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverOn: 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.

F

FULL - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: Header shows both the prefix component and the label, icon first.

G

getActiveViewItem() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The first match from SideNavRail.getActiveViewItems(), or empty if no item matches.
getActiveViewItems() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Returns all rail items whose own path (or any of their path aliases) equals the current view's location.
getPopover() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Returns the popover of this item, if one has been created.
getPopoverHeaderMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The current header mode for popovers.
getPopoverHideDelay() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The hide delay (ms) after the pointer leaves the target before the popover closes.
getPopoverHoverDelay() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The hover delay (ms) before the popover opens.
getPopoverOn() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The current popover mode.
getPopoverPosition() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The position the popover opens at relative to its item.
getRailTooltipMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The current rail-tooltip mode.
getRootMatchNested() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: The current RootMatchNested mode.

I

ICON_ONLY - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: Header shows a copy of the parent's prefix component (typically an icon) only.
isChildrenOnlyInPopover() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Whether nested items are rendered only inside the hover popover, never inline below their parent.
isLeafPopoverActive() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Whether the rail currently asks SideNavRailItem to create a popover for a leaf (childless) root item, so the popover can act as a Vaadin-themed tooltip.
isPopoverArrowVisible() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Whether each popover renders the small Lumo arrow pointing back at its target item.
isPopoverHeaderOnlyInRailMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Whether the popover header is rendered only while the rail is in rail mode.
isRailMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.RailModeChangedEvent: The new rail-mode value after the change.
isRailMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Whether the rail is currently in icon-only mode.

L

LABEL_ONLY - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: Header shows the parent's text label only.

N

NONE - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: No header.
NONE - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RailTooltipMode: No tooltips on root items.
NONE - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested: No automatic override.

O

onAttach(AttachEvent) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail
onAttach(AttachEvent) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
onDetach(DetachEvent) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail
onDetach(DetachEvent) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
ONLY_RAIL - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested: Override is active only while the rail is in rail mode (SideNavRail.isRailMode() == true).
ONLY_RAIL_MODE - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverOn: Popover appears only when the nav as a whole is in rail mode (SideNavRail.isRailMode() == true).
ONLY_ROOT_COLLAPSED_ITEMS - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverOn: Popover appears only for non-expanded items that are direct children of the SideNavRail — not for nested items further down the tree.
org.vaadin.addons.componentfactory.sidenavrail - package org.vaadin.addons.componentfactory.sidenavrail: SideNav Rail — a togglable rail-mode SideNav with a configurable hover popover for items with children.

P

POPOVER_HEADER - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RailTooltipMode: Default.
PopoverHeaderMode - Enum Class in org.vaadin.addons.componentfactory.sidenavrail: Controls whether (and how) a SideNavRailItem's popover renders a header that identifies the item itself.
PopoverOn - Enum Class in org.vaadin.addons.componentfactory.sidenavrail: Controls when the hover popover on a SideNavRailItem with children appears.

R

RailModeChangedEvent - Class in org.vaadin.addons.componentfactory.sidenavrail: Fired when SideNavRail.setRailMode(boolean) actually changes the rail-mode state.
RailModeChangedEvent(SideNavRail, boolean, boolean) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.RailModeChangedEvent
RailTooltipMode - Enum Class in org.vaadin.addons.componentfactory.sidenavrail: Controls how root items of a SideNavRail surface their identity while the rail is in rail mode.
remove(SideNavItem...) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
removeAll() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
RootMatchNested - Enum Class in org.vaadin.addons.componentfactory.sidenavrail: Controls when the SideNavRail forces matchNested = true on every root item, so a root carries the [current] highlight whenever any descendant route is active.

S

setChildrenOnlyInPopover(boolean) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Switches between the standard inline-and-popover layout for nested items (false, default) and a popover-only layout (true).
setLabel(String) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
setPopoverArrowVisible(boolean) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets whether each popover renders the small Lumo arrow pointing back at its target item.
setPopoverHeaderMode(PopoverHeaderMode) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets whether (and how) each popover renders a header identifying the owning item.
setPopoverHeaderOnlyInRailMode(boolean) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Restricts the popover header to rail mode, or allows it in both modes.
setPopoverHideDelay(int) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets the hide delay (ms) after the pointer leaves the target before the popover closes.
setPopoverHoverDelay(int) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets the hover delay (ms) before the popover opens.
setPopoverOn(PopoverOn) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets the popover mode.
setPopoverPosition(PopoverPosition) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets the popover position.
setPrefixComponent(Component) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem
setRailMode(boolean) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Switches the rail between normal mode and icon-only rail mode.
setRailTooltipMode(RailTooltipMode) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Controls how root items surface their label while the rail is in rail mode.
setRootMatchNested(RootMatchNested) - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Sets the RootMatchNested mode.
SideNavRail - Class in org.vaadin.addons.componentfactory.sidenavrail: A SideNav that can be switched into a compact icon-only rail mode and shows a hover popover for items with children.
SideNavRail() - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Creates an unlabelled rail.
SideNavRail(String) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Creates a rail with a header label.
SideNavRailItem - Class in org.vaadin.addons.componentfactory.sidenavrail: SideNavItem variant that integrates with SideNavRail's rail mode and hover popover.
SideNavRailItem(String) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Non-navigating container item.
SideNavRailItem(String, Class<? extends Component>) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Item navigating to the given Flow route class.
SideNavRailItem(String, Class<? extends Component>, Component) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Item navigating to a Flow route class, with a prefix component on the left.
SideNavRailItem(String, String) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Item navigating to the given path (server- or client-side route).
SideNavRailItem(String, String, Component) - Constructor for class org.vaadin.addons.componentfactory.sidenavrail.SideNavRailItem: Item navigating to a path, with a prefix component rendered on the left (typically an icon).
SIMPLE - Enum constant in enum class org.vaadin.addons.componentfactory.sidenavrail.RailTooltipMode: Lumo-themed CSS pseudo-element tooltip.

T

toggleRailMode() - Method in class org.vaadin.addons.componentfactory.sidenavrail.SideNavRail: Switches the rail between normal mode and icon-only rail mode.

V

valueOf(String) - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverOn: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.RailTooltipMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverHeaderMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.PopoverOn: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.RailTooltipMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.vaadin.addons.componentfactory.sidenavrail.RootMatchNested: Returns an array containing the constants of this enum class, in the order they are declared.

A F G I L N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form