belongs to Maven artifact com.android.support:appcompat-v7:28.0.0-alpha1
ActionMode
public
abstract
class
ActionMode
extends Object
| java.lang.Object | |
| ↳ | android.support.v7.view.ActionMode |
Represents a contextual mode of the user interface. Action modes can be used to provide alternative interaction modes and replace parts of the normal UI until finished. Examples of good action modes include text selection and contextual actions.
Developer Guides
For information about how to provide contextual actions with ActionMode,
read the Menus
developer guide.
Summary
Nested classes | |
|---|---|
interface |
ActionMode.Callback
Callback interface for action modes. |
Public constructors | |
|---|---|
ActionMode()
|
|
Public methods | |
|---|---|
abstract
void
|
finish()
Finish and close this action mode. |
abstract
View
|
getCustomView()
Returns the current custom view for this action mode. |
abstract
Menu
|
getMenu()
Returns the menu of actions that this action mode presents. |
abstract
MenuInflater
|
getMenuInflater()
Returns a |
abstract
CharSequence
|
getSubtitle()
Returns the current subtitle of this action mode. |
Object
|
getTag()
Retrieve the tag object associated with this ActionMode. |
abstract
CharSequence
|
getTitle()
Returns the current title of this action mode. |
boolean
|
getTitleOptionalHint()
|
abstract
void
|
invalidate()
Invalidate the action mode and refresh menu content. |
boolean
|
isTitleOptional()
|
abstract
void
|
setCustomView(View view)
Set a custom view for this action mode. |
abstract
void
|
setSubtitle(CharSequence subtitle)
Set the subtitle of the action mode. |
abstract
void
|
setSubtitle(int resId)
Set the subtitle of the action mode. |
void
|
setTag(Object tag)
Set a tag object associated with this ActionMode. |
abstract
void
|
setTitle(CharSequence title)
Set the title of the action mode. |
abstract
void
|
setTitle(int resId)
Set the title of the action mode. |
void
|
setTitleOptionalHint(boolean titleOptional)
Set whether or not the title/subtitle display for this action mode is optional. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
Public constructors
Public methods
finish
void finish ()
Finish and close this action mode. The action mode's ActionMode.Callback will
have its onDestroyActionMode(ActionMode) method called.
getCustomView
View getCustomView ()
Returns the current custom view for this action mode.
| Returns | |
|---|---|
View |
The current custom view |
getMenu
Menu getMenu ()
Returns the menu of actions that this action mode presents.
| Returns | |
|---|---|
Menu |
The action mode's menu. |
getMenuInflater
MenuInflater getMenuInflater ()
Returns a MenuInflater with the ActionMode's context.
| Returns | |
|---|---|
MenuInflater |
|
getSubtitle
CharSequence getSubtitle ()
Returns the current subtitle of this action mode.
| Returns | |
|---|---|
CharSequence |
Subtitle text |
getTag
Object getTag ()
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.
| Returns | |
|---|---|
Object |
Tag associated with this ActionMode |
See also:
getTitle
CharSequence getTitle ()
Returns the current title of this action mode.
| Returns | |
|---|---|
CharSequence |
Title text |
getTitleOptionalHint
boolean getTitleOptionalHint ()
| Returns | |
|---|---|
boolean |
true if this action mode has been given a hint to consider the title/subtitle display to be optional. |
invalidate
void invalidate ()
Invalidate the action mode and refresh menu content. The mode's
ActionMode.Callback will have its
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.
isTitleOptional
boolean isTitleOptional ()
| Returns | |
|---|---|
boolean |
true if this action mode considers the title and subtitle fields as optional. Optional titles may not be displayed to the user. |
setCustomView
void setCustomView (View view)
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.
| Parameters | |
|---|---|
view |
View: Custom view to use in place of the title/subtitle. |
setSubtitle
void setSubtitle (CharSequence subtitle)
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.
| Parameters | |
|---|---|
subtitle |
CharSequence: Subtitle string to set |
See also:
setSubtitle
void setSubtitle (int resId)
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.
| Parameters | |
|---|---|
resId |
int: Resource ID of a string to set as the subtitle |
setTag
void setTag (Object tag)
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.
| Parameters | |
|---|---|
tag |
Object: Tag to associate with this ActionMode |
See also:
setTitle
void setTitle (CharSequence title)
Set the title of the action mode. This method will have no visible effect if a custom view has been set.
| Parameters | |
|---|---|
title |
CharSequence: Title string to set |
See also:
setTitle
void setTitle (int resId)
Set the title of the action mode. This method will have no visible effect if a custom view has been set.
| Parameters | |
|---|---|
resId |
int: Resource ID of a string to set as the title |
setTitleOptionalHint
void setTitleOptionalHint (boolean titleOptional)
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.
| Parameters | |
|---|---|
titleOptional |
boolean: true if the title only presents optional information.
|
Interfaces
Classes
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2020-11-09 UTC.