Summary: Methods | [Expand All]
public interface

MenuItemGroupingRule

com.pspdfkit.ui.toolbar.grouping.MenuItemGroupingRule
Known Indirect Subclasses

Class Overview

Interface for classes that will define rules for grouping ContextualToolbarMenuItems in the ContextualToolbar.

Summary

Public Methods
abstract boolean areGeneratedGroupItemsSelectable()
Indicates whether the group items (that are generated to fit items when not enough space) are selectable or not.
abstract List<ContextualToolbarMenuItem> groupMenuItems(List<ContextualToolbarMenuItem> flatItems, int capacity)
Performs grouping of the provided list of menu items based on the available toolbar capacity, meaning the max number of items it can fit.

Public Methods

public abstract boolean areGeneratedGroupItemsSelectable ()

Indicates whether the group items (that are generated to fit items when not enough space) are selectable or not.

Returns
  • true if created group menu items should be selectable, false otherwise.

public abstract List<ContextualToolbarMenuItem> groupMenuItems (List<ContextualToolbarMenuItem> flatItems, int capacity)

Performs grouping of the provided list of menu items based on the available toolbar capacity, meaning the max number of items it can fit.

Parameters
flatItems Menu items originally set to the toolbar (note: there should be no submenus here, just flat items).
capacity Maximum number of items the toolbar can fit (without optional drag and close buttons).
Returns
  • A re-ordered (could be left the same) list of menu items capacity that will ultimately be set on the toolbar.