Constructor Detail

Method Detail

• getDragButton

   ContextualToolbarMenuItem getDragButton()

  Returns the button used to drag the toolbar (if detachable).

  Returns:

  Contextual toolbar's drag button.

• setDragButton

   void setDragButton(ContextualToolbarMenuItem dragButton)

  Sets the button used to drag the toolbar (if detachable).

  Parameters:

  dragButton - Button to be set as a drag button.

• getMenuItems

  @NonNull() List<ContextualToolbarMenuItem> getMenuItems()

  Gets the list of originally set menu items. Note that the shown menu items in the toolbar could differ from structure because they could be altered by MenuItemGroupingRule that regroups items depending on the available space.

  Returns:

  List of originally set toolbar menu items.

• setMenuItems

   void setMenuItems(@NonNull() List<ContextualToolbarMenuItem> menuItems)

  Sets contextual toolbar menu items.

  Parameters:

  menuItems - Menu items to populate the toolbar.

• isDraggable

   boolean isDraggable()

  Returns true when toolbar is draggable.

• setDraggable

   void setDraggable(boolean draggable)

  Sets whether the toolbar is draggable or not.

  Parameters:

  draggable - If true, the toolbar can be dragged.

• isAttached

   final boolean isAttached()

  Indicates whether the toolbar is attached or detached.

  Returns:

  true if the toolbar is attached and can't be dragged around, false otherwise.

• setAttached

   final void setAttached(boolean isAttached)

  Sets whether the toolbar is attached or detached from the layout. Being detached means that it can be moved around (used for annotation editor toolbar). In the scope of this view, what it affects is coloring of the view - the toolbar is highlighted when detached. This is usually called from the outside (toolbar coordinator layout).

  Parameters:

  isAttached - true to set toolbar as attached, false as detached.

• getParentMenuId

   int getParentMenuId(int childMenuId)

• bindController

   abstract void bindController(T specialModeController)

  Binds the special mode controller to this toolbar.

  Parameters:

  specialModeController - Controller to bind to a toolbar.

• unbindController

   abstract void unbindController()

  Unbinds the bound controller (if any).

• isControllerBound

   abstract boolean isControllerBound()

  Returns true if the controller is bound.

• onTouchEvent

   boolean onTouchEvent(MotionEvent event)

• setMenuItemGroupingRule

   void setMenuItemGroupingRule(@Nullable() MenuItemGroupingRule groupingRule)

  Sets the rule for grouping menu items. Default one is .

  Parameters:

  groupingRule - Menu items grouping rule to be set.

• onMenuItemsGrouped

  @NonNull() List<ContextualToolbarMenuItem> onMenuItemsGrouped(@NonNull() List<ContextualToolbarMenuItem> menuItems)

  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.

  By overriding this method you can do final editing before items are added to the toolbar.

  Parameters:

  menuItems - Grouped menu items.

  Returns:

  Menu items to be set on the toolbar.

• getSubmenuSizePx

   int getSubmenuSizePx()

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

• getToolbarSizeInPx

  @Deprecated(forRemoval = true) int getToolbarSizeInPx()

  Returns the toolbar's size in pixels (height in horizontal mode, width in vertical mode) This method has been deprecated and will be removed in a later version. Use getHeight of this class instead

• onBackPressed

   boolean onBackPressed()

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

  Returns:

  true if the back press was handled, false otherwise.

• findItemById

  @Nullable() ContextualToolbarMenuItem findItemById(@IdRes() int menuItemId)

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

  Returns:

  A menu item currently displayed in the toolbar with the provided ID, or null if no menu item with the given identifier was found.

• setMenuItemVisibility

   boolean setMenuItemVisibility(@IdRes() int menuItemId, int visibility)

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

  Parameters:

  menuItemId - ID of the menu item.

  visibility - One of VISIBLE, INVISIBLE, or GONE.

  Returns:

  true if the menu item exists and it's visibility was changed.

• setMenuItemEnabled

   boolean setMenuItemEnabled(@IdRes() int menuItemId, boolean enabled)

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

  Parameters:

  menuItemId - ID of the menu item.

  enabled - true if the item should be enabled, false otherwise.

  Returns:

  true if the menu item exists and it's enabled status was applied.

• setToolbarCoordinatorController

   void setToolbarCoordinatorController(@Nullable() ToolbarCoordinatorLayoutController coordinatorController)

  Sets the toolbar coordinator controller for communication with . Calling this method will replace any previously set controller. You may provide null to clear the controller.

  Parameters:

  coordinatorController - ToolbarCoordinatorLayoutController that should be notified, or null to clear the controller.

• getCloseButton

   ContextualToolbarMenuItem getCloseButton()

  Returns the button used to close the toolbar.

  Returns:

  Contextual toolbar's close button.

• setCloseButton

   void setCloseButton(ContextualToolbarMenuItem closeButton)

  Sets the button used to close the toolbar.

  Parameters:

  closeButton - Button to be set as a close button.

• getPosition

  @NonNull() ToolbarCoordinatorLayout.LayoutParams.Position getPosition()

  Gets position of the toolbar.

  Returns:

  Position for the toolbar in the ToolbarCoordinatorLayout.

• setPosition

   void setPosition(ToolbarCoordinatorLayout.LayoutParams.Position position)

  Sets position of the toolbar.

  Parameters:

  position - Position for the toolbar in the ToolbarCoordinatorLayout.

• onClick

   void onClick(View v)

• onLongClick

   boolean onLongClick(View v)

  Called when a view has been clicked and held.

  Parameters:

  v - The view that was clicked and held.

  Returns:

  true if the callback consumed the long click, false otherwise.

• hasOpenedSubmenu

   boolean hasOpenedSubmenu()

  Returns true if this contextual toolbar have currently opened submenu.

• setUseBackButtonForCloseWhenHorizontal

   void setUseBackButtonForCloseWhenHorizontal(boolean useBackButtonForCloseWhenHorizontal)

  Sets whether to use back button for closing the toolbar when the toolbar is placed horizontally. Defaults to true. If false the 'X' button will be used and it will be placed on the end of the toolbar.

  Parameters:

  useBackButtonForCloseWhenHorizontal - true to use back button, false to use 'X' button

• setOnMenuItemClickListener

   void setOnMenuItemClickListener(@Nullable() ContextualToolbar.OnMenuItemClickListener listener)

  Sets a listener for menu item clicks on the toolbar. Calling this method will replace any previously set listener. You may provide null to clear the listener.

  Parameters:

  listener - OnMenuItemClickListener that should be notified, or null to clear the listener.

• setOnMenuItemLongClickListener

   void setOnMenuItemLongClickListener(@Nullable() ContextualToolbar.OnMenuItemLongClickListener listener)

  Sets a listener for menu item long clicks. Calling this method will replace any previously set listener. You may provide null to clear the listener.

  Parameters:

  listener - OnMenuItemLongClickListener that should be notified, or null to clear the listener.