com.vaadin.flow.component.applayout

Class AppLayoutMenu

java.lang.Object

com.vaadin.flow.component.applayout.AppLayoutMenu

All Implemented Interfaces:

AttachNotifier, HasElement, Serializable

public class AppLayoutMenu
extends Object
implements HasElement, AttachNotifier

Menu to be used with AppLayout. Provides clicable tabs that can be used for routing or individual actions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AppLayoutMenu() Default constructor.

Method Summary

Modifier and Type	Method and Description
AppLayoutMenuItem	addMenuItem(AppLayoutMenuItem item) Adds item to the menu.
AppLayoutMenuItem	addMenuItem(Component icon) Constructs a new object with the given icon.
AppLayoutMenuItem	addMenuItem(Component icon, ComponentEventListener<MenuItemClickEvent> listener) Constructs a new object with the given icon and click listener.
AppLayoutMenuItem	addMenuItem(Component icon, String title) Constructs a new object with the given icon and title.
AppLayoutMenuItem	addMenuItem(Component icon, String title, ComponentEventListener<MenuItemClickEvent> listener) Constructs a new object with the given icon, title and click listener.
AppLayoutMenuItem	addMenuItem(Component icon, String title, String route) Constructs a new object with the given icon, title and route.
AppLayoutMenuItem	addMenuItem(String title) Constructs a new object with the given title.
AppLayoutMenuItem	addMenuItem(String title, ComponentEventListener<MenuItemClickEvent> listener) Constructs a new object with the given title and click listener.
void	addMenuItems(AppLayoutMenuItem... menuItems) Adds menu items to the menu.
void	clearMenuItems() Removes all menu items.
Element	getElement() Gets the element associated with this instance.
Optional<AppLayoutMenuItem>	getMenuItemTargetingRoute(String route) Gets the first AppLayoutMenuItem targeting a route.
AppLayoutMenuItem	getSelectedMenuItem() Gets the currently selected menu item.
void	removeMenuItem(AppLayoutMenuItem menuItem) Removes AppLayoutMenuItem from the menu
void	selectMenuItem(AppLayoutMenuItem menuItem) Selects a menu item.
void	setMenuItems(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

Constructor Detail

AppLayoutMenu

public AppLayoutMenu()

Default constructor.

Method Detail

setMenuItems

public void setMenuItems(AppLayoutMenuItem... menuItems)

Clears existing menu items and sets the new the arguments.

Parameters:

menuItems - items of the type AppLayoutMenuItem to set

addMenuItems

public void addMenuItems(AppLayoutMenuItem... menuItems)

Adds menu items to the menu.

Parameters:

menuItems - items of the type AppLayoutMenuItem to 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 - AppLayoutMenuItem to 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 display

title - 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 display

title - the title to display

route - 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 display

listener - 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 display

listener - 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 display

title - the title to display

listener - the menu item click listener

removeMenuItem

public void removeMenuItem(AppLayoutMenuItem menuItem)

Removes AppLayoutMenuItem from the menu

clearMenuItems

public void clearMenuItems()

Removes all menu items.

selectMenuItem

public void selectMenuItem(AppLayoutMenuItem menuItem)

Selects a menu item.

Parameters:

menuItem - AppLayoutMenuItem to select

getMenuItemTargetingRoute

public Optional<AppLayoutMenuItem> getMenuItemTargetingRoute(String route)

Gets the first AppLayoutMenuItem targeting a route.

Parameters:

route - route to match to AppLayoutMenuItem.getRoute()

Returns:

AppLayoutMenuItem wrapped in an Optional, if found.

getSelectedMenuItem

public AppLayoutMenuItem getSelectedMenuItem()

Gets the currently selected menu item.

Returns:

AppLayoutMenuItem selected menu item.

getElement

public Element getElement()

Gets the element associated with this instance.

Specified by:

getElement in interface HasElement

Returns:

the element associated with this instance