Index

A C G I R S
All Classes and Interfaces|All Packages|Serialized Form

A

addItem(SideNavItem...) - Method in class com.vaadin.flow.component.sidenav.SideNav

Adds navigation menu item(s) to the menu.

addItemAsFirst(SideNavItem) - Method in class com.vaadin.flow.component.sidenav.SideNav

Adds the given navigation item as the first child of this navigation item.

addItemAtIndex(int, SideNavItem) - Method in class com.vaadin.flow.component.sidenav.SideNav

Adds the given item as child of this navigation item at the specific index.

C

com.vaadin.flow.component.sidenav - package com.vaadin.flow.component.sidenav

G

getI18n() - Method in class com.vaadin.flow.component.sidenav.SideNav

Gets the internationalization object previously set for this component.

getItems() - Method in class com.vaadin.flow.component.sidenav.SideNav

Gets the items added to this navigation item (the children of this component that are instances of SideNavItem).

getLabel() - Method in class com.vaadin.flow.component.sidenav.SideNav

Gets the label of this side navigation menu.

getLabel() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets the label of this menu item.

getPath() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets the path this navigation item links to.

getPathAliases() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets the path aliases for this item.

getTarget() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets the target of this item.

getToggle() - Method in class com.vaadin.flow.component.sidenav.SideNav.SideNavI18n

The text announced by screen readers when focusing the button for toggling child items.

I

isCollapsible() - Method in class com.vaadin.flow.component.sidenav.SideNav

Check if the end user is allowed to collapse/hide and expand/show the navigation items.

isExpanded() - Method in class com.vaadin.flow.component.sidenav.SideNav

Returns whether the side navigation menu is expanded or collapsed.

isExpanded() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Returns whether the side navigation menu item is expanded or collapsed.

isMatchNested() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets whether this item also matches nested paths / routes.

isOpenInNewBrowserTab() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Gets whether the target URL should be opened in a new browser tab.

isRouterIgnore() - Method in class com.vaadin.flow.component.sidenav.SideNavItem

R

remove(SideNavItem...) - Method in class com.vaadin.flow.component.sidenav.SideNav

Removes the menu item(s) from the menu.

removeAll() - Method in class com.vaadin.flow.component.sidenav.SideNav

Removes all navigation menu items from this item.

S

setCollapsible(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNav

Allow the end user to collapse/hide and expand/show the navigation items.

setExpanded(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNav

Expands the side navigation menu.

setExpanded(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets the expanded status of the item.

setI18n(SideNav.SideNavI18n) - Method in class com.vaadin.flow.component.sidenav.SideNav

Updates the i18n settings in the web component.

setLabel(String) - Method in class com.vaadin.flow.component.sidenav.SideNav

Set a textual label for this side navigation menu.

setLabel(String) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Set a textual label for the item.

setMatchNested(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets whether to also match nested paths / routes.

setOpenInNewBrowserTab(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets whether the target URL should be opened in a new browser tab.

setPath(Class<? extends Component>) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Retrieves Route and RouteAlias annotations from the specified view, and then sets the corresponding path and path aliases for this item.

setPath(Class<? extends Component>, RouteParameters) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Retrieves Route and RouteAlias annotations from the specified view, and then sets the corresponding path and path aliases for this item.

setPath(String) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets the path in a form or a URL string this navigation item links to.

setPathAliases(Set<String>) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets the specified path aliases to this item.

setQueryParameters(QueryParameters) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Sets the QueryParameters of this item.

setRouterIgnore(boolean) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

The routing mechanism in Vaadin by default intercepts all side nav items with a relative URL.

setTarget(String) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

Where to display the linked URL, as the name for a browsing context.

setToggle(String) - Method in class com.vaadin.flow.component.sidenav.SideNav.SideNavI18n

Sets the text announced by screen readers when focusing the button for toggling child items.

setupSideNavItem(SideNavItem) - Method in class com.vaadin.flow.component.sidenav.SideNavItem

setupSideNavItem(SideNavItem) - Method in class com.vaadin.flow.component.sidenav.SideNav

Implement this method to set up/modify the SideNavItem right before it's added to the list of the navigation items.

SideNav - Class in com.vaadin.flow.component.sidenav

A side navigation menu with support for hierarchical and flat menus.

SideNav() - Constructor for class com.vaadin.flow.component.sidenav.SideNav

Creates a new menu without any label.

SideNav(String) - Constructor for class com.vaadin.flow.component.sidenav.SideNav

Creates a new menu with the given label.

SideNav.SideNavI18n - Class in com.vaadin.flow.component.sidenav

The internationalization properties for SideNav.

SideNavI18n() - Constructor for class com.vaadin.flow.component.sidenav.SideNav.SideNavI18n

SideNavItem - Class in com.vaadin.flow.component.sidenav

A menu item for the SideNav component.

SideNavItem(String) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a menu item which does not link to any view but only shows the given label.

SideNavItem(String, Class<? extends Component>) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label that links to the given view.

SideNavItem(String, Class<? extends Component>, Component) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.

SideNavItem(String, Class<? extends Component>, RouteParameters) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label that links to the given view.

SideNavItem(String, Class<? extends Component>, RouteParameters, Component) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label and prefix component (like an icon) that links to the given view.

SideNavItem(String, String) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label that links to the given path.

SideNavItem(String, String, Component) - Constructor for class com.vaadin.flow.component.sidenav.SideNavItem

Creates a new menu item using the given label and prefix component (like an icon) that links to the given path.

A C G I R S
All Classes and Interfaces|All Packages|Serialized Form