ActionMenuView

Kotlin |Java

open class ActionMenuView : LinearLayoutCompat, ItemInvoker, MenuView

kotlin.Any
↳	android.view.View
	↳	android.view.ViewGroup
		↳	androidx.appcompat.widget.LinearLayoutCompat
			↳	androidx.appcompat.widget.ActionMenuView

ActionMenuView is a presentation of a series of menu options as a View. It provides several top level options as action buttons while spilling remaining options over as items in an overflow menu. This allows applications to present packs of actions inline with specific or repeating content.

Summary

Nested classes
open	`LayoutParams`
abstract	`OnMenuItemClickListener` Interface responsible for receiving menu item click events if the items themselves do not have individual item click listeners.

Inherited constants

From class LinearLayoutCompat

`Int`	`HORIZONTAL`
`Int`	`SHOW_DIVIDER_BEGINNING` Show a divider at the beginning of the group.
`Int`	`SHOW_DIVIDER_END` Show a divider at the end of the group.
`Int`	`SHOW_DIVIDER_MIDDLE` Show dividers between each item in the group.
`Int`	`SHOW_DIVIDER_NONE` Don't show any dividers.
`Int`	`VERTICAL`

Public constructors
`<init>(@NonNull context: Context)`
`<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?)`

Public methods
open Unit	`dismissPopupMenus()` Dismiss any popups associated with this menu view.
open Boolean	`dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!)`
open ActionMenuView.LayoutParams!	`generateLayoutParams(attrs: AttributeSet!)`
open Menu!	`getMenu()` Returns the Menu object that this ActionMenuView is currently presenting.
open Drawable?	`getOverflowIcon()` Return the current drawable used as the overflow icon.
open Int	`getPopupTheme()`
open Boolean	`hideOverflowMenu()` Hide the overflow items from the associated menu.
open Boolean	`isOverflowMenuShowing()` Check whether the overflow menu is currently showing.
open Unit	`onConfigurationChanged(newConfig: Configuration!)`
open Unit	`onDetachedFromWindow()`
open Unit	`setOnMenuItemClickListener(listener: ActionMenuView.OnMenuItemClickListener!)`
open Unit	`setOverflowIcon(@Nullable icon: Drawable?)` Set the icon to use for the overflow button.
open Unit	`setPopupTheme(@StyleRes resId: Int)` Specifies the theme to use when inflating popup menus.
open Boolean	`showOverflowMenu()` Show the overflow items from the associated menu.

Protected methods
open Boolean	`checkLayoutParams(p: LayoutParams!)`
open ActionMenuView.LayoutParams!	`generateDefaultLayoutParams()`
open ActionMenuView.LayoutParams!	`generateLayoutParams(p: LayoutParams!)`
open Unit	`onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)`
open Unit	`onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)`

Inherited functions

From class LinearLayoutCompat

