org.drombler.acp.core.action

Interface MenuItemSortingStrategy<MenuItem,F extends MenuItemSupplierFactory<MenuItem>>

Type Parameters:

MenuItem - the GUI toolkit specific type for menu items

F - the sorting strategy specific menu item supplier factory type

All Known Implementing Classes:

PositionSortingStrategy, TextMenuItemSortingStrategy

public interface MenuItemSortingStrategy<MenuItem,F extends MenuItemSupplierFactory<MenuItem>>

A custom sorting strategy for programmatically registered menus.

Author:

puce

See Also:

PositionSortingStrategy

Method Summary

Modifier and Type	Method and Description
int	getMenuItemInsertionPoint(List<? extends MenuItemSupplierFactoryEntry<MenuItem,F>> entryList, MenuItemSupplierFactoryEntry<MenuItem,F> entry) Gets the instertion point of the new menu entry.
Optional<Integer>	getSeparatorInsertionPoint(int index, List<? extends MenuItemSupplierFactoryEntry<MenuItem,F>> entryList, MenuItemSupplierFactoryEntry<MenuItem,F> entry) Gets the instertion point of a new separator.

Method Detail

getMenuItemInsertionPoint

int getMenuItemInsertionPoint(List<? extends MenuItemSupplierFactoryEntry<MenuItem,F>> entryList,
                              MenuItemSupplierFactoryEntry<MenuItem,F> entry)

Gets the instertion point of the new menu entry.

Parameters:

entryList - the existing menu entries

entry - the new entry

Returns:

the instertion point of the new menu entry

getSeparatorInsertionPoint

Optional<Integer> getSeparatorInsertionPoint(int index,
                                             List<? extends MenuItemSupplierFactoryEntry<MenuItem,F>> entryList,
                                             MenuItemSupplierFactoryEntry<MenuItem,F> entry)

Gets the instertion point of a new separator. Returns empty if no new separator should be added. This method gets called after getMenuItemInsertionPoint(java.util.List, org.drombler.acp.core.action.MenuItemSupplierFactoryEntry).

Parameters:

index - the index of the new menu entry which was added to the list

entryList - the existing menu entries including the new menu entry

entry - the new menu entry which was added to the list

Returns:

the instertion point of a new separator or empty if no new separator should be added