nutrient/com.pspdfkit.ui.toolbar.grouping/MenuItemGroupingRule

MenuItemGroupingRule

interface ~~MenuItemGroupingRule~~

Deprecated

The Compose contextual toolbar only honors the pure-data getGroupPreset contract of this interface's subclasses; a custom groupMenuItems implementation is ignored. Implement com.pspdfkit.compose.toolbar.state.ContextualToolbarGroupingProvider with com.pspdfkit.compose.toolbar.state.ToolbarPresetEntry instead. Removed at the next major version.

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

Inheritors

DefaultMenuItemGroupingRule

Functions

areGeneratedGroupItemsSelectable

abstract fun areGeneratedGroupItemsSelectable(): Boolean

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

abstract fun groupMenuItems(@NonNull flatItems: List<ContextualToolbarMenuItem>, @IntRange(from = com.pspdfkit.ui.toolbar.grouping.presets.PresetMenuItemGroupingRule.MIN_TOOLBAR_CAPACITY) capacity: Int): List<ContextualToolbarMenuItem>

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