`Int`	`getBaseline()`
`Int`	`getBaselineAlignedChildIndex()`
`Drawable!`	`getDividerDrawable()`
`Int`	`getDividerPadding()` Get the padding size used to inset dividers in pixels
`Int`	`getGravity()` Returns the current gravity. See `android.view.Gravity`
`Int`	`getOrientation()` Returns the current orientation.
`Int`	`getShowDividers()`
`Float`	`getWeightSum()` Returns the desired weights sum.
`Boolean`	`isBaselineAligned()` Indicates whether widgets contained within this layout are aligned on their baseline or not.
`Boolean`	`isMeasureWithLargestChildEnabled()` When true, all children with a weight will be considered having the minimum size of the largest child. If false, all children are measured normally.
`Unit`	`onDraw(canvas: Canvas!)`
`Unit`	`onInitializeAccessibilityEvent(event: AccessibilityEvent!)`
`Unit`	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo!)`
`Unit`	`setBaselineAligned(baselineAligned: Boolean)` Defines whether widgets contained in this layout are baseline-aligned or not.
`Unit`	`setBaselineAlignedChildIndex(i: Int)`
`Unit`	`setDividerDrawable(divider: Drawable!)` Set a drawable to be used as a divider between items.
`Unit`	`setDividerPadding(padding: Int)` Set padding displayed on both ends of dividers.
`Unit`	`setGravity(gravity: Int)` Describes how the child views are positioned. Defaults to GRAVITY_TOP. If this layout has a VERTICAL orientation, this controls where all the child views are placed if there is extra vertical space. If this layout has a HORIZONTAL orientation, this controls the alignment of the children.
`Unit`	`setHorizontalGravity(horizontalGravity: Int)`
`Unit`	`setMeasureWithLargestChildEnabled(enabled: Boolean)` When set to true, all children with a weight will be considered having the minimum size of the largest child. If false, all children are measured normally. Disabled by default.
`Unit`	`setOrientation(orientation: Int)` Should the layout be a column or a row.
`Unit`	`setShowDividers(showDividers: Int)` Set how dividers should be shown between items in this layout
`Unit`	`setVerticalGravity(verticalGravity: Int)`
`Unit`	`setWeightSum(weightSum: Float)` Defines the desired weights sum. If unspecified the weights sum is computed at layout time by adding the layout_weight of each child. This can be used for instance to give a single child 50% of the total available space by giving it a layout_weight of 0.5 and setting the weightSum to 1.0.
`Boolean`	`shouldDelayChildPressedState()`

Public constructors

<init>

ActionMenuView(@NonNull context: Context)

<init>

ActionMenuView(
    @NonNull context: Context, 
    @Nullable attrs: AttributeSet?)

Public methods

dismissPopupMenus

open fun dismissPopupMenus(): Unit

Dismiss any popups associated with this menu view.

dispatchPopulateAccessibilityEvent

open fun dispatchPopulateAccessibilityEvent(event: AccessibilityEvent!): Boolean

generateLayoutParams

open fun generateLayoutParams(attrs: AttributeSet!): ActionMenuView.LayoutParams!

getMenu

open fun getMenu(): Menu!

Returns the Menu object that this ActionMenuView is currently presenting.

Applications should use this method to obtain the ActionMenuView's Menu object and inflate or add content to it as necessary.

Return
`Menu!`	the Menu presented by this view

getOverflowIcon

@Nullable open fun getOverflowIcon(): Drawable?

Return the current drawable used as the overflow icon.

Return
`Drawable?`	The overflow icon drawable

getPopupTheme

open fun getPopupTheme(): Int

Return
`Int`	resource identifier of the theme used to inflate popup menus, or 0 if menus are inflated against the action menu view theme

See Also

#setPopupTheme(int)

hideOverflowMenu

open fun hideOverflowMenu(): Boolean

Hide the overflow items from the associated menu.

Return
`Boolean`	true if the menu was able to be hidden, false otherwise

isOverflowMenuShowing

open fun isOverflowMenuShowing(): Boolean

Check whether the overflow menu is currently showing. This may not reflect a pending show operation in progress.

Return
`Boolean`	true if the overflow menu is currently showing

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration!): Unit

onDetachedFromWindow

open fun onDetachedFromWindow(): Unit

setOnMenuItemClickListener

open fun setOnMenuItemClickListener(listener: ActionMenuView.OnMenuItemClickListener!): Unit

setOverflowIcon

open fun setOverflowIcon(@Nullable icon: Drawable?): Unit

Set the icon to use for the overflow button.

Parameters
`icon`	Drawable?: Drawable to set, may be null to clear the icon

setPopupTheme

open fun setPopupTheme(@StyleRes resId: Int): Unit

Specifies the theme to use when inflating popup menus. By default, uses the same theme as the action menu view itself.

Parameters
`resId`	Int: theme used to inflate popup menus

See Also

#getPopupTheme()

showOverflowMenu

open fun showOverflowMenu(): Boolean

Show the overflow items from the associated menu.

Return
`Boolean`	true if the menu was able to be shown, false otherwise

Protected methods

checkLayoutParams

protected open fun checkLayoutParams(p: LayoutParams!): Boolean

generateDefaultLayoutParams

protected open fun generateDefaultLayoutParams(): ActionMenuView.LayoutParams!

generateLayoutParams

protected open fun generateLayoutParams(p: LayoutParams!): ActionMenuView.LayoutParams!

onLayout

protected open fun onLayout(
    changed: Boolean, 
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

onMeasure

protected open fun onMeasure(
    widthMeasureSpec: Int, 
    heightMeasureSpec: Int
): Unit

ActionMenuView

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited functions

Public constructors

<init>

<init>

Public methods

dismissPopupMenus

dispatchPopulateAccessibilityEvent

generateLayoutParams

getMenu

getOverflowIcon

getPopupTheme

hideOverflowMenu

isOverflowMenuShowing

onConfigurationChanged

onDetachedFromWindow

setOnMenuItemClickListener

setOverflowIcon

setPopupTheme

showOverflowMenu

Protected methods

checkLayoutParams

generateDefaultLayoutParams

generateLayoutParams

onLayout

onMeasure