Package io.jmix.flowui.menu.provider

Class MenuConfigMenuItemProvider<T extends MenuItem>

java.lang.Object

io.jmix.flowui.menu.provider.MenuConfigMenuItemProvider<T>

Type Parameters:

T - menu item type

All Implemented Interfaces:

MenuItemProvider<T>

Direct Known Subclasses:

MenuConfigHorizontalMenuItemProvider, MenuConfigListMenuItemProvider

public abstract class MenuConfigMenuItemProvider<T extends MenuItem>
extends Object
implements MenuItemProvider<T>

Provides base functionality for menu item providers which use MenuConfig as menu item source

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.menu.provider.MenuItemProvider

MenuItemProvider.CollectionChangeEvent<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected EventHub	events
protected MenuConfig	menuConfig
protected List<T>	menuItems
protected List<Function<List<T>,List<T>>>	transformers

Constructor Summary

Constructors

Constructor	Description
MenuConfigMenuItemProvider(MenuConfig menuConfig)

Method Summary

Modifier and Type	Method	Description
Subscription	addCollectionChangedListener(Consumer<MenuItemProvider.CollectionChangeEvent<T>> listener)	Adds a listener for an event of menu item collection change.
void	addMenuItemsTransformer(Function<List<T>,List<T>> itemsTransformer)	Adds a transform function which will be applied to menu items after load.
protected abstract List<T>	convertToMenuItems(Collection<MenuItem> menuConfigItems)	Converts menu config item descriptors to menu items of specific implementation
List<T>	getMenuItems()
void	load()	Loads menu items.
void	removeMenuItemsTransformer(Function<List<T>,List<T>> transformer)	Removes menu item transform function
protected List<T>	transformItems(List<T> menuItems)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

menuConfig

protected MenuConfig menuConfig

transformers

protected List<Function<List<T extends MenuItem>,List<T extends MenuItem>>> transformers

menuItems

protected List<T extends MenuItem> menuItems

events

protected EventHub events

Constructor Details

MenuConfigMenuItemProvider

public MenuConfigMenuItemProvider(MenuConfig menuConfig)

Method Details

load

public void load()

Description copied from interface: MenuItemProvider

Loads menu items.

Specified by:

load in interface MenuItemProvider<T extends MenuItem>

convertToMenuItems

protected abstract List<T> convertToMenuItems(Collection<MenuItem> menuConfigItems)

Converts menu config item descriptors to menu items of specific implementation

Parameters:

menuConfigItems - menu config item descriptors

Returns:

menu items of specific implementation

transformItems

protected List<T> transformItems(List<T> menuItems)

addCollectionChangedListener

public Subscription addCollectionChangedListener(Consumer<MenuItemProvider.CollectionChangeEvent<T>> listener)

Description copied from interface: MenuItemProvider

Adds a listener for an event of menu item collection change.

Specified by:

addCollectionChangedListener in interface MenuItemProvider<T extends MenuItem>

Parameters:

listener - a listener to add

Returns:

subscription for the listener

getMenuItems

public List<T> getMenuItems()

Specified by:

getMenuItems in interface MenuItemProvider<T extends MenuItem>

Returns:

loaded menu items.

addMenuItemsTransformer

public void addMenuItemsTransformer(Function<List<T>,List<T>> itemsTransformer)

Description copied from interface: MenuItemProvider

Adds a transform function which will be applied to menu items after load. It can be used to add some customizations to loaded items (for example, expand or collapse specific items).

Specified by:

addMenuItemsTransformer in interface MenuItemProvider<T extends MenuItem>

Parameters:

itemsTransformer - a transform function to add

removeMenuItemsTransformer

public void removeMenuItemsTransformer(Function<List<T>,List<T>> transformer)

Description copied from interface: MenuItemProvider

Removes menu item transform function

Specified by:

removeMenuItemsTransformer in interface MenuItemProvider<T extends MenuItem>

Parameters:

transformer - transform function to remove

See Also:

• MenuItemProvider.addMenuItemsTransformer(Function)