Uses of Class
com.foreach.across.modules.web.menu.Menu

Packages that use Menu

Package	Description
com.foreach.across.modules.web.events
com.foreach.across.modules.web.menu

Uses of Menu in com.foreach.across.modules.web.events

Classes in com.foreach.across.modules.web.events with type parameters of type Menu

Modifier and Type	Class	Description
class	BuildMenuEvent<T extends Menu>	Event fired by the MenuFactory whenever a menu is being generated.

Method parameters in com.foreach.across.modules.web.events with type arguments of type Menu

Modifier and Type	Method	Description
boolean	BuildMenuEvent.isForMenuOfType(@NonNull Class<? extends Menu> menuClass)	Check if the current build event is for a menu of the given type.

Uses of Menu in com.foreach.across.modules.web.menu

Classes in com.foreach.across.modules.web.menu with type parameters of type Menu

Modifier and Type	Interface	Description
interface	MenuBuilder<T extends Menu,E extends BuildMenuEvent<T>>	Takes care of menu assembly.
class	RequestMenuBuilder<T extends Menu,E extends BuildMenuEvent<T>>	Builds a menu and assigns the request path to the selected path.

Fields in com.foreach.across.modules.web.menu with type parameters of type Menu

Modifier and Type	Field	Description
static final Comparator<Menu>	Menu.SORT_BY_ORDER_AND_TITLE
static final Comparator<Menu>	Menu.SORT_BY_TITLE

Methods in com.foreach.across.modules.web.menu with type parameters of type Menu

Modifier and Type	Method	Description
<T extends Menu> T	MenuFactory.buildMenu(String name, Class<T> menuType)
<T extends Menu, E extends BuildMenuEvent<T>, B extends MenuBuilder<T, E>> T	MenuFactory.buildMenu(T menu)	Performs the build action on the given menu: publishes the build event, sorts and executes the selector attached to the event.
<T extends Menu> T	MenuStore.get(String name, Class<T> menuType)
<T extends Menu> T	RequestMenuStore.get(String name, Class<T> menuType)

Methods in com.foreach.across.modules.web.menu that return Menu

Modifier and Type	Method	Description
Menu	Menu.addItem(Menu item)
Menu	Menu.addItem(String path)
Menu	Menu.addItem(String path, String title)
Menu	Menu.addItem(String path, String title, String url)
Menu	PathBasedMenuBuilder.build()
Menu	MenuFactory.buildMenu(String name)	Fetches a generic menu with the given name.
Menu	MenuSelector.find(Menu menu)	Search the given Menu for an item that matches the current selector.
Menu	RequestMenuSelector.find(Menu menu)
Menu	TraversingMenuSelector.find(Menu menu)
Menu	MenuStore.get(String name)
Menu	RequestMenuStore.get(String name)
Menu	Menu.getFirstItem()
Menu	Menu.getItem(MenuSelector selector)	Fetches the item that matches the given MenuSelector.
Menu	Menu.getItemWithName(String name)	Fetches the first item with the name specified.
Menu	Menu.getItemWithPath(String path)	Fetches the first item with the path specified.
Menu	Menu.getLowestSelectedItem()	Returns the lowest selected item of this menu tree.
Menu	MenuFactory.getMenuWithName(String name)	Will search all MenuStore instances for a menu with the given name.
Menu	Menu.getParent()
Menu	Menu.getRoot()
Menu	Menu.getSelectedItem()	Returns the selected direct child of this menu.
Menu	MenuItemBuilderProcessor.process(Menu menu)
Menu	PrefixContextMenuItemBuilderProcessor.process(Menu menu)

Methods in com.foreach.across.modules.web.menu that return types with arguments of type Menu

Modifier and Type	Method	Description
Comparator<Menu>	Menu.getComparator()
Comparator<Menu>	FixedMenuOrderComparator.getFallbackComparator()
List<Menu>	Menu.getItems()
List<Menu>	Menu.getSelectedItemPath()	Returns all selected items (including the menu itself) in top-down order.

Methods in com.foreach.across.modules.web.menu with parameters of type Menu

Modifier and Type	Method	Description
Menu	Menu.addItem(Menu item)
void	PathBasedMenuBuilder.build(Menu menu)	Will build into the existing menu and merge the root only if the root has been configured on the builder.
void	PathBasedMenuBuilder.build(Menu menu, boolean ignoreRoot)	Builds the result of the builder in the existing instance.
int	FixedMenuOrderComparator.compare(Menu left, Menu right)
int	OrderComparatorWrapper.compare(Menu left, Menu right)
Menu	MenuSelector.find(Menu menu)	Search the given Menu for an item that matches the current selector.
Menu	RequestMenuSelector.find(Menu menu)
Menu	TraversingMenuSelector.find(Menu menu)
boolean	MenuMatcher.matches(Menu menu)
boolean	MenuMatchers.PathEqualityMenuMatcher.matches(Menu menu)
boolean	MenuMatchers.PathPatternMenuMatcher.matches(Menu menu)
protected abstract boolean	TraversingMenuSelector.matches(Menu item)
void	Menu.merge(Menu other, boolean ignoreRoot)	Merges the other menu into this one.
void	PathBasedMenuBuilder.merge(Menu menu)	Will merge into the existing menu and merge the root only if it has been configured on the builder.
void	PathBasedMenuBuilder.merge(Menu menu, boolean ignoreRoot)	Merges the result of the builder in the existing instance.
Menu	MenuItemBuilderProcessor.process(Menu menu)
Menu	PrefixContextMenuItemBuilderProcessor.process(Menu menu)
boolean	Menu.remove(Menu item)	Removes the menu item from the tree - disconnects it from its parent.
void	MenuStore.save(String name, Menu menu)
void	RequestMenuStore.save(String name, Menu menu)
protected void	RequestMenuBuilder.setContext(Menu menu)

Method parameters in com.foreach.across.modules.web.menu with type arguments of type Menu

Modifier and Type	Method	Description
PathBasedMenuBuilder.PathBasedMenuItemBuilder	PathBasedMenuBuilder.PathBasedMenuItemBuilder.comparator(Comparator<Menu> comparator, boolean inheritable)	Set the comparator to be used when sorting the children of this menu item.
void	Menu.setComparator(Comparator<Menu> comparator, boolean inheritable)	Set the comparator to be used when sorting this Menu.
void	FixedMenuOrderComparator.setFallbackComparator(Comparator<Menu> fallbackComparator)	Set the comparator that will be used in case the fixed order is the same.
protected void	Menu.sort(Comparator<Menu> inheritedComparator)

Constructors in com.foreach.across.modules.web.menu with parameters of type Menu

Modifier	Constructor	Description
	Menu(Menu original)	Copy constructor.

Constructor parameters in com.foreach.across.modules.web.menu with type arguments of type Menu

Modifier	Constructor	Description
	OrderComparatorWrapper(@NonNull Comparator<Menu> comparator)