ActionMode

DEFAULT_HIDE_DURATION

static val DEFAULT_HIDE_DURATION: Int

Default value to hide the action mode for ViewConfiguration#getDefaultActionModeHideDuration().

Value: -1

TYPE_FLOATING

static val TYPE_FLOATING: Int

The action mode is treated as a Floating Toolbar. Use with setType.

Value: 1

TYPE_PRIMARY

static val TYPE_PRIMARY: Int

The action mode is treated as a Primary mode. This is the default. Use with setType.

Value: 0

finish

abstract fun finish(): Unit

Finish and close this action mode. The action mode's ActionMode.Callback will have its Callback#onDestroyActionMode(ActionMode) method called.

getCustomView

abstract fun getCustomView(): View!

Returns the current custom view for this action mode.

getMenu

abstract fun getMenu(): Menu!

Returns the menu of actions that this action mode presents.

getMenuInflater

abstract fun getMenuInflater(): MenuInflater!

Returns a MenuInflater with the ActionMode's context.

getSubtitle

abstract fun getSubtitle(): CharSequence!

Returns the current subtitle of this action mode.

getTag

open fun getTag(): Any!

Retrieve the tag object associated with this ActionMode.

Like the tag available to views, this allows applications to associate arbitrary data with an ActionMode for later reference.

getTitle

abstract fun getTitle(): CharSequence!

Returns the current title of this action mode.

getTitleOptionalHint

open fun getTitleOptionalHint(): Boolean

getType

open fun getType(): Int

Returns the type for this action mode.

hide

open fun hide(duration: Long): Unit

Hide the action mode view from obstructing the content below for a short duration. This only makes sense for action modes that support dynamic positioning on the screen. If this method is called again before the hide duration expires, the later hide call will cancel the former and then take effect. NOTE that there is an internal limit to how long the mode can be hidden for. It's typically about a few seconds.

invalidate

abstract fun invalidate(): Unit

Invalidate the action mode and refresh menu content. The mode's ActionMode.Callback will have its Callback#onPrepareActionMode(ActionMode, Menu) method called. If it returns true the menu will be scanned for updated content and any relevant changes will be reflected to the user.

invalidateContentRect

open fun invalidateContentRect(): Unit

Invalidate the content rect associated to this ActionMode. This only makes sense for action modes that support dynamic positioning on the screen, and provides a more efficient way to reposition it without invalidating the whole action mode.

isTitleOptional

open fun isTitleOptional(): Boolean

onWindowFocusChanged

open fun onWindowFocusChanged(hasWindowFocus: Boolean): Unit

Called when the window containing the view that started this action mode gains or loses focus.

setCustomView

abstract fun setCustomView(view: View!): Unit

Set a custom view for this action mode. The custom view will take the place of the title and subtitle. Useful for things like search boxes.

setSubtitle

abstract fun setSubtitle(subtitle: CharSequence!): Unit

Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.

setSubtitle

abstract fun setSubtitle(resId: Int): Unit

Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.

setTag

open fun setTag(tag: Any!): Unit

Set a tag object associated with this ActionMode.

Like the tag available to views, this allows applications to associate arbitrary data with an ActionMode for later reference.

setTitle

abstract fun setTitle(title: CharSequence!): Unit

Set the title of the action mode. This method will have no visible effect if a custom view has been set.

setTitle

abstract fun setTitle(resId: Int): Unit

Set the title of the action mode. This method will have no visible effect if a custom view has been set.

setTitleOptionalHint

open fun setTitleOptionalHint(titleOptional: Boolean): Unit

Set whether or not the title/subtitle display for this action mode is optional.

In many cases the supplied title for an action mode is merely meant to add context and is not strictly required for the action mode to be useful. If the title is optional, the system may choose to hide the title entirely rather than truncate it due to a lack of available space.

Note that this is merely a hint; the underlying implementation may choose to ignore this setting under some circumstances.

setType

open fun setType(type: Int): Unit

Set a type for this action mode. This will affect how the system renders the action mode if it has to.