| java.lang.Object | |
| ↳ | android.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.
For information about how to provide contextual actions with ActionMode,
read the Menus
developer guide.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ActionMode.Callback | Callback interface for action modes. | ||||||||||
| ActionMode.Callback2 |
Extension of ActionMode.Callback to provide content rect information.
|
||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | DEFAULT_HIDE_DURATION |
Default value to hide the action mode for
getDefaultActionModeHideDuration().
|
|||||||||
| int | TYPE_FLOATING | The action mode is treated as a Floating Toolbar. | |||||||||
| int | TYPE_PRIMARY | The action mode is treated as a Primary mode. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Finish and close this action mode.
| |||||||||||
Returns the current custom view for this action mode.
| |||||||||||
Returns the menu of actions that this action mode presents.
| |||||||||||
Returns a
MenuInflater with the ActionMode's context.
| |||||||||||
Returns the current subtitle of this action mode.
| |||||||||||
Retrieve the tag object associated with this ActionMode.
| |||||||||||
Returns the current title of this action mode.
| |||||||||||
Returns the type for this action mode.
| |||||||||||
Hide the action mode view from obstructing the content below for a short duration.
| |||||||||||
Invalidate the action mode and refresh menu content.
| |||||||||||
Invalidate the content rect associated to this ActionMode.
| |||||||||||
Called when the window containing the view that started this action mode gains or loses
focus.
| |||||||||||
Set a custom view for this action mode.
| |||||||||||
Set the subtitle of the action mode.
| |||||||||||
Set the subtitle of the action mode.
| |||||||||||
Set a tag object associated with this ActionMode.
| |||||||||||
Set the title of the action mode.
| |||||||||||
Set the title of the action mode.
| |||||||||||
Set whether or not the title/subtitle display for this action mode
is optional.
| |||||||||||
Set a type for this action mode.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Default value to hide the action mode for
getDefaultActionModeHideDuration().
The action mode is treated as a Floating Toolbar.
Use with setType(int).
The action mode is treated as a Primary mode. This is the default.
Use with setType(int).
Finish and close this action mode. The action mode's ActionMode.Callback will
have its onDestroyActionMode(ActionMode) method called.
Returns the current custom view for this action mode.
Returns the menu of actions that this action mode presents.
Returns a MenuInflater with the ActionMode's context.
Returns the current subtitle of this action mode.
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 the current title of this action mode.
Returns the type for this action mode.
Developers
TYPE_PRIMARY or TYPE_FLOATING.
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.
| duration | The number of milliseconds to hide for. |
|---|
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.
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.
Called when the window containing the view that started this action mode gains or loses focus.
| hasWindowFocus | True if the window containing the view that started this action mode now has focus, false otherwise. |
|---|
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.
| view | Custom view to use in place of the title/subtitle. |
|---|
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.
| resId | Resource ID of a string to set as the subtitle |
|---|
Set the subtitle of the action mode. This method will have no visible effect if a custom view has been set.
| subtitle | Subtitle string to set |
|---|
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.
| tag | Tag to associate with this ActionMode |
|---|
Set the title of the action mode. This method will have no visible effect if a custom view has been set.
| title | Title string to set |
|---|
Set the title of the action mode. This method will have no visible effect if a custom view has been set.
| resId | Resource ID of a string to set as the title |
|---|
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.
| titleOptional | true if the title only presents optional information. |
|---|
Set a type for this action mode. This will affect how the system renders the action mode if it has to.
| type | One of TYPE_PRIMARY or TYPE_FLOATING.
|
|---|