appcompat/androidx.appcompat.view.menu/MenuBuilder

MenuBuilder

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open class MenuBuilder : SupportMenu(source)

Implementation of the androidx.core.internal.view.SupportMenu interface for creating a standard menu UI.

Inheritors

Constructors

constructor(context: Context)

Types

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

interface Callback

Called by menu to notify of close and selection changes.

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

interface ItemInvoker

Called by menu items to execute their associated action

Functions

open fun add(titleRes: Int): MenuItem

open fun add(title: CharSequence): MenuItem

open fun add(group: Int, id: Int, categoryOrder: Int, title: Int): MenuItem

open fun add(group: Int, id: Int, categoryOrder: Int, title: CharSequence): MenuItem

addIntentOptions

open fun addIntentOptions(group: Int, id: Int, categoryOrder: Int, caller: ComponentName, specifics: Array<Intent>, intent: Intent, flags: Int, outSpecificItems: Array<MenuItem>): Int

addMenuPresenter

open fun addMenuPresenter(presenter: MenuPresenter)

Add a presenter to this menu.

open fun addMenuPresenter(presenter: MenuPresenter, menuContext: Context)

Add a presenter to this menu that uses an alternate context for inflating menu items.

open fun addSubMenu(titleRes: Int): SubMenu

open fun addSubMenu(title: CharSequence): SubMenu

open fun addSubMenu(group: Int, id: Int, categoryOrder: Int, title: Int): SubMenu

open fun addSubMenu(group: Int, id: Int, categoryOrder: Int, title: CharSequence): SubMenu

open fun changeMenuMode()

Dispatch a mode change event to this menu's callback.

open fun clear()

open fun clearAll()

open fun clearHeader()

open fun close()

fun close(closeAllMenus: Boolean)

Closes the menu.

collapseItemActionView

open fun collapseItemActionView(item: MenuItemImpl): Boolean

expandItemActionView

open fun expandItemActionView(item: MenuItemImpl): Boolean

open fun findGroupIndex(group: Int): Int

open fun findGroupIndex(group: Int, start: Int): Int

open fun findItem(id: Int): MenuItem

open fun findItemIndex(id: Int): Int

flagActionItems

open fun flagActionItems()

This method determines which menu items get to be 'action items' that will appear in an action bar and which items should be 'overflow items' in a secondary menu.

open fun getActionItems(): ArrayList<MenuItemImpl>

open fun getContext(): Context

getExpandedItem

open fun getExpandedItem(): MenuItemImpl

open fun getHeaderIcon(): Drawable

open fun getHeaderTitle(): CharSequence

open fun getHeaderView(): View

open fun getItem(index: Int): MenuItem

getNonActionItems

open fun getNonActionItems(): ArrayList<MenuItemImpl>

open fun getRootMenu(): MenuBuilder

Gets the root menu (if this is a submenu, find its root menu).

getVisibleItems

@NonNull

open fun getVisibleItems(): @NonNull ArrayList<MenuItemImpl>

hasVisibleItems

open fun hasVisibleItems(): Boolean

isDispatchingItemsChanged

open fun isDispatchingItemsChanged(): Boolean

isGroupDividerEnabled

open fun isGroupDividerEnabled(): Boolean

open fun isShortcutKey(keyCode: Int, event: KeyEvent): Boolean

isShortcutsVisible

open fun isShortcutsVisible(): Boolean

open fun onItemsChanged(structureChanged: Boolean)

Called when an item is added or removed.

performIdentifierAction

open fun performIdentifierAction(id: Int, flags: Int): Boolean

performItemAction

open fun performItemAction(item: MenuItem, flags: Int): Boolean

open fun performItemAction(item: MenuItem, preferredPresenter: MenuPresenter, flags: Int): Boolean

performShortcut

open fun performShortcut(keyCode: Int, event: KeyEvent, flags: Int): Boolean

open fun removeGroup(group: Int)

open fun removeItem(id: Int)

open fun removeItemAt(index: Int)

removeMenuPresenter

open fun removeMenuPresenter(presenter: MenuPresenter)

Remove a presenter from this menu.

restoreActionViewStates

open fun restoreActionViewStates(states: Bundle)

restorePresenterStates

open fun restorePresenterStates(state: Bundle)

saveActionViewStates

open fun saveActionViewStates(outStates: Bundle)

savePresenterStates

open fun savePresenterStates(outState: Bundle)

open fun setCallback(cb: MenuBuilder.Callback)

setCurrentMenuInfo

open fun setCurrentMenuInfo(menuInfo: ContextMenu.ContextMenuInfo)

Sets the current menu info that is set on all items added to this menu (until this is called again with different menu info, in which case that one will be added to all subsequent item additions).

setDefaultShowAsAction

open fun setDefaultShowAsAction(defaultShowAsAction: Int): MenuBuilder

setGroupCheckable

open fun setGroupCheckable(group: Int, checkable: Boolean, exclusive: Boolean)

setGroupDividerEnabled

open fun setGroupDividerEnabled(enabled: Boolean)

setGroupEnabled

open fun setGroupEnabled(group: Int, enabled: Boolean)

setGroupVisible

open fun setGroupVisible(group: Int, visible: Boolean)

setOptionalIconsVisible

open fun setOptionalIconsVisible(visible: Boolean)

setOverrideVisibleItems

open fun setOverrideVisibleItems(override: Boolean)

Allows us to override the value of hasVisibleItems and make it always return true.

open fun setQwertyMode(isQwerty: Boolean)

setShortcutsVisible

open fun setShortcutsVisible(shortcutsVisible: Boolean)

Sets whether the shortcuts should be visible on menus.

open fun size(): Int

startDispatchingItemsChanged

open fun startDispatchingItemsChanged()

stopDispatchingItemsChanged

open fun stopDispatchingItemsChanged()

Stop dispatching item changed events to presenters until startDispatchingItemsChanged is called.