Module org.autogui

Package org.autogui.swing.util

Class PopupCategorized

java.lang.Object

org.autogui.swing.util.PopupCategorized

All Implemented Interfaces:

Cloneable, PopupExtension.PopupMenuBuilder

Direct Known Subclasses:

ObjectTableModel.PopupCategorizedForRowsOrCells, PopupCategorized.PopupCategorizedFixed

public class PopupCategorized
extends Object
implements PopupExtension.PopupMenuBuilder, Cloneable

a menu builder for categorizing items.

     [ labelItem1 //PopupCategorized.CategorizedMenuItemLabel,
       labelItem2,
       ...
      category1,
      [item1_1: icon, name],
      [item1_2  ... ],
      ...
      category2,
      item2_1,
      item2_2,
      ...,
      ]
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PopupCategorized.CategorizedMenuItem	the categorized menu item
static interface	PopupCategorized.CategorizedMenuItemAction	an action with category info.
static interface	PopupCategorized.CategorizedMenuItemActionCheck	an action with category info, which becomes a check-box menu item
static class	PopupCategorized.CategorizedMenuItemActionCheckDelegate	a check-box menu item version of PopupCategorized.CategorizedMenuItemActionDelegate
static class	PopupCategorized.CategorizedMenuItemActionDelegate	an action wraps another action for supplying category info.
static interface	PopupCategorized.CategorizedMenuItemComponent	a categorized menu item with a menu-item component.
static class	PopupCategorized.CategorizedMenuItemComponentDefault	the default impl.
static class	PopupCategorized.CategorizedMenuItemComponentDelegate	a PopupCategorized.CategorizedMenuItemComponent with custom category and subCategory
static interface	PopupCategorized.CategorizedMenuItemLabel	a label: special category
static class	PopupCategorized.CategorizedMenuItemLabelDelegate	a PopupCategorized.CategorizedMenuItemLabel with custom category and subCategory
static class	PopupCategorized.PopupCategorizedBuildingItems	intermediate state for building items
static class	PopupCategorized.PopupCategorizedFixed	another menu builder with limiting items
static class	PopupCategorized.SearchPopupAction	an action for selecting a PopupCategorized.CategorizedMenuItem

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATEGORY_ACTION
static String	CATEGORY_LABEL
protected Consumer<PopupCategorized.CategorizedMenuItem>	itemConsumer
protected Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>>	itemSupplier
protected MenuBuilder	menuBuilder
static String	SUB_CATEGORY_LABEL_ACTION
static String	SUB_CATEGORY_LABEL_HEADER
static String	SUB_CATEGORY_LABEL_MISC
static String	SUB_CATEGORY_LABEL_TYPE
static String	SUB_CATEGORY_LABEL_VALUE

Constructor Summary

Constructors

Constructor	Description
PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier)
PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier, Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer)
PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier, Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer, MenuBuilder menuBuilder)

Method Summary

Modifier and Type	Method	Description
void	build(PopupExtension.PopupMenuFilter filter, Consumer<Object> menu)	the Consumer accepts Action including JMenu and JPopupMenu JMenuItem JComponent
void	buildCategories(Consumer<Object> menu, Map<String,List<JComponent>> categorizedMenuItems, int totalSize)
protected void	buildCleanEmptyCategories(Map<String,List<JComponent>> categorizedMenuItems)
protected void	buildMergeSubCategories(Map<String,Map<String,List<JComponent>>> subCategorizedMenuItems, Map<String,List<JComponent>> categorizedMenuItems)
protected void	buildNothing(PopupExtension.PopupMenuFilter filter, Consumer<Object> menu)
protected int	buildSubCategories(List<PopupCategorized.CategorizedMenuItem> items, Map<String,Map<String,List<JComponent>>> subCategorizedMenuItems)
protected Object	clone()
JComponent	createMenuItem(PopupCategorized.CategorizedMenuItem item)
JComponent	createMenuItemFromObject(Object i)
List<JComponent>	createMenuItems(List<Object> items)
Map<String,Map<String,List<JComponent>>>	createNewCategoryToSubCategoryToItems()
Map<String,List<JComponent>>	createNewSubCategoryToItems()
protected PopupCategorized.PopupCategorizedBuildingItems	createPopupCategorizedBuildingItems(PopupExtension.PopupMenuFilter filter)
Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>>	getItemSupplier()
static JMenuItem	getJMenuItem(PopupCategorized.CategorizedMenuItem item)
MenuBuilder	getMenuBuilder()
static PopupCategorized.CategorizedMenuItem	getMenuItem(Object item)
static Action	getMenuItemAction(PopupCategorized.CategorizedMenuItem item)
static List<PopupCategorized.CategorizedMenuItem>	getMenuItems(List<?>... itemsList)
static Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>>	getMenuItemsSupplier(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>>... itemsList)
List<String>	getPredefinedCategoriesOrder()
List<String>	getPredefinedSubCategoriesOrder()
void	select(PopupCategorized.CategorizedMenuItem item)
void	setItemSupplier(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier)
void	setMenuBuilder(MenuBuilder menuBuilder)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.swing.util.PopupExtension.PopupMenuBuilder

