public
class
ShareActionProvider
extends ActionProvider
| java.lang.Object | ||
| ↳ | android.view.ActionProvider | |
| ↳ | android.widget.ShareActionProvider | |
This is a provider for a share action. It is responsible for creating views that enable data sharing and also to show a sub menu with sharing activities if the hosting item is placed on the overflow menu.
Here is how to use the action provider with custom backing file in a MenuItem:
Developers
// In Activity#onCreateOptionsMenu
public boolean onCreateOptionsMenu(Menu menu) {
// Get the menu item.
MenuItem menuItem = menu.findItem(R.id.my_menu_item);
// Get the provider and hold onto it to set/change the share intent.
mShareActionProvider = (ShareActionProvider) menuItem.getActionProvider();
// Set history different from the default before getting the action
// view since a call to MenuItem.getActionView() calls
// onCreateActionView() which uses the backing file name. Omit this
// line if using the default share history file is desired.
mShareActionProvider.setShareHistoryFileName("custom_share_history.xml");
. . .
}
// Somewhere in the application.
public void doShare(Intent shareIntent) {
// When you want to share set the share intent.
mShareActionProvider.setShareIntent(shareIntent);
}
Note: While the sample snippet demonstrates how to use this provider in the context of a menu item, the use of the provider is not limited to menu items.
See also:
Nested classes | |
|---|---|
interface |
ShareActionProvider.OnShareTargetSelectedListener
Listener for the event of selecting a share target. |
Constants | |
|---|---|
String |
DEFAULT_SHARE_HISTORY_FILE_NAME
The default name for storing share history. |
Public constructors | |
|---|---|
ShareActionProvider(Context context)
Creates a new instance. |
|
Public methods | |
|---|---|
boolean
|
hasSubMenu()
Determines if this ActionProvider has a submenu associated with it. |
View
|
onCreateActionView()
This method is deprecated.
use |
void
|
onPrepareSubMenu(SubMenu subMenu)
Called to prepare an associated submenu for the menu item backed by this ActionProvider. |
void
|
setOnShareTargetSelectedListener(ShareActionProvider.OnShareTargetSelectedListener listener)
Sets a listener to be notified when a share target has been selected. |
void
|
setShareHistoryFileName(String shareHistoryFile)
Sets the file name of a file for persisting the share history which history will be used for ordering share targets. |
void
|
setShareIntent(Intent shareIntent)
Sets an intent with information about the share action. |
Inherited methods | |
|---|---|
 From
class
android.view.ActionProvider
| |
From
class
java.lang.Object
| |
String DEFAULT_SHARE_HISTORY_FILE_NAME
The default name for storing share history.
Constant Value: "share_history.xml"
ShareActionProvider (Context context)
Creates a new instance.
| Parameters | |
|---|---|
context |
Context:
Context for accessing resources.
|
boolean hasSubMenu ()
Determines if this ActionProvider has a submenu associated with it.
Associated submenus will be shown when an action view is not. This
provider instance will receive a call to onPrepareSubMenu(SubMenu)
after the call to onPerformDefaultAction() and before a submenu is
displayed to the user.
| Returns | |
|---|---|
boolean |
true if the item backed by this provider should have an associated submenu |
View onCreateActionView ()
This method is deprecated.
use onCreateActionView(MenuItem)
Factory method called by the Android framework to create new action views.
This method has been deprecated in favor of onCreateActionView(MenuItem).
Newer apps that wish to support platform versions prior to API 16 should also
implement this method to return a valid action view.
| Returns | |
|---|---|
View |
A new action view. |
void onPrepareSubMenu (SubMenu subMenu)
Called to prepare an associated submenu for the menu item backed by this ActionProvider.
if hasSubMenu() returns true, this method will be called when the
menu item is selected to prepare the submenu for presentation to the user. Apps
may use this to create or alter submenu content right before display.
| Parameters | |
|---|---|
subMenu |
SubMenu:
Submenu that will be displayed
|
void setOnShareTargetSelectedListener (ShareActionProvider.OnShareTargetSelectedListener listener)
Sets a listener to be notified when a share target has been selected. The listener can optionally decide to handle the selection and not rely on the default behavior which is to launch the activity.
Note: If you choose the backing share history file you will still be notified in this callback.
| Parameters | |
|---|---|
listener |
ShareActionProvider.OnShareTargetSelectedListener:
The listener.
|
void setShareHistoryFileName (String shareHistoryFile)
Sets the file name of a file for persisting the share history which
history will be used for ordering share targets. This file will be used
for all view created by onCreateActionView(). Defaults to
DEFAULT_SHARE_HISTORY_FILE_NAME. Set to null
if share history should not be persisted between sessions.
Note: The history file name can be set any time, however
only the action views created by onCreateActionView() after setting
the file name will be backed by the provided file. Therefore, if you want to
use different history files for sharing specific types of content, every time
you change the history file setShareHistoryFileName(String) you must
call invalidateOptionsMenu() to recreate the
action view. You should not call
invalidateOptionsMenu() from
onCreateOptionsMenu(Menu).
private void doShare(Intent intent) {
if (IMAGE.equals(intent.getMimeType())) {
mShareActionProvider.setHistoryFileName(SHARE_IMAGE_HISTORY_FILE_NAME);
} else if (TEXT.equals(intent.getMimeType())) {
mShareActionProvider.setHistoryFileName(SHARE_TEXT_HISTORY_FILE_NAME);
}
mShareActionProvider.setIntent(intent);
invalidateOptionsMenu();
}
| Parameters | |
|---|---|
shareHistoryFile |
String:
The share history file name.
|
void setShareIntent (Intent shareIntent)
Sets an intent with information about the share action. Here is a sample for constructing a share intent:
Intent shareIntent = new Intent(Intent.ACTION_SEND);
shareIntent.setType("image/*");
Uri uri = Uri.fromFile(new File(getFilesDir(), "foo.jpg"));
shareIntent.putExtra(Intent.EXTRA_STREAM, uri));
| Parameters | |
|---|---|
shareIntent |
Intent:
The share intent. |
See also: