public class ShareActionProvider extends ActionProvider
Here is how to use the action provider with custom backing file in a MenuItem
:
// 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 toMenuItem.getActionView()
calls //ActionProvider.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.
ActionProvider
Modifier and Type | Class and Description |
---|---|
static interface |
ShareActionProvider.OnShareTargetSelectedListener
Listener for the event of selecting a share target.
|
ActionProvider.SubUiVisibilityListener, ActionProvider.VisibilityListener
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SHARE_HISTORY_FILE_NAME
The default name for storing share history.
|
Constructor and Description |
---|
ShareActionProvider(Context context)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
hasSubMenu()
Determines if this ActionProvider has a submenu associated with it.
|
View |
onCreateActionView()
Factory method called by the Android framework to create new action views.
|
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.
|
isVisible, onCreateActionView, onPerformDefaultAction, overridesItemVisibility, refreshVisibility, reset, setSubUiVisibilityListener, setVisibilityListener, subUiVisibilityChanged
public static final String DEFAULT_SHARE_HISTORY_FILE_NAME
public ShareActionProvider(Context context)
context
- Context for accessing resources.public void setOnShareTargetSelectedListener(ShareActionProvider.OnShareTargetSelectedListener listener)
Note: If you choose the backing share history file you will still be notified in this callback.
listener
- The listener.public View onCreateActionView()
This method has been deprecated in favor of ActionProvider.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.
onCreateActionView
in class ActionProvider
public boolean hasSubMenu()
Associated submenus will be shown when an action view is not. This
provider instance will receive a call to ActionProvider.onPrepareSubMenu(SubMenu)
after the call to ActionProvider.onPerformDefaultAction()
and before a submenu is
displayed to the user.
hasSubMenu
in class ActionProvider
public void onPrepareSubMenu(SubMenu subMenu)
if ActionProvider.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.
onPrepareSubMenu
in class ActionProvider
subMenu
- Submenu that will be displayedpublic void setShareHistoryFileName(String shareHistoryFile)
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 Activity.invalidateOptionsMenu()
to recreate the
action view. You should not call
Activity.invalidateOptionsMenu()
from
Activity.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(); }
shareHistoryFile
- The share history file name.public void setShareIntent(Intent shareIntent)
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));
shareIntent
- The share intent.Intent.ACTION_SEND
,
Intent.ACTION_SEND_MULTIPLE