From 7d6d7d960a9dc94ee635bd8235f3ca7cbe8eed3e Mon Sep 17 00:00:00 2001
From: Andrew Solovay Your fragments can contribute menu items to the activity's Options Menu (and, consequently, the Action Bar) by implementing
+href="{@docRoot}training/appbar/index.html">app bar) by implementing
{@link android.app.Fragment#onCreateOptionsMenu(Menu,MenuInflater) onCreateOptionsMenu()}. In order
for this method to receive calls, however, you must call {@link
android.app.Fragment#setHasOptionsMenu(boolean) setHasOptionsMenu()} during {@link
@@ -634,8 +634,8 @@ handle the selected item, then the event is passed to the fragment's callback. T
the Options Menu and context menus. For more information about menus, see the Menus and Action Bar developer guides.Adding items to the Action Bar
+Adding items to the App Bar
For more information about the action bar, see the Action Bar developer guide.
+For more information about the app bar, see the Adding the App Bar training class.
This attribute was added in API level 14.
diff --git a/docs/html/guide/topics/manifest/application-element.jd b/docs/html/guide/topics/manifest/application-element.jd index e63ba712fd2dc..e2b8ec7b207e9 100644 --- a/docs/html/guide/topics/manifest/application-element.jd +++ b/docs/html/guide/topics/manifest/application-element.jd @@ -434,16 +434,17 @@ href="{@docRoot}guide/topics/ui/themes.html">Styles and Themes developer guiFor more information about the action bar, see the Action Bar developer guide.
+For more information about the app bar, see the Adding the App Bar training class.
This attribute was added in API level 14.
diff --git a/docs/html/guide/topics/resources/menu-resource.jd b/docs/html/guide/topics/resources/menu-resource.jd index af56a6c5cabe6..53ff27615a3e7 100644 --- a/docs/html/guide/topics/resources/menu-resource.jd +++ b/docs/html/guide/topics/resources/menu-resource.jd @@ -117,47 +117,47 @@ functionality.Introduced in API Level 11.
android:showAsAction| Value | Description |
|---|---|
ifRoom | Only place this item in the
- Action Bar if there is room for it. If there is not room for all
+ app bar if there is room for it. If there is not room for all
the items marked "ifRoom", the items with the lowest
orderInCategory values are displayed as actions, and
the remaining items are displayed in the overflow menu. |
withText | Also include the title text (defined by {@code android:title}) with the action item. You can include this value along with one of the others as a flag set, by separating them with a pipe {@code |}. |
never | Never place this item in the Action Bar. Instead, list the item in the Action Bar's overflow + |
never | Never place this item in the app bar. Instead, list the item in the app bar's overflow menu. |
always | Always place this item in the Action Bar. + |
always | Always place this item in the app bar. Avoid using this unless it's critical that the item always appear in the action bar. Setting multiple items to always appear as action items can result in them overlapping -with other UI in the action bar. |
collapseActionView | The action view associated
with this action item (as declared by android:actionLayout or
android:actionViewClass) is
collapsible.Introduced in API Level 14. |
See the Action Bar developer -guide for more information.
+See the Adding the App Bar + training class for more information.
Introduced in API Level 11.
android:actionLayoutSee the Action Bar developer -guide for more information.
+See Action + Views and Action Providers for more information.
Introduced in API Level 11.
android:actionViewClassSee the Action Bar developer -guide for more information.
+See Action + Views and Action Providers for more information.
Warning: If you obfuscate your code using ProGuard (or a similar tool), be sure to exclude the class you specify in this attribute from renaming, because it can break the @@ -168,8 +168,8 @@ functionality.
See the Action Bar developer -guide for more information.
+See Action + Views and Action Providers for more information.
Warning: If you obfuscate your code using ProGuard (or a similar tool), be sure to exclude the class you specify in this attribute from renaming, because it can break the diff --git a/docs/html/guide/topics/search/search-dialog.jd b/docs/html/guide/topics/search/search-dialog.jd index fcaaed36da03b..1cf82493a74da 100644 --- a/docs/html/guide/topics/search/search-dialog.jd +++ b/docs/html/guide/topics/search/search-dialog.jd @@ -134,8 +134,7 @@ data, and displays the search results.
Using the search widget allows you to put the search box anywhere in your activity. Instead of putting it in your activity layout, you should usually use -{@link android.widget.SearchView} as an -action view in the Action Bar.
+{@link android.widget.SearchView} as an action view in the app bar.Note: If your app uses the action bar, then you should not use +
Note: If your app uses an app bar, then you should not use the search dialog for your search interface. Instead, use the search -widget as a collapsible view in the action bar.
+widget as a collapsible view in the app bar.You can also enable "type-to-search" functionality, which activates the search dialog when the user starts typing on the keyboard—the keystrokes are inserted into the search dialog. You can @@ -680,10 +679,9 @@ android.widget.SearchView} widget as an "action view" in the Action Bar.
The {@link android.widget.SearchView} widget is available in Android 3.0 and higher. If you're developing your application for Android 3.0 and have decided to use the search widget, we -recommend that you insert the search widget as an action view in the Action Bar, +recommend that you insert the search widget as an action view in the app bar, instead of using the search dialog (and instead of placing the search widget in your activity -layout). For example, figure 2 shows the search widget in the Action Bar.
+layout). For example, figure 2 shows the search widget in the app bar.The search widget provides the same functionality as the search dialog. It starts the appropriate activity when the user executes a search, and it can provide search suggestions and perform voice @@ -707,8 +705,8 @@ android.app.SearchableInfo} object that represents your searchable configuration android.app.SearchManager#getSearchableInfo getSearchableInfo()} on {@link android.app.SearchManager}.
-For example, if you're using a {@link android.widget.SearchView} as an action view in the Action Bar, you should enable the widget +
For example, if you're using a {@link android.widget.SearchView} as an action view in the +app bar, you should enable the widget during the {@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} callback:
@@ -738,9 +736,8 @@ with some callback methods and event listeners. For more information, see the re
documentation for {@link android.widget.SearchView} and its nested interfaces for the
appropriate event listeners.
-For more information about action views in the Action Bar, read the Action Bar developer guide (which
-includes sample code for adding a search widget as an action view).
+For more information about action views in the Action Bar, see
+Action Views and Action Providers.
Other search widget features
diff --git a/docs/html/guide/topics/ui/actionbar.jd b/docs/html/guide/topics/ui/actionbar.jd
deleted file mode 100644
index b2f98ada5adc5..0000000000000
--- a/docs/html/guide/topics/ui/actionbar.jd
+++ /dev/null
@@ -1,1501 +0,0 @@
-page.title=Action Bar
-page.tags=actionbar,menu,tabs
-
-@jd:body
-
-
-
-
- Design Guide
- Action Bar
-
-
-
-
-
-
- In this document
-
- - Adding the Action Bar
-
-
- - Adding Action Items
-
-
- - Navigating Up with the App Icon
- - Adding an Action View
-
-
- - Adding an Action Provider
-
-
- - Adding Navigation Tabs
- - Adding Drop-down Navigation
- - Styling the Action Bar
-
-
-
-
- Key classes
-
- - {@link android.support.v7.app.ActionBar}
- - {@link android.view.Menu}
-
-
-
-
-
-The action bar is a window feature that identifies the user location, and
-provides user actions and navigation modes. Using the action bar offers your users a
-familiar interface across applications that the system gracefully adapts
-for different screen configurations.
-
-
-Figure 1. An action bar that includes the [1] app icon,
-[2] two action items, and [3] action overflow.
-
-The action bar provides several key functions:
-
-For more information about the action bar's interaction patterns and design guidelines, -see the Action Bar -design guide.
- -The {@link android.app.ActionBar} APIs were first added in Android 3.0 (API level 11) but they -are also available in the Support Library -for compatibility with Android 2.1 (API level 7) and above.
- -This guide focuses on how to use the -support library's action bar, but if your app supports only Android 3.0 or higher, you -should use the {@link android.app.ActionBar} APIs in the framework. Most of the APIs are -the same—but reside in a different package namespace—with a few exceptions to method -names or signatures that are noted in the sections below.
- - -Caution: Be certain you import -the {@code ActionBar} class (and related APIs) from the appropriate package:
-Note: If you're looking for information about the contextual -action bar for displaying contextual action items, see the Menu guide.
- - - -As mentioned above, this guide focuses on how to use the {@link -android.support.v7.app.ActionBar} APIs in the support library. So before you can add the action -bar, you must set up your project with the appcompat v7 support library by -following the instructions in the Support -Library Setup.
- -Once your project is set up with the support library, here's how to add the action bar:
-<activity android:theme="@style/Theme.AppCompat.Light" ... >-
Now your activity includes the action bar when running on Android 2.1 (API level 7) or higher. -
- -On API level 11 or higher
-The action bar is included in all activities that use the -{@link android.R.style#Theme_Holo Theme.Holo} theme (or one of its -descendants), which is the default theme when either the {@code targetSdkVersion} or -{@code minSdkVersion} -attribute is set to {@code "11"} or higher. If you don't want the action bar for an -activity, set the activity theme to {@link android.R.style#Theme_Holo_NoActionBar -Theme.Holo.NoActionBar}.
-You can hide the action bar at runtime by calling {@link android.support.v7.app.ActionBar#hide}. -For example:
- -
-ActionBar actionBar = {@link android.support.v7.app.ActionBarActivity#getSupportActionBar()};
-actionBar.hide();
-
-
-On API level 11 or higher
-Get the {@link android.app.ActionBar} with the {@link android.app.Activity#getActionBar} -method.
-When the action bar hides, the system adjusts your layout to fill the -screen space now available. You can bring the action bar back by calling {@link -android.support.v7.app.ActionBar#show()}.
- -Beware that hiding and removing the action bar causes your activity to re-layout in order to -account for the space consumed by the action bar. If your activity often hides and shows the -action bar, you might want to enable overlay mode. Overlay mode -draws the action bar in front of your activity layout, obscuring the top portion. This -way, your layout remains fixed when the action bar hides and re-appears. To enable overlay mode, -create a custom theme for your activity and set {@link -android.support.v7.appcompat.R.attr#windowActionBarOverlay -windowActionBarOverlay} to {@code true}. For more information, see the section below about Styling the Action Bar.
- - -By default, the system uses your application icon in the action bar, as specified by the {@code icon} -attribute in the {@code -<application>} or {@code -<activity>} element. However, if you also specify the {@code logo} -attribute, then the action bar uses the logo image instead of the icon.
- -A logo should usually be wider than the icon, but should not include unnecessary text. You -should generally use a logo only when it represents your brand in a traditional format that users -recognize. A good example is the YouTube app's logo—the logo represents the expected user -brand, whereas the app's icon is a modified version that conforms to the square requirement -for the launcher icon.
- - - - -
- Figure 2. Action bar with three action buttons and -the overflow button.
-The action bar provides users access to the most important action -items relating to the app's current -context. Those that appear directly in the action bar with an icon and/or text are known -as action buttons. Actions that can't fit in the action bar or aren't -important enough are hidden in the action overflow. -The user can reveal a list of the other actions by pressing the overflow button -on the right side (or the device Menu button, if available).
- -When your activity starts, the system populates the action items by calling your activity's -{@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} method. Use this -method to inflate a menu resource that defines all the -action items. For example, here's a menu resource defining a couple of menu items:
- -res/menu/main_activity_actions.xml
--<menu xmlns:android="http://schemas.android.com/apk/res/android" > - <item android:id="@+id/action_search" - android:icon="@drawable/ic_action_search" - android:title="@string/action_search"/> - <item android:id="@+id/action_compose" - android:icon="@drawable/ic_action_compose" - android:title="@string/action_compose" /> -</menu> -- -
Then in your activity's {@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} -method, inflate the menu resource into the given {@link android.view.Menu} -to add each item to the action bar:
- -
-@Override
-public boolean onCreateOptionsMenu(Menu menu) {
- // Inflate the menu items for use in the action bar
- MenuInflater inflater = getMenuInflater();
- inflater.inflate(R.menu.main_activity_actions, menu);
- return super.onCreateOptionsMenu(menu);
-}
-
-
-To request that an item appear directly in the action bar -as an action button, include {@code -showAsAction="ifRoom"} in the {@code <item>} tag. For example:
- --<menu xmlns:android="http://schemas.android.com/apk/res/android" - xmlns:yourapp="http://schemas.android.com/apk/res-auto" > - <item android:id="@+id/action_search" - android:icon="@drawable/ic_action_search" - android:title="@string/action_search" - yourapp:showAsAction="ifRoom" /> - ... -</menu> -- -
If there's not enough room for the item in the action bar, it will appear in the action -overflow.
- - -Using XML attributes from the support library
-Notice that the {@code showAsAction} attribute above uses a custom namespace defined in the -{@code <menu>} tag. This is necessary when using any XML attributes defined by the support -library, because these attributes do not exist in the Android framework on older devices. -So you must use your own namespace as a prefix for all attributes defined by the support library. - -If your menu item supplies both a title and an icon—with the {@code title} and -{@code icon} attributes—then the action item shows only the icon by default. If you -want to display the text title, add {@code "withText"} to the {@code showAsAction} -attribute. For example:
- --<item yourapp:showAsAction="ifRoom|withText" ... /> -- -
Note: The {@code "withText"} value is a hint to the -action bar that the text title should appear. The action bar will show the title when possible, but -might not if an icon is available and the action bar is constrained for space.
- -You should always define the {@code title} for each item even if you don't declare that -the title appear with the action item, for the following reasons:
-The {@code icon} is optional, but recommended. For icon design recommendations, -see the Iconography design -guide. You can also download a set of standard action bar icons (such as for Search or Discard) -from the Downloads page.
- -You can also use {@code "always"} to declare that an item always appear as an action button. -However, you should not force an item to appear in the action bar this -way. Doing so can create layout problems on devices with a narrow screen. It's best to instead -use {@code "ifRoom"} to request that an item appear in the action bar, but allow the system to move -it into the overflow when there's not enough room. However, it might be necessary to use this value -if the item includes an action view that cannot be collapsed and -must always be visible to provide access to a critical feature.
- - - - -When the user presses an action, the system calls your activity's {@link -android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()} method. Using the -{@link android.view.MenuItem} passed to this method, you can identify the action by calling {@link -android.view.MenuItem#getItemId()}. This returns the unique ID provided by the {@code <item>} -tag's {@code id} attribute so you can perform the appropriate action. For example:
- -
-@Override
-public boolean onOptionsItemSelected(MenuItem item) {
- // Handle presses on the action bar items
- switch (item.getItemId()) {
- case R.id.action_search:
- openSearch();
- return true;
- case R.id.action_compose:
- composeMessage();
- return true;
- default:
- return super.onOptionsItemSelected(item);
- }
-}
-
-
-Note: If you inflate menu items from a fragment, via the {@link -android.app.Fragment} class's {@link android.app.Fragment#onCreateOptionsMenu onCreateOptionsMenu()} -callback, the system calls {@link -android.app.Fragment#onOptionsItemSelected(MenuItem) onOptionsItemSelected()} for that -fragment when the user selects one of those items. However, the activity gets a chance to -handle the event first, so the system first calls {@link -android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()} on the activity, -before calling the same callback for the fragment. To ensure that any fragments in the -activity also have a chance to handle the callback, always pass the call to the superclass -as the default behavior instead of returning {@code false} when you do not handle the item.
- - - -
-Figure 3. Mock-ups showing an action bar with -tabs (left), then with split action bar (middle); and with the app icon and title disabled -(right).
- -Split action bar provides a separate -bar at the bottom of the screen to display all action items when the activity is running on -a narrow screen (such as a portrait-oriented handset).
- -Separating the action items this way -ensures that a reasonable amount of space is available to display all your action -items on a narrow screen, while leaving room for navigation and title elements at the top.
- -To enable split action bar when using the support library, you must do two things:
-For example:
- --<manifest ...> - <activity uiOptions="splitActionBarWhenNarrow" ... > - <meta-data android:name="android.support.UI_OPTIONS" - android:value="splitActionBarWhenNarrow" /> - </activity> -</manifest> -- - -
Using split action bar also allows navigation tabs to collapse into the -main action bar if you remove the icon and title (as shown on the right in figure 3). -To create this effect, disable the action bar -icon and title with {@link android.support.v7.app.ActionBar#setDisplayShowHomeEnabled -setDisplayShowHomeEnabled(false)} and {@link -android.support.v7.app.ActionBar#setDisplayShowTitleEnabled setDisplayShowTitleEnabled(false)}.
- - - -Navigation with Back and Up
-
- Figure 4. The Up button in Gmail.
-Enabling the app icon as an Up button allows the user to navigate your app based -on the hierarchical relationships between screens. For instance, if screen A displays a list of -items, and selecting an item leads to screen B, then -screen B should include the Up button, which returns to screen A.
- -Note: Up navigation is distinct from the back navigation provided -by the system Back button. The Back button is used to navigate in reverse -chronological order through the history of screens the user has recently worked with. It is -generally based on the temporal relationships between screens, rather than the app's hierarchy -structure (which is the basis for up navigation).
- -To enable the app icon as an Up button, call {@link -android.support.v7.app.ActionBar#setDisplayHomeAsUpEnabled setDisplayHomeAsUpEnabled()}. -For example:
- -
-@Override
-protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.activity_details);
-
- ActionBar actionBar = getSupportActionBar();
- actionBar.setDisplayHomeAsUpEnabled(true);
- ...
-}
-
-
-Now the icon in the action bar appears with the Up caret (as shown in figure 4). -However, it won't do anything by default. To specify the activity to open when the -user presses Up button, you have two options:
- -This is the best option when the parent activity is always the same. By -declaring in the manifest which activity is the parent, the action bar automatically performs the -correct action when the user presses the Up button.
- -Beginning in Android 4.1 (API level 16), you can declare the parent with the {@code parentActivityName} -attribute in the {@code -<activity>} element.
-To support older devices with the support library, also -include a {@code -<meta-data>} element that specifies -the parent activity as the value for {@code android.support.PARENT_ACTIVITY}. For example:
--<application ... > - ... - <!-- The main/home activity (has no parent activity) --> - <activity - android:name="com.example.myfirstapp.MainActivity" ...> - ... - </activity> - <!-- A child of the main activity --> - <activity - android:name="com.example.myfirstapp.DisplayMessageActivity" - android:label="@string/title_activity_display_message" - android:parentActivityName="com.example.myfirstapp.MainActivity" > - <!-- Parent activity meta-data to support API level 7+ --> - <meta-data - android:name="android.support.PARENT_ACTIVITY" - android:value="com.example.myfirstapp.MainActivity" /> - </activity> -</application> -- -
Once the parent activity is specified in the manifest like this and you enable the Up - button with {@link -android.support.v7.app.ActionBar#setDisplayHomeAsUpEnabled setDisplayHomeAsUpEnabled()}, your work -is done and the action bar properly navigates up.
-This is appropriate when the parent activity may be different depending - on how the user arrived at the current screen. That is, if there are many paths that the user - could have taken to reach the current screen, the Up button should navigate - backward along the path the user actually followed to get there.
- -The system calls {@link -android.support.v7.app.ActionBarActivity#getSupportParentActivityIntent()} when the user presses -the Up button while navigating your app (within your app's own task). If the activity that -should open upon up navigation differs depending on how the user arrived at the current location, -then you should override this method to return the {@link -android.content.Intent} that starts the appropriate parent activity.
- -The system calls {@link -android.support.v7.app.ActionBarActivity#onCreateSupportNavigateUpTaskStack -onCreateSupportNavigateUpTaskStack()} for your activity when the user presses the Up -button while your activity is running in a task that does not belong to your app. Thus, -you must use the {@link android.support.v4.app.TaskStackBuilder} passed to this method to construct -the appropriate back stack that should be synthesized when the user navigates up.
- -Even if you override {@link -android.support.v7.app.ActionBarActivity#getSupportParentActivityIntent()} to specify up navigation -as the user navigates your app, you can avoid the need to implement {@link -android.support.v7.app.ActionBarActivity#onCreateSupportNavigateUpTaskStack -onCreateSupportNavigateUpTaskStack()} by declaring "default" parent activities in the manifest file -as shown above. Then the default implementation of {@link -android.support.v7.app.ActionBarActivity#onCreateSupportNavigateUpTaskStack -onCreateSupportNavigateUpTaskStack()} will synthesize a back stack based on the parent activities -declared in the manifest.
- - -Note: -If you've built your app hierarchy using a series of fragments instead of multiple -activities, then neither of the above options will work. Instead, to navigate up through your -fragments, override {@link android.support.v7.app.ActionBarActivity#onSupportNavigateUp()} -to perform the appropriate fragment transaction—usually by popping -the current fragment from the back stack by calling {@link -android.support.v4.app.FragmentManager#popBackStack()}.
- -For more information about implementing Up navigation, read -Providing Up Navigation.
- - - -
-Figure 5. An action bar with a collapsible -{@link android.support.v7.widget.SearchView}.
-An action view is a widget that appears in the action bar as a substitute for an action -button. An action view provides fast access to rich actions without changing activities or -fragments, and without replacing the action bar. For example, if you have an action for Search, you -can add an action view to -embeds a {@link android.support.v7.widget.SearchView} widget in the action bar, as shown in figure -5.
- -To declare an action view, use either the {@code -actionLayout} or {@code actionViewClass} attribute to specify either a layout -resource or widget class to use, respectively. For example, here's how to add -the {@link android.support.v7.widget.SearchView} widget:
- --<?xml version="1.0" encoding="utf-8"?> -<menu xmlns:android="http://schemas.android.com/apk/res/android" - xmlns:yourapp="http://schemas.android.com/apk/res-auto" > - <item android:id="@+id/action_search" - android:title="@string/action_search" - android:icon="@drawable/ic_action_search" - yourapp:showAsAction="ifRoom|collapseActionView" - yourapp:actionViewClass="android.support.v7.widget.SearchView" /> -</menu> -- -
Notice that the {@code showAsAction} attribute also includes the {@code "collapseActionView"} -value. This is optional and declares that the action view should be collapsed into a -button. (This behavior is explained further in the following section about -Handling collapsible action views.)
- -If you need to configure the action view (such as to add event listeners), you can do so during -the {@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} callback. You can -acquire the action view object by calling the static method {@link -android.support.v4.view.MenuItemCompat#getActionView MenuItemCompat.getActionView()} and passing it -the corresponding {@link android.view.MenuItem}. For example, the search widget from the above -sample is acquired like this:
- - -
-@Override
-public boolean onCreateOptionsMenu(Menu menu) {
- getMenuInflater().inflate(R.menu.main_activity_actions, menu);
- MenuItem searchItem = menu.findItem(R.id.action_search);
- SearchView searchView = (SearchView) MenuItemCompat.getActionView(searchItem);
- // Configure the search info and add any event listeners
- ...
- return super.onCreateOptionsMenu(menu);
-}
-
-
-On API level 11 or higher
-Get the action view by calling {@link android.view.MenuItem#getActionView} on the -corresponding {@link android.view.MenuItem}:
-menu.findItem(R.id.action_search).getActionView()-
For more information about using the search widget, see Creating a Search Interface.
- - - -To preserve the action bar space, you can collapse your action view into an action button. -When collapsed, the system might place the action -into the action overflow, but the -action view still appears in the action bar when the user selects it. You can make your action -view collapsible by adding {@code "collapseActionView"} to the {@code showAsAction} -attribute, as shown in the XML above.
- -Because the system expands the action view when the user selects the action, you -do not need to respond to the item in the {@link -android.app.Activity#onOptionsItemSelected onOptionsItemSelected()} callback. The system still calls -{@link android.app.Activity#onOptionsItemSelected onOptionsItemSelected()}, but if -you return {@code true} (indicating you've handled the event instead), then the -action view will not expand.
- -The system also collapses your action view when the user presses the Up button -or Back button.
- -If you need to update your activity based on the visibility of your action view, you can receive -callbacks when the action is expanded and collapsed by defining an {@link -android.support.v4.view.MenuItemCompat.OnActionExpandListener OnActionExpandListener} and -passing it to {@link android.support.v4.view.MenuItemCompat#setOnActionExpandListener -setOnActionExpandListener()}. For example:
- - -
-@Override
-public boolean onCreateOptionsMenu(Menu menu) {
- getMenuInflater().inflate(R.menu.options, menu);
- MenuItem menuItem = menu.findItem(R.id.actionItem);
- ...
-
- // When using the support library, the setOnActionExpandListener() method is
- // static and accepts the MenuItem object as an argument
- MenuItemCompat.setOnActionExpandListener(menuItem, new OnActionExpandListener() {
- @Override
- public boolean onMenuItemActionCollapse(MenuItem item) {
- // Do something when collapsed
- return true; // Return true to collapse action view
- }
-
- @Override
- public boolean onMenuItemActionExpand(MenuItem item) {
- // Do something when expanded
- return true; // Return true to expand action view
- }
- });
-}
-
-
-
-
-
-
- Figure 6. An action bar with - {@link android.widget.ShareActionProvider} expanded to show share targets.
-Similar to an action view, an action provider -replaces an action button with a customized layout. However, -unlike an action view, an action provider takes control of all the action's behaviors -and an action provider can display a submenu when pressed.
- -To declare an action provider, supply the {@code actionViewClass} attribute in the -menu {@code <item>} tag with a fully-qualified class name for an -{@link android.support.v4.view.ActionProvider}.
- -You can build your own action provider by extending the {@link -android.support.v4.view.ActionProvider} class, but Android provides some pre-built action providers -such as {@link android.support.v7.widget.ShareActionProvider}, which facilitates a "share" action -by showing a list of possible apps for sharing directly in the action bar (as shown in figure -6).
- -Because each {@link android.support.v4.view.ActionProvider} class defines its own action -behaviors, you don't need to listen for the action in the {@link -android.app.Activity#onOptionsItemSelected onOptionsItemSelected()} method. If necessary though, -you can still listen for the click event in the {@link android.app.Activity#onOptionsItemSelected -onOptionsItemSelected()} method in case you need to simultaneously perform another action. But be -sure to return {@code false} so that the the action provider still receives the {@link -android.support.v4.view.ActionProvider#onPerformDefaultAction()} callback to perform its intended -action.
- - -However, if the action provider provides a submenu of actions, then your -activity does not receive a call to {@link android.app.Activity#onOptionsItemSelected -onOptionsItemSelected()} when the user opens the list or selects one of the submenu items.
- - - -To add a "share" action with {@link android.support.v7.widget.ShareActionProvider}, -define the {@code actionProviderClass} for an {@code <item>} tag with -the {@link android.support.v7.widget.ShareActionProvider} class. For example:
- --<?xml version="1.0" encoding="utf-8"?> -<menu xmlns:android="http://schemas.android.com/apk/res/android" - xmlns:yourapp="http://schemas.android.com/apk/res-auto" > - <item android:id="@+id/action_share" - android:title="@string/share" - yourapp:showAsAction="ifRoom" - yourapp:actionProviderClass="android.support.v7.widget.ShareActionProvider" - /> - ... -</menu> -- -
Now the action provider takes control of the action item and handles both -its appearance and behavior. But you must -still provide a title for the item to be used when it appears in the action overflow.
- -The only thing left to do is define -the {@link android.content.Intent} you want to use for sharing. To do so, edit -your {@link -android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} method to call {@link -android.support.v4.view.MenuItemCompat#getActionProvider MenuItemCompat.getActionProvider()} -and pass it the {@link android.view.MenuItem} holding the action provider. Then call {@link -android.support.v7.widget.ShareActionProvider#setShareIntent setShareIntent()} on the -returned {@link android.support.v7.widget.ShareActionProvider} and pass it an -{@link android.content.Intent#ACTION_SEND} intent with the appropriate content attached.
- -You should call {@link -android.support.v7.widget.ShareActionProvider#setShareIntent setShareIntent()} once during {@link -android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} to initialize the share action, -but because the user context might change, you must update the intent any time the shareable -content changes by again calling {@link -android.support.v7.widget.ShareActionProvider#setShareIntent setShareIntent()}.
- -For example:
- -
-private ShareActionProvider mShareActionProvider;
-
-@Override
-public boolean onCreateOptionsMenu(Menu menu) {
- getMenuInflater().inflate(R.menu.main_activity_actions, menu);
-
- // Set up ShareActionProvider's default share intent
- MenuItem shareItem = menu.findItem(R.id.action_share);
- mShareActionProvider = (ShareActionProvider)
- MenuItemCompat.getActionProvider(shareItem);
- mShareActionProvider.setShareIntent(getDefaultIntent());
-
- return super.onCreateOptionsMenu(menu);
-}
-
-/** Defines a default (dummy) share intent to initialize the action provider.
- * However, as soon as the actual content to be used in the intent
- * is known or changes, you must update the share intent by again calling
- * mShareActionProvider.{@link android.support.v7.widget.ShareActionProvider#setShareIntent setShareIntent()}
- */
-private Intent getDefaultIntent() {
- Intent intent = new Intent(Intent.ACTION_SEND);
- intent.setType("image/*");
- return intent;
-}
-
-
-The {@link android.support.v7.widget.ShareActionProvider} now handles all user interaction with -the item and you do not need to handle click events from the {@link -android.app.Activity#onOptionsItemSelected onOptionsItemSelected()} callback method.
- - -By default, the {@link android.support.v7.widget.ShareActionProvider} retains a ranking for each -share target based on how often the user selects each one. The share targets used more frequently -appear at the top of the drop-down list and the target used most often appears directly in the -action bar as the default share target. By default, the ranking information is saved in a private -file with a name specified by {@link -android.support.v7.widget.ShareActionProvider#DEFAULT_SHARE_HISTORY_FILE_NAME}. If you use the -{@link android.support.v7.widget.ShareActionProvider} or an extension of it for only one type of -action, then you should continue to use this default history file and there's nothing you need to -do. However, if you use {@link android.support.v7.widget.ShareActionProvider} or an extension of it -for multiple actions with semantically different meanings, then each {@link -android.support.v7.widget.ShareActionProvider} should specify its own history file in order to -maintain its own history. To specify a different history file for the {@link -android.support.v7.widget.ShareActionProvider}, call {@link -android.support.v7.widget.ShareActionProvider#setShareHistoryFileName setShareHistoryFileName()} -and provide an XML file name (for example, {@code "custom_share_history.xml"}).
- - -Note: Although the {@link -android.support.v7.widget.ShareActionProvider} ranks share targets based on frequency of use, the -behavior is extensible and extensions of {@link android.support.v7.widget.ShareActionProvider} can -perform different behaviors and ranking based on the history file (if appropriate).
- - - - -Creating your own action provider allows you to re-use and manage dynamic action item -behaviors in a self-contained module, rather than handle action item transformations and -behaviors in your fragment or activity -code. As shown in the previous section, Android already provides an implementation of {@link -android.support.v4.view.ActionProvider} for share actions: the {@link -android.support.v7.widget.ShareActionProvider}.
- -To create your own action provider for a different action, simply extend the -{@link android.support.v4.view.ActionProvider} class and implement -its callback methods as appropriate. Most importantly, you should implement the following:
- -
-public View onCreateActionView(MenuItem forItem) {
- // Inflate the action view to be shown on the action bar.
- LayoutInflater layoutInflater = LayoutInflater.from(mContext);
- View view = layoutInflater.inflate(R.layout.action_provider, null);
- ImageButton button = (ImageButton) view.findViewById(R.id.button);
- button.setOnClickListener(new View.OnClickListener() {
- @Override
- public void onClick(View v) {
- // Do something...
- }
- });
- return view;
-}
-
-However, if your action provider provides a submenu, through the {@link -android.support.v4.view.ActionProvider#onPrepareSubMenu onPrepareSubMenu()} callback, then the -submenu appears even when the action provider is placed in the action overflow. Thus, {@link -android.support.v4.view.ActionProvider#onPerformDefaultAction()} is never called when there is a -submenu.
- -Note: An activity or a fragment that implements {@link
-android.app.Activity#onOptionsItemSelected onOptionsItemSelected()} can override the action
-provider's default behavior (unless it uses a submenu) by handling the item-selected event (and
-returning true), in which case, the system does not call {@link
-android.support.v4.view.ActionProvider#onPerformDefaultAction()}.
For an example extension of {@link android.view.ActionProvider}, see ActionBarSettingsActionProviderActivity.
- - - - -
-Figure 7. Action bar tabs on a wide screen.
- - -Tabs
-Creating Swipe Views with Tabs
-
- Figure 8. Tabs on a narrow screen.
-Tabs in the action bar make it easy for users to explore and switch between different views in -your app. The tabs provided by the {@link android.support.v7.app.ActionBar} are ideal because they -adapt to different screen sizes. For example, when the screen is wide enough the tabs appear in the -action bar alongside the action buttons (such as when on a tablet, shown in figure 7), while when -on a narrow screen they appear in a separate bar (known as the "stacked action bar", shown in -figure 8). In some cases, the Android system will instead show your tab items as a drop-down list -to ensure the best fit in the action bar.
- -To get started, your layout must include a {@link android.view.ViewGroup} in which you place -each {@link android.app.Fragment} associated with a tab. Be sure the {@link android.view.ViewGroup} -has a resource ID so you can reference it from your code and swap the tabs within it. -
- -Once you determine where the fragments appear in the layout, the basic procedure to add tabs -is:
-Notice that the {@link android.support.v7.app.ActionBar.TabListener} -callback methods don't specify which fragment is associated with the tab, but merely which -{@link android.support.v7.app.ActionBar.Tab} was selected. -You must define your own association -between each {@link android.app.ActionBar.Tab} and the appropriate {@link android.app.Fragment} that -it represents. There are several ways you -can define the association, depending on your design.
- -For example, here's how you might implement the {@link android.app.ActionBar.TabListener} -such that each tab uses its own instance of the listener:
-
-public static class TabListener<T extends Fragment> implements ActionBar.TabListener {
- private Fragment mFragment;
- private final Activity mActivity;
- private final String mTag;
- private final Class<T> mClass;
-
- /** Constructor used each time a new tab is created.
- * @param activity The host Activity, used to instantiate the fragment
- * @param tag The identifier tag for the fragment
- * @param clz The fragment's Class, used to instantiate the fragment
- */
- public TabListener(Activity activity, String tag, Class<T> clz) {
- mActivity = activity;
- mTag = tag;
- mClass = clz;
- }
-
- /* The following are each of the {@link android.app.ActionBar.TabListener} callbacks */
-
- public void onTabSelected(Tab tab, FragmentTransaction ft) {
- // Check if the fragment is already initialized
- if (mFragment == null) {
- // If not, instantiate and add it to the activity
- mFragment = Fragment.instantiate(mActivity, mClass.getName());
- ft.add(android.R.id.content, mFragment, mTag);
- } else {
- // If it exists, simply attach it in order to show it
- ft.attach(mFragment);
- }
- }
-
- public void onTabUnselected(Tab tab, FragmentTransaction ft) {
- if (mFragment != null) {
- // Detach the fragment, because another one is being attached
- ft.detach(mFragment);
- }
- }
-
- public void onTabReselected(Tab tab, FragmentTransaction ft) {
- // User selected the already selected tab. Usually do nothing.
- }
-}
-
-
-Caution: You must not call {@link -android.app.FragmentTransaction#commit} for the fragment transaction in each of these -callbacks—the system calls it for you and it may throw an exception if you call it yourself. -You also cannot add these fragment transactions to the back stack.
- -In this example, the listener simply attaches ({@link android.app.FragmentTransaction#attach -attach()}) a fragment to the activity layout—or if not instantiated, creates the fragment and -adds ({@link android.app.FragmentTransaction#add add()}) it to the layout (as a child of the {@code -android.R.id.content} view group)—when the respective tab is selected, and detaches ({@link -android.app.FragmentTransaction#detach detach()}) it when the tab is unselected.
- -All that remains is to create each {@link android.app.ActionBar.Tab} and add it to the {@link -android.app.ActionBar}. Additionally, you must call {@link -android.app.ActionBar#setNavigationMode(int) setNavigationMode(NAVIGATION_MODE_TABS)} to make the -tabs visible.
- -For example, the following code adds two tabs using the listener defined above:
- -
-@Override
-protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- // Notice that setContentView() is not used, because we use the root
- // android.R.id.content as the container for each fragment
-
- // setup action bar for tabs
- ActionBar actionBar = getSupportActionBar();
- actionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_TABS);
- actionBar.setDisplayShowTitleEnabled(false);
-
- Tab tab = actionBar.newTab()
- .setText(R.string.artist)
- .setTabListener(new TabListener<ArtistFragment>(
- this, "artist", ArtistFragment.class));
- actionBar.addTab(tab);
-
- tab = actionBar.newTab()
- .setText(R.string.album)
- .setTabListener(new TabListener<AlbumFragment>(
- this, "album", AlbumFragment.class));
- actionBar.addTab(tab);
-}
-
-
-
-If your activity stops, you should retain the currently selected tab with the saved instance state so you -can open the appropriate tab when the user returns. When it's time to save the state, you can query -the currently selected tab with {@link -android.support.v7.app.ActionBar#getSelectedNavigationIndex()}. This returns the index position of -the selected tab.
- - -Caution: It's important that you save the state of each fragment -so when users switch fragments with the tabs and then return to a previous -fragment, it looks the way it did when they left. Some of the state is saved by default, but you -may need to manually save state for customized views. For information about saving the state of your -fragment, see the Fragments -API guide.
- -Note: The above implementation for {@link -android.support.v7.app.ActionBar.TabListener} is one of several possible techniques. Another popular -option is to use {@link android.support.v4.view.ViewPager} to manage the fragments so users -can also use a swipe gesture to switch tabs. In this case, you simply tell the -{@link android.support.v4.view.ViewPager} the current tab position in the -{@link android.support.v7.app.ActionBar.TabListener#onTabSelected onTabSelected()} callback. -For more information, read -Creating Swipe Views with Tabs.
- - - - - -
- Figure 9. A drop-down navigation list in the -action bar.
-As another mode of navigation (or filtering) for your activity, the action bar offers a built -in drop-down list (also known as a "spinner"). For example, the drop-down list can offer different -modes by which content in the activity is sorted.
- -Using the drop-down list is useful when changing the content is important but not necessarily a -frequent occurrence. In cases where switching the content is more frequent, -you should use navigation tabs instead.
- - -The basic procedure to enable drop-down navigation is:
- --actionBar.setListNavigationCallbacks(mSpinnerAdapter, mNavigationCallback); --
This method takes your {@link android.widget.SpinnerAdapter} and {@link -android.support.v7.app.ActionBar.OnNavigationListener}.
-This procedure is relatively short, but implementing the {@link android.widget.SpinnerAdapter} -and {@link android.app.ActionBar.OnNavigationListener} is where most of the work is done. There are -many ways you can implement these to define the functionality for your drop-down navigation and -implementing various types of {@link android.widget.SpinnerAdapter} is beyond the scope of this -document (you should refer to the {@link android.widget.SpinnerAdapter} class reference for more -information). However, below is an example for a {@link android.widget.SpinnerAdapter} and {@link -android.app.ActionBar.OnNavigationListener} to get you started (click the title to reveal the -sample).
- - - -
- Example SpinnerAdapter and OnNavigationListener
- {@link android.widget.SpinnerAdapter} is an adapter that provides data for a spinner widget, -such as the drop-down list in the action bar. {@link android.widget.SpinnerAdapter} is an interface -that you can implement, but Android includes some useful implementations that you can extend, such -as {@link android.widget.ArrayAdapter} and {@link -android.widget.SimpleCursorAdapter}. For example, here's an easy way to create a {@link -android.widget.SpinnerAdapter} by using {@link android.widget.ArrayAdapter} implementation, which -uses a string array as the data source:
- --SpinnerAdapter mSpinnerAdapter = ArrayAdapter.createFromResource(this, - R.array.action_list, android.R.layout.simple_spinner_dropdown_item); -- -
The {@link android.widget.ArrayAdapter#createFromResource createFromResource()} method takes -three parameters: the application {@link android.content.Context}, the resource ID for the string -array, and the layout to use for each list item.
- -A string array -defined in a resource looks like this:
- --<?xml version="1.0" encoding="utf-8"?> -<resources> - <string-array name="action_list"> - <item>Mercury</item> - <item>Venus</item> - <item>Earth</item> - </string-array> -</resources> -- -
The {@link android.widget.ArrayAdapter} returned by {@link -android.widget.ArrayAdapter#createFromResource createFromResource()} is complete and ready for you -to pass it to {@link android.app.ActionBar#setListNavigationCallbacks setListNavigationCallbacks()} -(in step 4 from above). Before you do, though, you need to create the {@link -android.app.ActionBar.OnNavigationListener OnNavigationListener}.
- - -Your implementation of {@link android.app.ActionBar.OnNavigationListener} is where you handle -fragment changes or other modifications to your activity when the user selects an item from the -drop-down list. There's only one callback method to implement in the listener: {@link -android.app.ActionBar.OnNavigationListener#onNavigationItemSelected onNavigationItemSelected()}.
- -The {@link -android.app.ActionBar.OnNavigationListener#onNavigationItemSelected onNavigationItemSelected()} -method receives the position of the item in the list and a unique item ID provided by the {@link -android.widget.SpinnerAdapter}.
- -Here's an example that instantiates an anonymous implementation of {@link -android.app.ActionBar.OnNavigationListener OnNavigationListener}, which inserts a {@link -android.app.Fragment} into the -layout container identified by {@code R.id.fragment_container}:
- -
-mOnNavigationListener = new OnNavigationListener() {
- // Get the same strings provided for the drop-down's ArrayAdapter
- String[] strings = getResources().getStringArray(R.array.action_list);
-
- @Override
- public boolean onNavigationItemSelected(int position, long itemId) {
- // Create new fragment from our own Fragment class
- ListContentFragment newFragment = new ListContentFragment();
- FragmentTransaction ft = getSupportFragmentManager().beginTransaction();
-
- // Replace whatever is in the fragment container with this fragment
- // and give the fragment a tag name equal to the string at the position
- // selected
- ft.replace(R.id.fragment_container, newFragment, strings[position]);
-
- // Apply changes
- ft.commit();
- return true;
- }
-};
-
-
-This instance of {@link android.app.ActionBar.OnNavigationListener OnNavigationListener} is -complete and you can now call {@link android.app.ActionBar#setListNavigationCallbacks -setListNavigationCallbacks()} (in step 4), passing the {@link android.widget.ArrayAdapter} and this -{@link android.app.ActionBar.OnNavigationListener OnNavigationListener}.
- -In this example, when the user selects an item from the drop-down list, a fragment is added to -the layout (replacing the current fragment in the {@code R.id.fragment_container} view). The -fragment added is given a tag that uniquely identifies it, which is the same string used to -identify the fragment in the drop-down list.
- -Here's a look at the {@code ListContentFragment} class that defines each fragment in this -example:
- -
-public class ListContentFragment extends Fragment {
- private String mText;
-
- @Override
- public void onAttach(Activity activity) {
- // This is the first callback received; here we can set the text for
- // the fragment as defined by the tag specified during the fragment
- // transaction
- super.onAttach(activity);
- mText = getTag();
- }
-
- @Override
- public View onCreateView(LayoutInflater inflater, ViewGroup container,
- Bundle savedInstanceState) {
- // This is called to define the layout for the fragment;
- // we just create a TextView and set its text to be the fragment tag
- TextView text = new TextView(getActivity());
- text.setText(mText);
- return text;
- }
-}
-
-
- If you want to implement a visual design that represents your app's brand, the action bar allows -you to customize each detail of its appearance, including the action bar color, text colors, button -styles, and more. To do so, you need to use Android's style and theme framework to restyle the action bar -using special style properties.
- -Caution: For all background drawables you provide, be sure to -use Nine-Patch drawables -to allow stretching. The nine-patch image should be smaller than 40dp tall and 30dp -wide.
- - - -The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionBar - Widget.AppCompat.ActionBar}, which is what you should use as the parent style.
-Supported styles include:
-The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionButton - Widget.AppCompat.ActionButton}, which is what you should use as the parent style.
-The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionButton_Overflow - Widget.AppCompat.ActionButton.Overflow}, which is what you should use as the parent style.
-The default for this style for this - is {@link android.support.v7.appcompat.R.style#TextAppearance_AppCompat_Widget_ActionBar_Title - TextAppearance.AppCompat.Widget.ActionBar.Title}, which is what you should use as the parent - style.
Normally, the action bar requires its own space on the screen and your activity layout fills in -what's left over. When the action bar is in overlay mode, your activity layout uses all the -available space and the system draws the action bar on top. Overlay mode can be useful if you want -your content to keep a fixed size and position when the action bar is hidden and shown. You might -also like to use it purely as a visual effect, because you can use a semi-transparent background -for the action bar so the user can still see some of your activity layout behind the action -bar.
-Note: The {@link android.R.style#Theme_Holo Holo} theme families -draw the action bar with a semi-transparent background by default. However, you can modify it with -your own styles and the {@link android.R.style#Theme_DeviceDefault DeviceDefault} theme on -different devices might use an opaque background by default.
-When overlay mode is enabled, your activity layout has no awareness of the action bar lying on -top of it. So, you must be careful not to place any important information or UI components in the -area overlaid by the action bar. If appropriate, you can refer to the platform's value for {@link -android.R.attr#actionBarSize} to determine the height of the action bar, by referencing it -in your XML layout. For example:
--<SomeView - ... - android:layout_marginTop="?android:attr/actionBarSize" /> --
You can also retrieve the action bar height at runtime with {@link -android.app.ActionBar#getHeight()}. This reflects the height of the action bar at the time it's -called, which might not include the stacked action bar (due to navigation tabs) if called during -early activity lifecycle methods. To see how you can determine the total height at runtime, -including the stacked action bar, see the -{@code TitlesFragment} class in the Honeycomb Gallery sample app.
- -The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionButton - Widget.AppCompat.ActionButton}, which is what you should use as the parent style.
The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionBar_TabView - Widget.AppCompat.ActionBar.TabView}, which is what you should use as the parent style.
The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionBar_TabBar - Widget.AppCompat.ActionBar.TabBar}, which is what you should use as the parent style.
The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_ActionBar_TabText - Widget.AppCompat.ActionBar.TabText}, which is what you should use as the parent style.
The default for this style for this - is {@link android.support.v7.appcompat.R.style#Widget_AppCompat_Spinner_DropDown_ActionBar - Widget.AppCompat.Spinner.DropDown.ActionBar}, which is what you should use as the parent - style.
Here's an example that defines a custom theme for an activity, {@code CustomActivityTheme}, -that includes several styles to customize the action bar.
- -Notice that there are two versions for each action bar style property. The first one -includes the {@code android:} prefix on the property name to support API levels 11 and higher -that include these properties in the framework. The second version does not -include the {@code android:} prefix and is for older versions of the platform, on which -the system uses the style property from the support library. The effect for each is the same.
- --<?xml version="1.0" encoding="utf-8"?> -<resources> - <!-- the theme applied to the application or activity --> - <style name="CustomActionBarTheme" - parent="@style/Theme.AppCompat.Light"> - <item name="android:actionBarStyle">@style/MyActionBar</item> - <item name="android:actionBarTabTextStyle">@style/TabTextStyle</item> - <item name="android:actionMenuTextColor">@color/actionbar_text</item> - - <!-- Support library compatibility --> - <item name="actionBarStyle">@style/MyActionBar</item> - <item name="actionBarTabTextStyle">@style/TabTextStyle</item> - <item name="actionMenuTextColor">@color/actionbar_text</item> - </style> - - <!-- general styles for the action bar --> - <style name="MyActionBar" - parent="@style/Widget.AppCompat.ActionBar"> - <item name="android:titleTextStyle">@style/TitleTextStyle</item> - <item name="android:background">@drawable/actionbar_background</item> - <item name="android:backgroundStacked">@drawable/actionbar_background</item> - <item name="android:backgroundSplit">@drawable/actionbar_background</item> - - <!-- Support library compatibility --> - <item name="titleTextStyle">@style/TitleTextStyle</item> - <item name="background">@drawable/actionbar_background</item> - <item name="backgroundStacked">@drawable/actionbar_background</item> - <item name="backgroundSplit">@drawable/actionbar_background</item> - </style> - - <!-- action bar title text --> - <style name="TitleTextStyle" - parent="@style/TextAppearance.AppCompat.Widget.ActionBar.Title"> - <item name="android:textColor">@color/actionbar_text</item> - </style> - - <!-- action bar tab text --> - <style name="TabTextStyle" - parent="@style/Widget.AppCompat.ActionBar.TabText"> - <item name="android:textColor">@color/actionbar_text</item> - </style> -</resources> - -- -
In your manifest file, you can apply the theme to your entire app:
- --<application android:theme="@style/CustomActionBarTheme" ... /> -- -
Or to individual activities:
- --<activity android:theme="@style/CustomActionBarTheme" ... /> -- - -
Caution: Be certain that each theme and style declares a parent -theme in the {@code <style>} tag, from which it inherits all styles not explicitly declared -by your theme. When modifying the action bar, using a parent theme is important so that you can -simply override the action bar styles you want to change without re-implementing the styles you -want to leave alone (such as text size or padding in action items).
- -For more information about using style and theme resources in your application, read Styles and Themes.
- - - diff --git a/docs/html/guide/topics/ui/menus.jd b/docs/html/guide/topics/ui/menus.jd index dfcea529d29db..4f81c93d73c02 100644 --- a/docs/html/guide/topics/ui/menus.jd +++ b/docs/html/guide/topics/ui/menus.jd @@ -47,7 +47,7 @@ parent.link=index.htmlBeginning with Android 3.0 (API level 11), Android-powered devices are no longer required to provide a dedicated Menu button. With this change, Android apps should migrate away from a -dependence on the traditional 6-item menu panel and instead provide an action bar to present common +dependence on the traditional 6-item menu panel and instead provide an app bar to present common user actions.
Although the design and user experience for some menu items have changed, the semantics to define @@ -71,14 +71,14 @@ guide shows how to create the three fundamental types of menus or action present versions of Android:
If you're developing for Android 2.3 or lower, users can reveal the options menu panel by pressing the Menu button.
-On Android 3.0 and higher, items from the options menu are presented by the action bar as a combination of on-screen action +
On Android 3.0 and higher, items from the options menu are presented by the + app bar as a combination of on-screen action items and overflow options. Beginning with Android 3.0, the Menu button is deprecated (some devices don't have one), so you should migrate toward using the action bar to provide access to actions and @@ -173,8 +173,8 @@ when the user selects it.
These are the most important attributes you should use, but there are many more available. @@ -233,25 +233,20 @@ the sixth item and the rest into the overflow menu, which the user can open by s More.
For more information about action items and other action bar behaviors, see the Action Bar guide.
-Note: Even if you're not developing for Android 3.0 or -higher, you can build your own action bar layout for a similar effect. For an example of how you can -support older versions of Android with an action bar, see the Action Bar Compatibility -sample.
+2).For more information about action items and other app bar behaviors, see the Adding the App Bar training class.
-Figure 2. Action bar from the Figure 2. App bar from the Honeycomb Gallery app, showing navigation tabs and a camera action item (plus the action overflow button).
@@ -285,13 +280,13 @@ properties with {@link android.view.MenuItem} APIs. android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()} to create the options menu when the user opens the menu for the first time. If you've developed for Android 3.0 and higher, the system calls {@link android.app.Activity#onCreateOptionsMenu(Menu) onCreateOptionsMenu()} when -starting the activity, in order to show items to the action bar. +starting the activity, in order to show items to the app bar.When the user selects an item from the options menu (including action items in the action bar), +
When the user selects an item from the options menu (including action items in the app bar), the system calls your activity's {@link android.app.Activity#onOptionsItemSelected(MenuItem) onOptionsItemSelected()} method. This method passes the {@link android.view.MenuItem} selected. You can identify the item by calling {@link android.view.MenuItem#getItemId()}, which returns the unique @@ -370,7 +365,7 @@ onPrepareOptionsMenu()} each time the user opens the options menu (presses the < button).
On Android 3.0 and higher, the options menu is considered to always be open when menu items are -presented in the action bar. When an event occurs and you want to perform a menu update, you must +presented in the app bar. When an event occurs and you want to perform a menu update, you must call {@link android.app.Activity#invalidateOptionsMenu invalidateOptionsMenu()} to request that the system call {@link android.app.Activity#onPrepareOptionsMenu(Menu) onPrepareOptionsMenu()}.
@@ -505,8 +500,8 @@ and the contextual action bar disappears when the user deselects all items, pres or selects the Done action on the left side of the bar.Note: The contextual action bar is not necessarily -associated with the action bar. They operate -independently, even though the contextual action bar visually overtakes the action bar +associated with the app bar. They operate +independently, even though the contextual action bar visually overtakes the app bar position.
If you're developing for Android 3.0 (API level 11) or higher, you diff --git a/docs/html/guide/topics/ui/overview.jd b/docs/html/guide/topics/ui/overview.jd index 41f7cc7b3f018..85c5756de35c0 100644 --- a/docs/html/guide/topics/ui/overview.jd +++ b/docs/html/guide/topics/ui/overview.jd @@ -67,7 +67,7 @@ Layouts. android.view.ViewGroup} objects. Android provides several app components that offer a standard UI layout for which you simply need to define the content. These UI components each have a unique set of APIs that are described in their respective documents, such as Action Bar, Adding the App Bar, Dialogs, and Status Notifications.
diff --git a/docs/html/training/search/setup.jd b/docs/html/training/search/setup.jd index 044e422fe6a6a..576929320bc03 100644 --- a/docs/html/training/search/setup.jd +++ b/docs/html/training/search/setup.jd @@ -10,7 +10,7 @@ next.link=search.htmlBeginning in Android 3.0, using the {@link android.widget.SearchView} widget as an item in - the action bar is the preferred way to provide search in your app. Like with all items in - the action bar, you can define the {@link android.widget.SearchView} to show at all times, only + the app bar is the preferred way to provide search in your app. Like with all items in + the app bar, you can define the {@link android.widget.SearchView} to show at all times, only when there is room, or as a collapsible action, which displays the {@link - android.widget.SearchView} as an icon initially, then takes up the entire action bar as a search + android.widget.SearchView} as an icon initially, then takes up the entire app bar as a search field when the user clicks the icon.
Note: Later in this class, you will learn how to make your app compatible down to Android 2.1 (API level 7) for devices that do not support {@link android.widget.SearchView}.
-To add a {@link android.widget.SearchView} widget to the action bar, create a file named +
To add a {@link android.widget.SearchView} widget to the app bar, create a file named
res/menu/options_menu.xml in your project and add the following code to the file.
This code defines how to create the search item, such as the icon to use and the title of the
item. The collapseActionView attribute allows your {@link android.widget.SearchView}
- to expand to take up the whole action bar and collapse back down into a
- normal action bar item when not in use. Because of the limited action bar space on handset devices,
+ to expand to take up the whole app bar and collapse back down into a
+ normal app bar item when not in use. Because of the limited app bar space on handset devices,
using the collapsibleActionView attribute is recommended to provide a better
user experience.
@@ -63,7 +63,7 @@ next.link=search.html@@ -121,7 +122,8 @@ private void setShareIntent(Intent shareIntent) { want to set it and then update it as the UI changes. For example, when you view photos full screen in the Gallery app, the sharing intent changes as you flip between photos. -Note: If you already have an existing XML file for your menu items, you can add the
-<item>element to that file instead.To display the {@link android.widget.SearchView} in the action bar, inflate the XML menu +
To display the {@link android.widget.SearchView} in the app bar, inflate the XML menu resource (
res/menu/options_menu.xml) in the {@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()} method of your activity:@@ -76,7 +76,7 @@ public boolean onCreateOptionsMenu(Menu menu) { }-If you run your app now, the {@link android.widget.SearchView} appears in your app's action +
If you run your app now, the {@link android.widget.SearchView} appears in your app's app bar, but it isn't functional. You now need to define how the {@link android.widget.SearchView} behaves.
@@ -194,4 +194,4 @@ public class SearchResultsActivity extends Activity {If you run your app now, the {@link android.widget.SearchView} can accept the user's query and start your searchable activity with the {@link android.content.Intent#ACTION_SEARCH} intent. It - is now up to you to figure out how to store and search your data given a query.
\ No newline at end of file + is now up to you to figure out how to store and search your data given a query. diff --git a/docs/html/training/sharing/shareaction.jd b/docs/html/training/sharing/shareaction.jd index ee811dabdc30e..53e13d0969772 100644 --- a/docs/html/training/sharing/shareaction.jd +++ b/docs/html/training/sharing/shareaction.jd @@ -21,7 +21,8 @@ previous.link=receive.htmlYou should also read
For further discussion about the {@link android.widget.ShareActionProvider} object, see the Action Bar guide.
+For further discussion about the {@link android.widget.ShareActionProvider} +object, see Action Views +and Action Providers.
diff --git a/docs/html/training/system-ui/dim.jd b/docs/html/training/system-ui/dim.jd index f28c9489a2f30..a86257a8c7c7d 100644 --- a/docs/html/training/system-ui/dim.jd +++ b/docs/html/training/system-ui/dim.jd @@ -20,7 +20,7 @@ trainingnavtop=trueOn Android 4.1 and higher, to avoid resizing your layout when the action bar hides and - shows, you can enable overlay mode for the action bar. + shows, you can enable overlay mode for the action bar. When in overlay mode, your activity layout uses all the space available as if the action bar is not there and the system draws the action bar in front of your layout. This obscures some of the layout at the top, but now when the diff --git a/docs/html/training/system-ui/visibility.jd b/docs/html/training/system-ui/visibility.jd index b562add0124c9..14c139e926b45 100644 --- a/docs/html/training/system-ui/visibility.jd +++ b/docs/html/training/system-ui/visibility.jd @@ -19,7 +19,7 @@ trainingnavtop=true