pspdfkit/com.pspdfkit.ui.toolbar/ContextualToolbar

ContextualToolbar

abstract class ContextualToolbar<T : SpecialModeController?> : ViewGroup, View.OnClickListener, View.OnLongClickListener

Base class of all contextual toolbars.

Parameters

<T>

A SpecialModeController type handled by this toolbar.

Inheritors

DocumentEditingToolbar

TextSelectionToolbar

ContentEditingToolbar

AnnotationCreationToolbar

AnnotationEditingToolbar

Types

OnMenuItemClickListener

interface OnMenuItemClickListener

Listener for menu items clicks.

OnMenuItemLongClickListener

interface OnMenuItemLongClickListener

Listener for long clicks on menu items with submenu.

Properties

CONTEXTUAL_TOOLBAR_PADDING_DP

val CONTEXTUAL_TOOLBAR_PADDING_DP: Int = 5

DEFAULT_TOOLBAR_HEIGHT

val DEFAULT_TOOLBAR_HEIGHT: Int = 58

The default toolbar height in DP (in horizontal mode, otherwise it's the toolbar width)

DRAG_BUTTON_ALPHA

val DRAG_BUTTON_ALPHA: Int = 186

Alpha value of the drag button (if visible).

open var dragButton: ContextualToolbarMenuItem

A special button used for dragging the toolbar.

open var isAttached: Boolean

Indicates whether the toolbar is attached to the edge or it's being moved.

open var isDraggable: Boolean

Indicates whether the toolbar can be dragged to a different position.

open var menuItems: List<ContextualToolbarMenuItem>

Items set on the toolbar.

MIN_TOOLBAR_CAPACITY

val MIN_TOOLBAR_CAPACITY: Int = 4

Minimal number of spaces left on the toolbar for menu icons.

Functions

abstract fun bindController(specialModeController: T)

Binds the special mode controller to this toolbar.

open fun findItemById(@IdRes menuItemId: Int): ContextualToolbarMenuItem

Finds a menu item with specific ID in a list of currently displayed menu items.

open fun getCloseButton(): ContextualToolbarMenuItem

Returns the button used to close the toolbar.

getParentMenuId

open fun getParentMenuId(childMenuId: Int): Int

open fun getPosition(): ToolbarCoordinatorLayout.LayoutParams.Position

Gets position of the toolbar.

getSubmenuSizePx

open fun getSubmenuSizePx(): Int

Returns the submenu's size in pixels, or the amount of space needed for the submenu.

hasOpenedSubmenu

open fun hasOpenedSubmenu(): Boolean

Returns true if this contextual toolbar have currently opened submenu.

isControllerBound

abstract fun isControllerBound(): Boolean

Returns true if the controller is bound.

open fun onBackPressed(): Boolean

Called when onBackPressed() to wire up back press with back and close buttons.

open fun onClick(v: View)

open fun onLongClick(v: View): Boolean

Called when a view has been clicked and held.

onMenuItemsGrouped

open fun onMenuItemsGrouped(@NonNull menuItems: List<ContextualToolbarMenuItem>): List<ContextualToolbarMenuItem>

A method called once the flat items provided through setMenuItems have been grouped by the MenuItemGroupingRule that can be set with setMenuItemGroupingRule and with DefaultMenuItemGroupingRule as the default one.

open fun onTouchEvent(event: MotionEvent): Boolean

open fun setCloseButton(closeButton: ContextualToolbarMenuItem)

Sets the button used to close the toolbar.

setMenuItemEnabled

open fun setMenuItemEnabled(@IdRes menuItemId: Int, enabled: Boolean): Boolean

Enables or disables a menu item if that menu item currently exists.

setMenuItemGroupingRule

open fun setMenuItemGroupingRule(@Nullable groupingRule: MenuItemGroupingRule)

Sets the rule for grouping menu items.

setMenuItemVisibility

open fun setMenuItemVisibility(@IdRes menuItemId: Int, visibility: Int): Boolean

Shows or hides a menu item if that menu item currently exists.

setOnMenuItemClickListener

open fun setOnMenuItemClickListener(@Nullable listener: ContextualToolbar.OnMenuItemClickListener)

Sets a listener for menu item clicks on the toolbar.

setOnMenuItemLongClickListener

open fun setOnMenuItemLongClickListener(@Nullable listener: ContextualToolbar.OnMenuItemLongClickListener)

Sets a listener for menu item long clicks.

open fun setPosition(position: ToolbarCoordinatorLayout.LayoutParams.Position)

Sets position of the toolbar.

setToolbarCoordinatorController

open fun setToolbarCoordinatorController(@Nullable coordinatorController: ToolbarCoordinatorLayoutController)

Sets the toolbar coordinator controller for communication with .

setUseBackButtonForCloseWhenHorizontal

open fun setUseBackButtonForCloseWhenHorizontal(useBackButtonForCloseWhenHorizontal: Boolean)

Sets whether to use back button for closing the toolbar when the toolbar is placed horizontally.

unbindController

abstract fun unbindController()

Unbinds the bound controller (if any).