We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.applayout.
Class AppLayoutMenu
- java.lang.Object
-
- com.vaadin.flow.component.applayout.AppLayoutMenu
-
All Implemented Interfaces:
public class AppLayoutMenu extends Object implements HasElement, AttachNotifierMenu to be used with AppLayout. Provides clicable tabs that can be used for routing or individual actions.
See Also:
-
-
Constructor Summary
Constructors Constructor and Description AppLayoutMenu()Default constructor.
-
Method Summary
All Methods Modifier and Type Method and Description AppLayoutMenuItemaddMenuItem(AppLayoutMenuItem item)Adds item to the menu.
AppLayoutMenuItemaddMenuItem(Component icon)Constructs a new object with the given icon.
AppLayoutMenuItemaddMenuItem(Component icon, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given icon and click listener.
AppLayoutMenuItemaddMenuItem(Component icon, String title)Constructs a new object with the given icon and title.
AppLayoutMenuItemaddMenuItem(Component icon, String title, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given icon, title and click listener.
AppLayoutMenuItemaddMenuItem(Component icon, String title, String route)Constructs a new object with the given icon, title and route.
AppLayoutMenuItemaddMenuItem(String title)Constructs a new object with the given title.
AppLayoutMenuItemaddMenuItem(String title, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given title and click listener.
voidaddMenuItems(AppLayoutMenuItem... menuItems)Adds menu items to the menu.
voidclearMenuItems()Removes all menu items.
ElementgetElement()Gets the element associated with this instance.
Optional<AppLayoutMenuItem>getMenuItemTargetingRoute(String route)Gets the first
AppLayoutMenuItemtargeting a route.AppLayoutMenuItemgetSelectedMenuItem()Gets the currently selected menu item.
voidremoveMenuItem(AppLayoutMenuItem menuItem)Removes
AppLayoutMenuItemfrom the menuvoidselectMenuItem(AppLayoutMenuItem menuItem)Selects a menu item.
voidsetMenuItems(AppLayoutMenuItem... menuItems)Clears existing menu items and sets the new the arguments.
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
-
-
-
Method Detail
-
setMenuItems
public void setMenuItems(AppLayoutMenuItem... menuItems)Clears existing menu items and sets the new the arguments.
Parameters:
menuItems- items of the typeAppLayoutMenuItemto set
-
addMenuItems
public void addMenuItems(AppLayoutMenuItem... menuItems)Adds menu items to the menu.
Parameters:
menuItems- items of the typeAppLayoutMenuItemto add
-
addMenuItem
public AppLayoutMenuItem addMenuItem(String title)Constructs a new object with the given title.
Parameters:
title- the title to display
-
addMenuItem
public AppLayoutMenuItem addMenuItem(AppLayoutMenuItem item)Adds item to the menu.
Parameters:
item-AppLayoutMenuItemto add
-
addMenuItem
public AppLayoutMenuItem addMenuItem(Component icon)Constructs a new object with the given icon.
Parameters:
icon- the icon to display
-
addMenuItem
public AppLayoutMenuItem addMenuItem(Component icon, String title)Constructs a new object with the given icon and title.
Parameters:
icon- the icon to displaytitle- the title to display
-
addMenuItem
public AppLayoutMenuItem addMenuItem(Component icon, String title, String route)Constructs a new object with the given icon, title and route.
Parameters:
icon- the icon to displaytitle- the title to displayroute- the route to navigate on click
-
addMenuItem
public AppLayoutMenuItem addMenuItem(Component icon, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given icon and click listener.
Parameters:
icon- the icon to displaylistener- the menu item click listener
-
addMenuItem
public AppLayoutMenuItem addMenuItem(String title, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given title and click listener.
Parameters:
title- the title to displaylistener- the menu item click listener
-
addMenuItem
public AppLayoutMenuItem addMenuItem(Component icon, String title, ComponentEventListener<MenuItemClickEvent> listener)Constructs a new object with the given icon, title and click listener.
Parameters:
icon- the icon to displaytitle- the title to displaylistener- the menu item click listener
-
removeMenuItem
public void removeMenuItem(AppLayoutMenuItem menuItem)Removes
AppLayoutMenuItemfrom the menu
-
clearMenuItems
public void clearMenuItems()Removes all menu items.
-
selectMenuItem
public void selectMenuItem(AppLayoutMenuItem menuItem)Selects a menu item.
Parameters:
menuItem-AppLayoutMenuItemto select
-
getMenuItemTargetingRoute
public Optional<AppLayoutMenuItem> getMenuItemTargetingRoute(String route)Gets the first
AppLayoutMenuItemtargeting a route.Parameters:
route- route to match toAppLayoutMenuItem.getRoute()Returns:
AppLayoutMenuItemwrapped in anOptional, if found.
-
getSelectedMenuItem
public AppLayoutMenuItem getSelectedMenuItem()Gets the currently selected menu item.
Returns:
AppLayoutMenuItemselected menu item.
-
getElement
public Element getElement()Gets the element associated with this instance.
Specified by:
getElementin interfaceHasElementReturns:
the element associated with this instance
-
-