buildWithClear

Field Details

itemSupplier

protected Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier

itemConsumer

protected Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer

menuBuilder

protected MenuBuilder menuBuilder

CATEGORY_LABEL

public static String CATEGORY_LABEL

CATEGORY_ACTION

public static String CATEGORY_ACTION

SUB_CATEGORY_LABEL_HEADER

public static String SUB_CATEGORY_LABEL_HEADER

SUB_CATEGORY_LABEL_TYPE

public static String SUB_CATEGORY_LABEL_TYPE

SUB_CATEGORY_LABEL_VALUE

public static String SUB_CATEGORY_LABEL_VALUE

SUB_CATEGORY_LABEL_MISC

public static String SUB_CATEGORY_LABEL_MISC

SUB_CATEGORY_LABEL_ACTION

public static String SUB_CATEGORY_LABEL_ACTION

Constructor Details

PopupCategorized

public PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier)

PopupCategorized

public PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier,
 Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer)

PopupCategorized

public PopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier,
 Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer,
 MenuBuilder menuBuilder)

Method Details

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getMenuItems

public static List<PopupCategorized.CategorizedMenuItem> getMenuItems(List<?>... itemsList)

Parameters:

itemsList - array of list of one of PopupCategorized.CategorizedMenuItem, Action or JComponent

Returns:

a list of PopupCategorized.CategorizedMenuItem converted from arguments

getMenuItem

public static PopupCategorized.CategorizedMenuItem getMenuItem(Object item)

Parameters:

item - one of PopupCategorized.CategorizedMenuItem, Action or JComponent, otherwise, throws an exception

Returns:

a PopupCategorized.CategorizedMenuItem converted from the item

getMenuItemAction

public static Action getMenuItemAction(PopupCategorized.CategorizedMenuItem item)

getJMenuItem

public static JMenuItem getJMenuItem(PopupCategorized.CategorizedMenuItem item)

Parameters:

item - tested

Returns:

a JMenuItem or null, no allocation in the class

getMenuItemsSupplier

@SafeVarargs
public static Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> getMenuItemsSupplier(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>>... itemsList)

getItemSupplier

public Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> getItemSupplier()

setItemSupplier

public void setItemSupplier(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier)

build

public void build(PopupExtension.PopupMenuFilter filter,
 Consumer<Object> menu)

Description copied from interface: PopupExtension.PopupMenuBuilder

the Consumer accepts

• Action including JMenu and JPopupMenu
• JMenuItem
• JComponent

Specified by:

build in interface PopupExtension.PopupMenuBuilder

Parameters:

filter - an item filter

menu - the target for appending menus

createPopupCategorizedBuildingItems

protected PopupCategorized.PopupCategorizedBuildingItems createPopupCategorizedBuildingItems(PopupExtension.PopupMenuFilter filter)

buildSubCategories

protected int buildSubCategories(List<PopupCategorized.CategorizedMenuItem> items,
 Map<String,Map<String,List<JComponent>>> subCategorizedMenuItems)

buildMergeSubCategories

protected void buildMergeSubCategories(Map<String,Map<String,List<JComponent>>> subCategorizedMenuItems,
 Map<String,List<JComponent>> categorizedMenuItems)

buildCleanEmptyCategories

protected void buildCleanEmptyCategories(Map<String,List<JComponent>> categorizedMenuItems)

buildNothing

protected void buildNothing(PopupExtension.PopupMenuFilter filter,
 Consumer<Object> menu)

createNewCategoryToSubCategoryToItems

public Map<String,Map<String,List<JComponent>>> createNewCategoryToSubCategoryToItems()

createNewSubCategoryToItems

public Map<String,List<JComponent>> createNewSubCategoryToItems()

getPredefinedCategoriesOrder

public List<String> getPredefinedCategoriesOrder()

Returns:

always initially added categories. Note: categories which has no items will be removed after adding, and thus there are no separators for the categories

getPredefinedSubCategoriesOrder

public List<String> getPredefinedSubCategoriesOrder()

Returns:

always initially added sub-categories for any categories

getMenuBuilder

public MenuBuilder getMenuBuilder()

setMenuBuilder

public void setMenuBuilder(MenuBuilder menuBuilder)

createMenuItem

public JComponent createMenuItem(PopupCategorized.CategorizedMenuItem item)

createMenuItemFromObject

public JComponent createMenuItemFromObject(Object i)

createMenuItems

public List<JComponent> createMenuItems(List<Object> items)

buildCategories

public void buildCategories(Consumer<Object> menu,
 Map<String,List<JComponent>> categorizedMenuItems,
 int totalSize)

select

public void select(PopupCategorized.CategorizedMenuItem item)