pspdfkit/com.pspdfkit.ui.toolbar/ContextualToolbarMenuItem

ContextualToolbarMenuItem

open class ContextualToolbarMenuItem : AppCompatImageButton, View.OnLongClickListener, View.OnLayoutChangeListener

Represents a single menu item in the ContextualToolbar.

Types

Position

enum Position

Possible positions for toolbar menu items.

SubmenuIndicatorPosition

enum SubmenuIndicatorPosition

Possible positions for submenu indicator (in those views that have it).

Properties

defaultSelectedMenuItem

@Nullable

@get:Nullable

open var defaultSelectedMenuItem: ContextualToolbarMenuItem

Menu item that will be selected by default (used with items that have a submenu, items that don't will just use their instance here).

icon

@Nullable

@get:Nullable

open var icon: Drawable

Item's icon that will be tinted with the iconColor or iconColorActivated depending if selected or not.

iconColor

@ColorInt

@get:ColorInt

open var iconColor: Int

Tint color of the icon for unselected state.

iconColorActivated

@ColorInt

@get:ColorInt

open var iconColorActivated: Int

Tint color of the icon for selected state.

isSelectable

open var isSelectable: Boolean

If true, the item can be selected.

isSelected

open var isSelected: Boolean

Keeps track whether the toolbar menu item is selected or not.

isTextItemFirstFromEnd

open var isTextItemFirstFromEnd: Boolean

Indicates whether this menu item is first from the end and is a text

position

@NonNull

@get:NonNull

open var position: ContextualToolbarMenuItem.Position

Position at which the item will be placed in the toolbar, END by default.

subMenuItems

@Nullable

@get:Nullable

open val subMenuItems: List<ContextualToolbarMenuItem>

Long-pressing menu items with submenus opens other items in the toolbar for display.

title

@Nullable

@get:Nullable

open var title: String

Menu item title.

useAlternateBackground

open var useAlternateBackground: Boolean

Currently used only in the AnnotationCreationToolbar.

Functions

adaptSubmenuIndicatorToParentPosition

open fun adaptSubmenuIndicatorToParentPosition(@Nullable position: ToolbarCoordinatorLayout.LayoutParams.Position)

Used to allow parent to notify child items of it's new position so the submenu indicator arrow can be placed correctly.

createGroupItem

open fun createGroupItem(@IdRes id: Int, @NonNull position: ContextualToolbarMenuItem.Position, isSelectable: Boolean, @NonNull subMenuItems: List<ContextualToolbarMenuItem>, @NonNull defaultSelectedItem: ContextualToolbarMenuItem): ContextualToolbarMenuItem

Creates a contextual toolbar menu group item with the provided properties.

createSingleItem

open fun createSingleItem(@NonNull context: Context, @IdRes id: Int, @NonNull icon: Drawable, @NonNull title: String, @ColorInt iconColor: Int, @ColorInt iconColorActivated: Int, @NonNull position: ContextualToolbarMenuItem.Position, isSelectable: Boolean): ContextualToolbarMenuItem

Creates a contextual toolbar menu single item with the provided properties.

createSingleTextItem

open fun createSingleTextItem(@NonNull context: Context, @IdRes id: Int, @NonNull position: ContextualToolbarMenuItem.Position): ContextualToolbarMenuItem

Creates a contextual toolbar menu single ite, with the provided properties.

hasSubmenu

open fun hasSubmenu(): Boolean

Returns true if the menu item has a submenu.

hideColorIndicatorCircle

open fun hideColorIndicatorCircle()

onLayoutChange

open fun onLayoutChange(view: View, i: Int, i1: Int, i2: Int, i3: Int, i4: Int, i5: Int, i6: Int, i7: Int)

onLongClick

open fun onLongClick(v: View): Boolean

Called when a view has been clicked and held.

setCloseSubmenuOnItemClick

open fun setCloseSubmenuOnItemClick(shouldCloseSubmenuOnItemClick: Boolean)

Sets if the submenu should be hidden when any item in the submenu is clicked.

setDisplayOutsideOfSubmenuIfPossible

open fun setDisplayOutsideOfSubmenuIfPossible(displayOutsideOfSubmenuIfPossible: Boolean)

Sets to display menu item as separate item outside of submenu if there's room in the toolbar.

setEnabled

open fun setEnabled(enabled: Boolean)

Sets the enabled state of this view.

setOpenSubmenuOnClick

open fun setOpenSubmenuOnClick(openSubmenuOnClick: Boolean)

Sets if the submenu should be opened after clicking on the menu item.

setSubMenuItems

open fun setSubMenuItems(@Nullable subMenuItems: List<ContextualToolbarMenuItem>, @Nullable defaultSelectedMenuItem: ContextualToolbarMenuItem)

Sets the submenu items to the menu item and a default selected item.

setTintingEnabled

open fun setTintingEnabled(useTint: Boolean)

Sets whether the icon should be tinted in iconColor or left as originally provided.

shouldCloseSubmenuOnItemClick

open fun shouldCloseSubmenuOnItemClick(@NonNull clickedSubmenuItem: ContextualToolbarMenuItem): Boolean

Indicates whether the submenu should be closed after clicking on its items.

shouldDisplayOutsideOfSubmenuIfPossible

open fun shouldDisplayOutsideOfSubmenuIfPossible(): Boolean

Check whether this item can be expanded from submenu if there's room in the toolbar.

shouldOpenSubmenuOnClick

open fun shouldOpenSubmenuOnClick(): Boolean

Indicates whether the submenu should be opened after clicking on the menu item.

showColorIndicatorCircle

open fun showColorIndicatorCircle(@ColorInt color: Int, sizeValue: Float)