Index (App Nav Layout for Vaadin Flow 25.1.0 API)

A C D E G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form

A

addBranding(Component...) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Adds brand/identity content.
addNavTypeChangedListener(ComponentEventListener) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Adds a listener for NavTypeChangedEvent, fired whenever the active NavType is determined and applied — including on first attachment.
addToNavbar(Component...) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Appends components directly to the top bar row.
afterNavigation(AfterNavigationEvent) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: On each navigation: assembles the viewHeaderSlot from the current view's HasViewHeaderTitle and HasViewHeaderComponent if present, and re-invokes the active NavRenderer(s) so active-item highlighting and drill-down content stay current.
AppNavLayout - Class in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Base application layout providing adaptive navigation: a bottom icon bar with a secondary tab bar on phone, a permanent left-strip rail on tablet, and a drawer-based SideNav on desktop.
AppNavLayout() - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Creates an AppNavLayout with the default renderers for each scenario (phone → touch, tablet → rail, desktop → sidenav).

C

createIcon() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Creates and returns a fresh display icon for this node, or empty if none is configured.
createNavButton(Component, Class) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer: Builds a nav-bar item Button wrapping content, themed so an .active item (this add-on's own CSS, keyed off that class) picks up whichever theme is actually loaded's own accent color, and navigating to viewClass on click (or doing nothing on click if null — the "More" overflow trigger has no route of its own).
createNavButton(Component, Class) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer: Builds a nav-bar item Button wrapping content, themed so an .active item (this add-on's own CSS, keyed off that class) picks up whichever theme is actually loaded's own accent color, and navigating to viewClass on click (or doing nothing on click if null — the "More" overflow trigger has no route of its own).
createOverflowComponent(List, Button, Map) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer: Creates the overflow-triggering component shown alongside the "More" bar item — default: a Popover listing the overflowing entries.
createOverflowComponent(List, Button, Map) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer: Creates the overflow-triggering component shown alongside the "More" bar item — default: a Popover listing the overflowing entries.
currentPath() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavRenderContext: The path of the currently active navigation, with any leading / stripped.

D

DESKTOP - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.DeviceType
DeviceType - Enum Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: Coarse device category detected from touch capability and physical screen size.
drawer() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavSlots: The desktop nav location, inside the drawer.

E

equals(Object) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode

G

getNavType() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavTypeChangedEvent: The newly applied nav type.
getPreviousNavType() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavTypeChangedEvent: The nav type previously in effect, or null on first attachment.
getViewHeaderComponent() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.view.HasViewHeaderComponent: Returns the component to place in the view header slot, or null to suppress the slot.
getViewHeaderIcon() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.view.HasViewHeaderTitle: Returns an icon for the view header, or null for no icon.
getViewHeaderSuffix() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.view.HasViewHeaderTitle: Returns a component to append after the title (e.g. a badge or status chip), or null to omit the suffix slot.
getViewHeaderTitle() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.view.HasViewHeaderTitle: Returns the component to place in the view header title slot.

H

hashCode() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode
HasViewHeaderComponent - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.view: Implemented by views that want to contribute an action component to the adaptive view header slot.
HasViewHeaderTitle - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.view: Implemented by views that want an auto-generated icon+title component in the adaptive view header slot.
headerNav() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavSlots: The shared drill-down location for nested routes, shown alongside NavSlots.sideRail() or NavSlots.touchBar().

I

icon() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavGroup: Returns a supplier that creates the icon for this group node, or null for no icon.
isInitialApplication() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavTypeChangedEvent: Returns true if this is the first nav type ever applied to this layout.
isMobile() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Returns true if this session is using touch or rail nav (not desktop SideNav).

L

LANDSCAPE - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.Orientation
leafTitle(MenuEntry) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.RouteNavUtils: Returns MenuEntry.title() as the leaf display name — already resolved by MenuConfiguration.getMenuEntries() itself (falling back through @PageTitle to the class name), so this doesn't add a fallback of its own.

M

menuEntry() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: The menu entry for leaf nodes; empty for group nodes.

N

NavGroup - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.nav: A named grouping node in the navigation hierarchy.
navGrouper() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavRenderContext: The current nav grouping strategy; call NavGrouper.nodeFor(MenuEntry) for each entry from com.vaadin.flow.server.menu.MenuConfiguration#getMenuEntries().
NavGrouper - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.nav: Strategy for mapping MenuEntry items to their position in the navigation tree.
NavNode - Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: A node in the navigation tree — either a group (non-navigable section) or a leaf (navigable view).
NavRenderContext - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Everything a NavRenderer needs to build or update its content for the current nav state.
NavRenderer - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Builds and updates the nav-item content for one of AppNavLayout's five device/orientation scenarios (desktop, tablet portrait, tablet landscape, phone portrait, phone landscape), placing it into whichever of AppNavLayout's named locations (see NavSlots) is appropriate.
NavSlots - Interface in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: The full set of named locations AppNavLayout has for nav-item content.
navType() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer
navType() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer
navType() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavRenderer: The chrome this renderer requires — determines which NavStrategy gets built for whichever scenario this renderer is configured for.
navType() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideNavDrawerNavRenderer
NavType - Enum Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: The chrome/NavStrategy built for a device/orientation scenario, declared by the navType() of whichever NavRenderer is active for that scenario — not chosen independently.
NavTypeChangedEvent - Class in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Fired whenever AppNavLayout determines and applies a NavType — including on first attachment, not just on later changes.
NavTypeChangedEvent(AppNavLayout, NavType, NavType) - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavTypeChangedEvent
nodeFor(MenuEntry) - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavGrouper: Returns the NavNode representing entry in the navigation tree.
nodeFor(MenuEntry) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.PathPrefixNavGrouper
normalizedPath(MenuEntry) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.RouteNavUtils: Returns the path from a MenuEntry with any leading / stripped, matching the format returned by Location.getPath().

O

of(MenuEntry) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Leaf node with no parent (top-level view).
of(MenuEntry, Supplier) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Leaf node with no parent; uses iconOverride if non-null, else derives icon from @Menu.
of(MenuEntry, Supplier, NavNode) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Leaf node nested under parent; uses iconOverride if non-null, else derives icon from @Menu.
of(MenuEntry, NavNode) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Leaf node nested under parent.
of(String, Supplier) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Group node with no parent (top-level section).
of(String, Supplier, NavNode) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Group node nested under parent.
onAttach(AttachEvent) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout
onNavTypeChanged(NavTypeChangedEvent) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Called whenever the active NavType is determined and applied — including on first attachment, not just on later changes.
org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav - package org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav
org.vaadin.addons.joelpop.appnavlayout.ui.nav - package org.vaadin.addons.joelpop.appnavlayout.ui.nav
org.vaadin.addons.joelpop.appnavlayout.ui.view - package org.vaadin.addons.joelpop.appnavlayout.ui.view
Orientation - Enum Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: Viewport orientation detected from window inner dimensions at connection time.

P

parent() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavGroup: Returns the parent group, or null if this is a root group.
parent() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Parent node, or empty for top-level nodes.
PathPrefixNavGrouper - Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: Default NavGrouper — derives the navigation hierarchy from route path segments, mirroring the structure of @Route paths.
PathPrefixNavGrouper() - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.nav.PathPrefixNavGrouper
pathSegments(String) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.RouteNavUtils: Returns the path segments of a route path as an immutable list.
PHONE - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.DeviceType
PORTRAIT - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.Orientation
primarySlot(NavSlots) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer
primarySlot(NavSlots) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer

R

RAIL - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavType: Permanent left-strip icon rail.
render(NavRenderContext) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer
render(NavRenderContext) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer
render(NavRenderContext) - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavRenderer: Builds or updates this renderer's content for the current nav state.
render(NavRenderContext) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideNavDrawerNavRenderer
reset() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavGrouper: Clears any cached state so the next NavGrouper.nodeFor(MenuEntry) calls start fresh.
reset() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.PathPrefixNavGrouper
RouteNavUtils - Class in org.vaadin.addons.joelpop.appnavlayout.ui.nav: Stateless helpers for navigating the route hierarchy.
routeSegmentLabel(String) - Static method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.RouteNavUtils: Converts a URL route segment to a human-readable label by capitalising each hyphen-delimited word.

S

setDesktopNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for the desktop scenario, constructed at most once, the first time it's actually needed.
setNavGroupDefResolver(Function) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.PathPrefixNavGrouper: Sets the resolver that maps a MenuEntry to its NavGroup; return null to use path-based grouping.
setNavGrouper(NavGrouper) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the nav grouping strategy.
setNavMatchNested(boolean) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Controls whether desktop SideNavItems use nested-route matching (SideNavItem.setMatchNested(boolean)), which causes a parent item to appear active whenever any of its child routes is current.
setNavNodeRenderer(ComponentRenderer) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the SideNavItem renderer for the desktop side nav.
setNavPathMatcher(BiPredicate) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the predicate used to determine whether the current navigation path belongs to a nav item's section.
setPhoneLandscapeNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for the landscape-phone scenario, constructed at most once, the first time it's actually needed.
setPhoneNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for both phone orientations at once, sharing a single memoized instance between them — equivalent to calling AppNavLayout.setPhonePortraitNavRenderer(Supplier) and AppNavLayout.setPhoneLandscapeNavRenderer(Supplier) with a shared supplier, not two independent ones.
setPhonePortraitNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for the portrait-phone scenario, constructed at most once, the first time it's actually needed.
setTabletLandscapeNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for the landscape-tablet scenario, constructed at most once, the first time it's actually needed.
setTabletMinShortSidePx(int) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the physical-screen-shorter-side threshold, in CSS pixels, used to distinguish DeviceType.TABLET from DeviceType.PHONE among touch devices (default 768 — the common responsive-design convention for the tablet/phone boundary, matching an iPad's portrait-mode shortest side and Bootstrap's md breakpoint).
setTabletNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for both tablet orientations at once, sharing a single memoized instance between them — equivalent to calling AppNavLayout.setTabletPortraitNavRenderer(Supplier) and AppNavLayout.setTabletLandscapeNavRenderer(Supplier) with a shared supplier, not two independent ones.
setTabletPortraitNavRenderer(Supplier) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Overrides the NavRenderer used for the portrait-tablet scenario, constructed at most once, the first time it's actually needed.
setUserMenu(Component) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Sets the user-context widget (avatar, name, account menu).
setViewIconGenerator(Function) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Sets the icon generator for leaf nav items.
setViewIconGenerator(Function) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.PathPrefixNavGrouper: Sets the icon generator for leaf nav nodes; default returns no icon.
setViewNavGroupResolver(Function) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Sets the nav-group resolver used by the default PathPrefixNavGrouper.
setViewTitleGenerator(Function) - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.AppNavLayout: Sets the title generator for leaf nav items in the desktop SideNav.
SIDENAV - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavType: Drawer-based SideNav.
SideNavDrawerNavRenderer - Class in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Default NavRenderer for NavType.SIDENAV — builds a full SideNav hierarchy into NavSlots.drawer(), using the SideNavItem renderer configured via AppNavLayout.setNavNodeRenderer(ComponentRenderer) and the nested-match setting from AppNavLayout.setNavMatchNested(boolean).
SideNavDrawerNavRenderer() - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideNavDrawerNavRenderer
sideRail() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavSlots: The tablet nav location (both orientations, by default), the left-edge rail.
SideRailNavRenderer - Class in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Default NavRenderer for NavType.RAIL — a left-edge icon rail in NavSlots.sideRail(), with a "More" overflow trigger when more root sections exist than fit, plus a two-level drill-down bar in NavSlots.headerNav().
SideRailNavRenderer() - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.SideRailNavRenderer
slots() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavRenderContext: The full set of named locations available to render into.

T

TABLET - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.DeviceType
title() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavGroup: Display title for this group node.
title() - Method in class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavNode: Display title for this node.
TOUCH - Enum constant in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavType: Touch-optimised bottom bar and secondary tab bar.
touchBar() - Method in interface org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.NavSlots: The phone nav location, the bottom bar.
TouchBarNavRenderer - Class in org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav: Default NavRenderer for NavType.TOUCH — a bottom icon bar in NavSlots.touchBar(), with a "More" overflow trigger when more root sections exist than fit, plus a two-level drill-down bar in NavSlots.headerNav().
TouchBarNavRenderer() - Constructor for class org.vaadin.addons.joelpop.appnavlayout.ui.layout.appnav.TouchBarNavRenderer

V

valueOf(String) - Static method in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.DeviceType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.NavType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.Orientation: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.vaadin.addons.joelpop.appnavlayout.ui.nav.DeviceType: 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.joelpop.appnavlayout.ui.nav.NavType: 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.joelpop.appnavlayout.ui.nav.Orientation: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form