Ancestral navigation is up the application's information hierarchy, where the top of the hierarchy (or root) is the application's home screen. This navigation concept is described in Designing Effective Navigation. This lesson discusses how to provide ancestral navigation using the Up button in the action bar.
+All screens in your app that are not the main entrance to your app (the "home" screen) +should offer the user a way to navigate to the logical parent screen in the app's hierarchy by +pressing the Up button in the action bar. +This lesson shows you how to properly implement this behavior.
+ +Up Navigation Design
+The concepts and principles for Up navigation are described in Designing Effective +Navigation and the Navigation design +guide.
+When implementing ancestral navigation, all screens in your application that aren't the home screen should offer a means of navigating to the immediate parent screen in the hierarchy via the Up button in the action bar.
- - -
-
+
Figure 1. The Up button in the action bar.
-Regardless of how the current screen was reached, pressing this button should always take the user to the same screen in the hierarchy.
-To implement Up, enable it in the action bar in your activity's {@link android.app.Activity#onCreate onCreate()} method:
+ +To implement Up navigation, the first step is to declare which activity is the +appropriate parent for each activity. Doing so allows the system to facilitate navigation patterns +such as Up because the system can determine the logical parent activity from +the manifest file.
+ +Beginning in Android 4.1 (API level 16), you can declare the logical parent of each +activity by specifying the {@code +android:parentActivityName} attribute +in the {@code <activity>} +element.
+ +If your app supports Android 4.0 and lower, include the +Support Library with your app and +add a {@code <meta-data>} +element inside the {@code +<activity>}. Then specify the parent activity as the value +for {@code android.support.PARENT_ACTIVITY}, matching the {@code +android:parentActivityName} attribute.
+ +For example:
+ ++<application ... > + ... + <!-- The main/home activity (it 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 4.0 and lower --> + <meta-data + android:name="android.support.PARENT_ACTIVITY" + android:value="com.example.myfirstapp.MainActivity" /> + </activity> +</application> ++ +
With the parent activity declared this way, you can navigate Up +to the appropriate parent using the {@link android.support.v4.app.NavUtils} APIs, as shown in +the following sections.
+ + +To allow Up navigation with the app icon in the action bar, call +{@link android.app.ActionBar#setDisplayHomeAsUpEnabled setDisplayHomeAsUpEnabled()}:
{@literal @}Override
public void onCreate(Bundle savedInstanceState) {
...
getActionBar().setDisplayHomeAsUpEnabled(true);
- ...
}
-You should also handle android.R.id.home in {@link android.app.Activity#onOptionsItemSelected onOptionsItemSelected()}. This resource is the menu item ID for the Home (or Up) button. To ensure that a specific parent activity is shown, DO NOT simply call {@link android.app.Activity#finish finish()}. Instead, use an intent such as the one described below.
This adds a left-facing caret alongside the app icon and enables it as an action button +such that when the user presses it, your activity receives a call to +{@link android.app.Activity#onOptionsItemSelected onOptionsItemSelected()}. The +ID for the action is {@code android.R.id.home}.
+ + + +To navigate up when the user presses the app icon, you can use the {@link +android.support.v4.app.NavUtils} class's static method, +{@link android.support.v4.app.NavUtils#navigateUpFromSameTask +navigateUpFromSameTask()}. When you call this method, it finishes the current activity and +starts (or resumes) the appropriate parent activity. +If the target parent activity is in the task's back stack, it is brought +forward as defined by {@link android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP}.
+ +For example:
{@literal @}Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
- case android.R.id.home:
- // This is called when the Home (Up) button is pressed
- // in the Action Bar.
- Intent parentActivityIntent = new Intent(this, MyParentActivity.class);
- parentActivityIntent.addFlags(
- Intent.FLAG_ACTIVITY_CLEAR_TOP |
- Intent.FLAG_ACTIVITY_NEW_TASK);
- startActivity(parentActivityIntent);
- finish();
- return true;
+ // Respond to the action bar's Up/Home button
+ case android.R.id.home:
+ NavUtils.navigateUpFromSameTask(this);
+ return true;
}
return super.onOptionsItemSelected(item);
}
-When the current activity belongs to a task from a different application—for example if it was reached via an intent from another application—pressing Up should create a new task for the application with a synthesized back stack. This approach is described in Android Design: Navigation and the {@link android.support.v4.app.TaskStackBuilder} class reference.
+However, using {@link android.support.v4.app.NavUtils#navigateUpFromSameTask +navigateUpFromSameTask()} is suitable only when your app is the owner of the current +task (that is, the user began this task from your app). If that's not true and your +activity was started in a task that belongs to a different app, then +navigating Up should create a new task that belongs to your app, which +requires that you create a new back stack.
-The {@link android.support.v4.app.NavUtils} and {@link android.support.v4.app.TaskStackBuilder} classes in the Android Support Package provide helpers for implementing this behavior correctly. An example usage of these two helper classes is below:
+ +If your activity provides any intent filters +that allow other apps to start the +activity, you should implement the {@link android.app.Activity#onOptionsItemSelected +onOptionsItemSelected()} callback such that if the user presses the Up button +after entering your activity from another app's task, your app starts a new task +with the appropriate back stack before navigating up.
+ +You can do so by first calling +{@link android.support.v4.app.NavUtils#shouldUpRecreateTask shouldUpRecreateTask()} to check +whether the current activity instance exists in a different app's task. If +it returns true, then build a new task with {@link android.support.v4.app.TaskStackBuilder}. +Otherwise, you can use the {@link android.support.v4.app.NavUtils#navigateUpFromSameTask +navigateUpFromSameTask()} method as shown above.
+ +For example:
{@literal @}Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
- case android.R.id.home:
- Intent upIntent = new Intent(this, MyParentActivity.class);
- if (NavUtils.shouldUpRecreateTask(this, upIntent)) {
- // This activity is not part of the application's task, so create a new task
- // with a synthesized back stack.
- TaskStackBuilder.from(this)
- .addNextIntent(new Intent(this, MyGreatGrandParentActivity.class))
- .addNextIntent(new Intent(this, MyGrandParentActivity.class))
- .addNextIntent(upIntent)
- .startActivities();
- finish();
- } else {
- // This activity is part of the application's task, so simply
- // navigate up to the hierarchical parent activity.
- NavUtils.navigateUpTo(this, upIntent);
- }
- return true;
+ // Respond to the action bar's Up/Home button
+ case android.R.id.home:
+ Intent upIntent = NavUtils.getParentActivityIntent(this);
+ if (NavUtils.shouldUpRecreateTask(this, upIntent)) {
+ // This activity is NOT part of this app's task, so create a new task
+ // when navigating up, with a synthesized back stack.
+ TaskStackBuilder.create(this)
+ // Add all of this activity's parents to the back stack
+ .addNextIntentWithParentStack(upIntent)
+ // Navigate up to the closest parent
+ .startActivities();
+ } else {
+ // This activity is part of this app's task, so simply
+ // navigate up to the logical parent activity.
+ NavUtils.navigateUpTo(this, upIntent);
+ }
+ return true;
}
return super.onOptionsItemSelected(item);
}
-By default, the Home button in the action bar is interactive. Since it does not make much sense to navigate home—or up one level—while on the home screen, you should disable the button like so:
- --getActionBar().setHomeButtonEnabled(false); -+
Note: In order for the {@link +android.support.v4.app.TaskStackBuilder#addNextIntentWithParentStack addNextIntentWithParentStack()} +method to work, +you must declare the logical parent of each activity in your manifest file, using the +{@code +android:parentActivityName} attribute (and corresponding {@code <meta-data>} element) +as described above.
diff --git a/docs/html/training/implementing-navigation/index.jd b/docs/html/training/implementing-navigation/index.jd index 990bcfe7aecf1..e4421c640f540 100644 --- a/docs/html/training/implementing-navigation/index.jd +++ b/docs/html/training/implementing-navigation/index.jd @@ -1,5 +1,5 @@ page.title=Implementing Effective Navigation -page.tags="viewpager","tasks","back","up" +page.tags="viewpager","tasks","back","up","swipe view","drawer" trainingnavtop=true startpage=true @@ -12,9 +12,9 @@ startpage=trueThis class demonstrates how to implement the key navigation design patterns detailed in the Designing Effective Navigation class. -The lessons in this class cover implementing navigation up, down, and across your application's screen -map.
+ -After reading through the lessons in this class and exploring the associated sample application -(see right), you should also have a basic understanding of how to use -{@link android.app.ActionBar} and {@link android.support.v4.view.ViewPager}, two components that are fundamental to core app navigation.
+After reading the lessons in this class, you should have a strong understanding of how to +implement navigation patterns with tabs, swipe views, and a navigation drawer. You should also +understand how to provide proper Up and Back navigation.
+ +Note: Several elements of this class require the +Support Library APIs. +If you have not used the Support Library before, follow the lesson about Using the Support Library +to get your project set up.
Lateral navigation is navigation between sibling screens in the application's screen hierarchy (sometimes referred to as a screen map). The most prominent lateral navigation patterns are tabs and horizontal paging (also known as swipe views). This pattern and others are described in Designing Effective Navigation. This lesson covers how to implement several of the primary lateral navigation patterns in Android.
+Swipe views provide lateral navigation between sibling screens such as tabs with +a horizontal finger gesture (a pattern sometimes known as horizontal paging). This lesson teaches +you how to create a tab layout with swipe views for switching between tabs, or how to show +a title strip instead of tabs.
-Swipe View Design
+Before implementing these features, you should understand the concepts and recommendations +as described in Designing +Effective Navigation and the Swipe +Views design guide.
+Tabs allow the user to navigate between sibling screens by selecting the appropriate tab indicator available at the top of the display. In Android 3.0 and later, tabs are implemented using the {@link android.app.ActionBar} class, and are generally set up in {@link android.app.Activity#onCreate Activity.onCreate()}. In some cases, such as when horizontal space is limited and/or the number of tabs is large, an appropriate alternate presentation for tabs is a dropdown list (sometimes implemented using a {@link android.widget.Spinner}).
-In previous versions of Android, tabs could be implemented using a -{@link android.widget.TabWidget} and {@link android.widget.TabHost}.
-As of Android 3.0, however, you should use either {@link android.app.ActionBar#NAVIGATION_MODE_TABS} or {@link android.app.ActionBar#NAVIGATION_MODE_LIST} along with the {@link android.app.ActionBar} class.
-To create tabs, you can use the following code in your activity's {@link android.app.Activity#onCreate onCreate()} method. Note that the exact presentation of tabs may vary per device and by the current device configuration, to make best use of available screen space. For example, Android may automatically collapse tabs into a dropdown list if tabs don't fit horizontally in the action bar.
+You can create swipe views in your app using the {@link android.support.v4.view.ViewPager} +widget, available in the +Support Library. The +{@link android.support.v4.view.ViewPager} is a layout widget in which each child view is +a separate page (a separate tab) in the layout.
+ +To set up your layout with {@link android.support.v4.view.ViewPager}, add a +{@code <ViewPager>} element to your XML layout. For example, if each page in the swipe view +should consume the entire layout, then your layout looks like this:
-{@literal @}Override
-public void onCreate(Bundle savedInstanceState) {
- ...
- final ActionBar actionBar = getActionBar();
-
- // Specify that tabs should be displayed in the action bar.
- actionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_TABS);
-
- // Create a tab listener that is called when the user changes tabs.
- ActionBar.TabListener tabListener = new ActionBar.TabListener() {
- public void onTabSelected(ActionBar.Tab tab,
- FragmentTransaction ft) { }
-
- public void onTabUnselected(ActionBar.Tab tab,
- FragmentTransaction ft) { }
-
- public void onTabReselected(ActionBar.Tab tab,
- FragmentTransaction ft) { }
- };
-
- // Add 3 tabs.
- for (int i = 0; i < 3; i++) {
- actionBar.addTab(
- actionBar.newTab()
- .setText("Tab " + (i + 1))
- .setTabListener(tabListener));
- }
- ...
-}
+<?xml version="1.0" encoding="utf-8"?>
+<android.support.v4.view.ViewPager
+ xmlns:android="http://schemas.android.com/apk/res/android"
+ android:id="@+id/pager"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent" />
-To insert child views that represent each page, +you need to hook this layout to a {@link android.support.v4.view.PagerAdapter}. +There are two kinds of adapter you can use:
-To use a dropdown list instead, use the following code in your activity's {@link android.app.Activity#onCreate onCreate()} method. Dropdown lists are often preferable in cases where more information must be shown per navigation item, such as unread message counts, or where the number of available navigation items is large.
+
-{@literal @}Override
-public void onCreate(Bundle savedInstanceState) {
- ...
- final ActionBar actionBar = getActionBar();
-
- // Specify that a dropdown list should be displayed in the action bar.
- actionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_LIST);
-
- actionBar.setListNavigationCallbacks(
- // Specify a SpinnerAdapter to populate the dropdown list.
- new ArrayAdapter(
- actionBar.getThemedContext(),
- android.R.layout.simple_list_item_1,
- android.R.id.text1,
- new String[]{ "Tab 1", "Tab 2", "Tab 3" }),
-
- // Provide a listener to be called when an item is selected.
- new ActionBar.OnNavigationListener() {
- public boolean onNavigationItemSelected(
- int position, long id) {
- // Take action here, e.g. switching to the
- // corresponding fragment.
- return true;
- }
- });
- ...
-}
-
-
-Horizontal paging, or swipe views, allow users to swipe horizontally on the current screen to navigate to adjacent screens. This pattern can be implemented using the {@link android.support.v4.view.ViewPager} widget, currently available as part of the Android Support Package. For navigating between sibling screens representing a fixed number of sections, it's best to provide the {@link android.support.v4.view.ViewPager} with a {@link android.support.v4.app.FragmentPagerAdapter}. For horizontal paging across collections of objects, it's best to use a {@link android.support.v4.app.FragmentStatePagerAdapter}, which destroys fragments as the user navigates to other pages, minimizing memory usage.
- -Below is an example of using a {@link android.support.v4.view.ViewPager} to swipe across a collection of objects.
+For example, here's how you might use {@link android.support.v4.app.FragmentStatePagerAdapter} +to swipe across a collection of {@link android.app.Fragment} objects:
public class CollectionDemoActivity extends FragmentActivity {
@@ -147,8 +113,7 @@ public class CollectionDemoActivity extends FragmentActivity {
// Since this is an object collection, use a FragmentStatePagerAdapter,
// and NOT a FragmentPagerAdapter.
-public class DemoCollectionPagerAdapter extends
- FragmentStatePagerAdapter {
+public class DemoCollectionPagerAdapter extends FragmentStatePagerAdapter {
public DemoCollectionPagerAdapter(FragmentManager fm) {
super(fm);
}
@@ -194,7 +159,125 @@ public static class DemoObjectFragment extends Fragment {
}
-You can also add indicators to your horizontal paging UI by adding a {@link android.support.v4.view.PagerTitleStrip}. Below is an example layout XML file for an activity whose entire contents are a {@link android.support.v4.view.ViewPager} and a top-aligned {@link android.support.v4.view.PagerTitleStrip} inside it. Individual pages (provided by the adapter) occupy the remaining space inside the {@link android.support.v4.view.ViewPager}.
+This example shows only the code necessary to create the swipe views. The following +sections show how you can add tabs to help facilitate navigation between pages.
+ + +Action bar +tabs offer users a familiar interface +for navigating between and identifying sibling screens in your app.
+ +To create tabs using {@link android.app.ActionBar}, you need to enable +{@link android.app.ActionBar#NAVIGATION_MODE_TABS}, then create several instances of +{@link android.app.ActionBar.Tab} and supply an implementation of +the {@link android.app.ActionBar.TabListener} interface for each one. +For example, in your activity's {@link +android.app.Activity#onCreate onCreate()} method, you can use code similar to this:
+ +
+{@literal @}Override
+public void onCreate(Bundle savedInstanceState) {
+ final ActionBar actionBar = getActionBar();
+ ...
+
+ // Specify that tabs should be displayed in the action bar.
+ actionBar.setNavigationMode(ActionBar.NAVIGATION_MODE_TABS);
+
+ // Create a tab listener that is called when the user changes tabs.
+ ActionBar.TabListener tabListener = new ActionBar.TabListener() {
+ public void onTabSelected(ActionBar.Tab tab, FragmentTransaction ft) {
+ // show the given tab
+ }
+
+ public void onTabUnselected(ActionBar.Tab tab, FragmentTransaction ft) {
+ // hide the given tab
+ }
+
+ public void onTabReselected(ActionBar.Tab tab, FragmentTransaction ft) {
+ // probably ignore this event
+ }
+ };
+
+ // Add 3 tabs, specifying the tab's text and TabListener
+ for (int i = 0; i < 3; i++) {
+ actionBar.addTab(
+ actionBar.newTab()
+ .setText("Tab " + (i + 1))
+ .setTabListener(tabListener));
+ }
+}
+
+
+How you handle the {@link android.app.ActionBar.TabListener} callbacks to change tabs +depends on how you've constructed your content. But if you're using fragments for each tab with +{@link android.support.v4.view.ViewPager} as shown above, the following +section shows how to switch between pages when the user selects a tab and also update the selected +tab when the user swipes between pages.
+ + +To switch between pages in a {@link android.support.v4.view.ViewPager} when the user selects +a tab, implement your {@link android.app.ActionBar.TabListener} to select the appropriate page +by calling {@link android.support.v4.view.ViewPager#setCurrentItem setCurrentItem()} on your +{@link android.support.v4.view.ViewPager}:
+ +
+{@literal @}Override
+public void onCreate(Bundle savedInstanceState) {
+ ...
+
+ // Create a tab listener that is called when the user changes tabs.
+ ActionBar.TabListener tabListener = new ActionBar.TabListener() {
+ public void onTabSelected(ActionBar.Tab tab, FragmentTransaction ft) {
+ // When the tab is selected, switch to the
+ // corresponding page in the ViewPager.
+ mViewPager.setCurrentItem(tab.getPosition());
+ }
+ ...
+ };
+}
+
+
+Likewise, you should select the corresponding tab when the user swipes between pages with a +touch gesture. You can set up this behavior by implementing the +{@link android.support.v4.view.ViewPager.OnPageChangeListener} interface to change +the current tab each time the page changes. For example:
+ +
+{@literal @}Override
+public void onCreate(Bundle savedInstanceState) {
+ ...
+
+ mViewPager = (ViewPager) findViewById(R.id.pager);
+ mViewPager.setOnPageChangeListener(
+ new ViewPager.SimpleOnPageChangeListener() {
+ {@literal @}Override
+ public void onPageSelected(int position) {
+ // When swiping between pages, select the
+ // corresponding tab.
+ getActionBar().setSelectedNavigationItem(position);
+ }
+ });
+ ...
+}
+
+
+
+
+If you don't want to include action bar tabs and prefer to provide +scrollable tabs for a shorter +visual profile, you can use {@link android.support.v4.view.PagerTitleStrip} with +your swipe views.
+ +Below is an example layout XML file for an +activity whose entire contents are a {@link android.support.v4.view.ViewPager} and a top-aligned +{@link android.support.v4.view.PagerTitleStrip} inside it. Individual pages (provided by the +adapter) occupy the remaining space inside the {@link android.support.v4.view.ViewPager}.
<android.support.v4.view.ViewPager
@@ -214,43 +297,4 @@ public static class DemoObjectFragment extends Fragment {
android:paddingBottom="4dp" />
</android.support.v4.view.ViewPager>
-
-
-One of the key design recommendations in Android 4.0 for tabs is to allow swiping between them where appropriate. This behavior enables users to swipe horizontally across the selected tab's contents to navigate to adjacent tabs, without needed to directly interact with the tabs themselves. To implement this, you can use a {@link android.support.v4.view.ViewPager} in conjunction with the {@link android.app.ActionBar} tabs API.
- -Upon observing the current page changing, select the corresponding tab. You can set up this behavior using an {@link android.support.v4.view.ViewPager.OnPageChangeListener} in your activity's {@link android.app.Activity#onCreate onCreate()} method:
- -
-{@literal @}Override
-public void onCreate(Bundle savedInstanceState) {
- ...
- mViewPager.setOnPageChangeListener(
- new ViewPager.SimpleOnPageChangeListener() {
- {@literal @}Override
- public void onPageSelected(int position) {
- // When swiping between pages, select the
- // corresponding tab.
- getActionBar().setSelectedNavigationItem(position);
- }
- });
- ...
-}
-
-
-And upon selecting a tab, switch to the corresponding page in the {@link android.support.v4.view.ViewPager}. To do this, add an {@link android.app.ActionBar.TabListener} to your tab when creating it using the {@link android.app.ActionBar#newTab newTab()} method:
- -
-actionBar.newTab()
- ...
- .setTabListener(new ActionBar.TabListener() {
- public void onTabSelected(ActionBar.Tab tab,
- FragmentTransaction ft) {
- // When the tab is selected, switch to the
- // corresponding page in the ViewPager.
- mViewPager.setCurrentItem(tab.getPosition());
- }
- ...
- }));
-
+
\ No newline at end of file
diff --git a/docs/html/training/implementing-navigation/nav-drawer.jd b/docs/html/training/implementing-navigation/nav-drawer.jd
new file mode 100644
index 0000000000000..da2b04614b0d0
--- /dev/null
+++ b/docs/html/training/implementing-navigation/nav-drawer.jd
@@ -0,0 +1,368 @@
+page.title=Creating a Navigation Drawer
+
+trainingnavtop=true
+
+@jd:body
+
+NavigationDrawer.zip
+The navigation drawer is a panel that displays the app’s main navigation options +on the left edge of the screen. It is hidden most of the time, but is revealed +when the user swipes a finger from the left edge of the screen or, while at the top level of the +app, the user touches the app icon in the action bar.
+ +This lesson describes how to implement a navigation drawer using the +{@link android.support.v4.widget.DrawerLayout} APIs available in the +Support Library.
+ +Navigation Drawer Design
+Before you decide to use a navigation drawer in your app, you should understand the use +cases and design principles defined in the +Navigation Drawer design guide.
+To add a navigation drawer, declare your user interface with a +{@link android.support.v4.widget.DrawerLayout} object as the root view of your layout. +Inside the {@link android.support.v4.widget.DrawerLayout}, add one view that contains +the main content for the screen (your primary layout when the drawer is hidden) and another view +that contains the contents of the navigation drawer.
+ +For example, the following layout uses a {@link +android.support.v4.widget.DrawerLayout} with two child views: a {@link android.widget.FrameLayout} +to contain the main content (populated by a {@link android.app.Fragment} at +runtime), and a {@link android.widget.ListView} for the navigation drawer.
+ ++<android.support.v4.widget.DrawerLayout + xmlns:android="http://schemas.android.com/apk/res/android" + android:id="@+id/drawer_layout" + android:layout_width="match_parent" + android:layout_height="match_parent"> + <!-- The main content view --> + <FrameLayout + android:id="@+id/content_frame" + android:layout_width="match_parent" + android:layout_height="match_parent" /> + <!-- The navigation drawer --> + <ListView android:id="@+id/left_drawer" + android:layout_width="240dp" + android:layout_height="match_parent" + android:layout_gravity="start" + android:choiceMode="singleChoice" + android:divider="@android:color/transparent" + android:dividerHeight="0dp" + android:background="#111"/> +</android.support.v4.widget.DrawerLayout> ++ +
This layout demonstrates some important layout characteristics:
+In your activity, one of the first things to do is initialize +the navigation drawer's list of items. How you do so depends on the content of your app, but +a navigation drawer often consists of a {@link android.widget.ListView}, so the list +should be populated by an {@link android.widget.Adapter} (such as {@link +android.widget.ArrayAdapter} or {@link android.widget.SimpleCursorAdapter}).
+ +For example, here's how you can initialize the navigation list with a +string array:
+ +
+public class MainActivity extends Activity {
+ private String[] mPlanetTitles;
+ private ListView mDrawerList;
+ ...
+
+ @Override
+ public void onCreate(Bundle savedInstanceState) {
+ super.onCreate(savedInstanceState);
+ setContentView(R.layout.activity_main);
+
+ mPlanetTitles = getResources().getStringArray(R.array.planets_array);
+ mDrawerList = (ListView) findViewById(R.id.left_drawer);
+
+ // Set the adapter for the list view
+ mDrawerList.setAdapter(new ArrayAdapter<String>(this,
+ R.layout.drawer_list_item, mPlanetTitles));
+ // Set the list's click listener
+ mDrawerList.setOnItemClickListener(new DrawerItemClickListener());
+
+ ...
+ }
+}
+
+
+This code also calls {@link android.widget.ListView#setOnItemClickListener +setOnItemClickListener()} to receive click events in the navigation drawer's list. +The next section shows how to implement this interface +and change the content view when the user selects an item.
+ + + +When the user selects an item in the drawer's list, the system calls {@link +android.widget.AdapterView.OnItemClickListener#onItemClick onItemClick()} on the +{@link android.widget.AdapterView.OnItemClickListener OnItemClickListener} given to +{@link android.widget.ListView#setOnItemClickListener setOnItemClickListener()}.
+ +What you do in the {@link +android.widget.AdapterView.OnItemClickListener#onItemClick onItemClick()} method +depends on how you've implemented your app structure. In the following example, +selecting each item in the list inserts a different {@link +android.app.Fragment} into the main content view (the +{@link android.widget.FrameLayout} element identified by the {@code R.id.content_frame} ID):
+ +
+private class DrawerItemClickListener implements ListView.OnItemClickListener {
+ @Override
+ public void onItemClick(AdapterView parent, View view, int position, long id) {
+ selectItem(position);
+ }
+}
+
+/** Swaps fragments in the main content view */
+private void selectItem(int position) {
+ // Create a new fragment and specify the planet to show based on position
+ Fragment fragment = new PlanetFragment();
+ Bundle args = new Bundle();
+ args.putInt(PlanetFragment.ARG_PLANET_NUMBER, position);
+ fragment.setArguments(args);
+
+ // Insert the fragment by replacing any existing fragment
+ FragmentManager fragmentManager = getFragmentManager();
+ fragmentManager.beginTransaction()
+ .replace(R.id.content_frame, fragment)
+ .commit();
+
+ // Highlight the selected item, update the title, and close the drawer
+ mDrawer.setItemChecked(position, true);
+ setTitle(mPlanetTitles[position]);
+ mDrawerLayout.closeDrawer(mDrawer);
+}
+
+@Override
+public void setTitle(CharSequence title) {
+ mTitle = title;
+ getActionBar().setTitle(mTitle);
+}
+
+
+
+
+
+
+To listen for drawer open and close events, call {@link +android.support.v4.widget.DrawerLayout#setDrawerListener setDrawerListener()} on your +{@link android.support.v4.widget.DrawerLayout} and pass it an implementation of +{@link android.support.v4.widget.DrawerLayout.DrawerListener}. This interface provides callbacks +for drawer events such as {@link +android.support.v4.widget.DrawerLayout.DrawerListener#onDrawerOpened onDrawerOpened()} and {@link +android.support.v4.widget.DrawerLayout.DrawerListener#onDrawerClosed onDrawerClosed()}.
+ +However, rather than implementing the {@link +android.support.v4.widget.DrawerLayout.DrawerListener}, if your activity includes the +action bar, you can instead +extend the {@link android.support.v4.app.ActionBarDrawerToggle} class. The +{@link android.support.v4.app.ActionBarDrawerToggle} implements +{@link android.support.v4.widget.DrawerLayout.DrawerListener} so you can still override those +callbacks, but it also facilitates the proper +interaction behavior between the action bar icon and the navigation drawer (discussed further in +the next section).
+ +As discussed in the Navigation +Drawer design guide, you should modify the contents of the action bar +when the drawer is visible, such as to change the title and remove action items that are +contextual to the main content. The following code shows how you can do so by overriding {@link +android.support.v4.widget.DrawerLayout.DrawerListener} callback methods with an instance +of the {@link android.support.v4.app.ActionBarDrawerToggle} class:
+ +
+public class MainActivity extends Activity {
+ private DrawerLayout mDrawerLayout;
+ private ActionBarDrawerToggle mDrawerToggle;
+ private CharSequence mDrawerTitle;
+ private CharSequence mTitle;
+ ...
+
+ @Override
+ public void onCreate(Bundle savedInstanceState) {
+ super.onCreate(savedInstanceState);
+ setContentView(R.layout.activity_main);
+ ...
+
+ mTitle = mDrawerTitle = getTitle();
+ mDrawerLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
+ mDrawerToggle = new ActionBarDrawerToggle(this, mDrawerLayout,
+ R.drawable.ic_drawer, R.string.drawer_open, R.string.drawer_close) {
+
+ /** Called when a drawer has settled in a completely closed state. */
+ public void onDrawerClosed(View view) {
+ getActionBar().setTitle(mTitle);
+ invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
+ }
+
+ /** Called when a drawer has settled in a completely open state. */
+ public void onDrawerOpened(View drawerView) {
+ getActionBar().setTitle(mDrawerTitle);
+ invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
+ }
+ };
+
+ // Set the drawer toggle as the DrawerListener
+ mDrawerLayout.setDrawerListener(mDrawerToggle);
+ }
+
+ /* Called whenever we call invalidateOptionsMenu() */
+ @Override
+ public boolean onPrepareOptionsMenu(Menu menu) {
+ // If the nav drawer is open, hide action items related to the content view
+ boolean drawerOpen = mDrawerLayout.isDrawerOpen(mDrawerList);
+ menu.findItem(R.id.action_websearch).setVisible(!drawerOpen);
+ return super.onPrepareOptionsMenu(menu);
+ }
+}
+
+
+The next section describes the {@link android.support.v4.app.ActionBarDrawerToggle} constructor +arguments and the other steps required to set it up to handle interaction with the +action bar icon.
+ + + +Users can open and close the navigation drawer with a swipe gesture from or towards the left +edge of the screen, but if you're using the action bar, you should also allow users to +open and close it by touching the app icon. And the app icon should also indicate the presence of +the navigation drawer with a special icon. You can implement all this behavior by using the +{@link android.support.v4.app.ActionBarDrawerToggle} shown in the previous section.
+ +To make {@link android.support.v4.app.ActionBarDrawerToggle} work, create an instance of +it with its constructor, which requires the following arguments:
+Then, whether or not you've created a subclass of +{@link android.support.v4.app.ActionBarDrawerToggle} as your drawer listener, you need to call +upon your {@link android.support.v4.app.ActionBarDrawerToggle} in a few places throughout your +activity lifecycle:
+ +
+public class MainActivity extends Activity {
+ private DrawerLayout mDrawerLayout;
+ private ActionBarDrawerToggle mDrawerToggle;
+ ...
+
+ public void onCreate(Bundle savedInstanceState) {
+ ...
+
+ mDrawerLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
+ mDrawerToggle = new ActionBarDrawerToggle(this, mDrawerLayout,
+ R.drawable.ic_drawer, R.string.drawer_open, R.string.drawer_close) {
+
+ /** Called when a drawer has settled in a completely closed state. */
+ public void onDrawerClosed(View view) {
+ getActionBar().setTitle(mTitle);
+ }
+
+ /** Called when a drawer has settled in a completely open state. */
+ public void onDrawerOpened(View drawerView) {
+ getActionBar().setTitle(mDrawerTitle);
+ }
+ };
+
+ // Set the drawer toggle as the DrawerListener
+ mDrawerLayout.setDrawerListener(mDrawerToggle);
+
+ getActionBar().setDisplayHomeAsUpEnabled(true);
+ getActionBar().setHomeButtonEnabled(true);
+ }
+
+ @Override
+ protected void onPostCreate(Bundle savedInstanceState) {
+ super.onPostCreate(savedInstanceState);
+ // Sync the toggle state after onRestoreInstanceState has occurred.
+ mDrawerToggle.syncState();
+ }
+
+ @Override
+ public void onConfigurationChanged(Configuration newConfig) {
+ super.onConfigurationChanged(newConfig);
+ mDrawerToggle.onConfigurationChanged(newConfig);
+ }
+
+ @Override
+ public boolean onOptionsItemSelected(MenuItem item) {
+ // Pass the event to ActionBarDrawerToggle, if it returns
+ // true, then it has handled the app icon touch event
+ if (mDrawerToggle.onOptionsItemSelected(item)) {
+ return true;
+ }
+ // Handle your other action bar items...
+
+ return super.onOptionsItemSelected(item);
+ }
+
+ ...
+}
+
+
+For a complete example of a navigation drawer, download the sample available at the +top of the page.
\ No newline at end of file diff --git a/docs/html/training/implementing-navigation/temporal.jd b/docs/html/training/implementing-navigation/temporal.jd index 1c41732fd530d..c34a5cfe678ac 100644 --- a/docs/html/training/implementing-navigation/temporal.jd +++ b/docs/html/training/implementing-navigation/temporal.jd @@ -1,12 +1,6 @@ -page.title=Implementing Temporal Navigation -parent.title=Implementing Effective Navigation -parent.link=index.html +page.title=Providing Proper Back Navigation trainingnavtop=true -previous.title=Implementing Ancestral Navigation -previous.link=ancestral.html -next.title=Implementing Descendant Navigation -next.link=descendant.html @jd:body @@ -15,8 +9,9 @@ next.link=descendant.htmlTemporal navigation is navigation to previously visited screens. Users can visit previous screens by pressing the device Back button. This user interface pattern is described further in Providing Ancestral and Temporal Navigation in Designing Effective Navigation and in Android Design: Navigation.
+Back navigation is how users move backward through the history of screens +they previously visited. All Android devices provide a Back button for this +type of navigation, so your app should not add a Back button to the UI.
-Android handles basic Back navigation for you (see Tasks and Back Stack for details on this behavior). This lesson discusses a number of cases where applications should provide specialized logic for the Back button.
+In almost all situations, the system maintains a back stack of activities while the user +navigates your application. This allows the system to properly navigate backward when the user +presses the Back button. However, there are a few cases in which your app should manually +specify the Back behavior in order to provide the best user experience.
+ +Back Navigation Design
+Before continuing with this document, you should understand the +concepts and principles for Back navigation as described in +the Navigation design +guide.
+Navigation patterns that require you to manually specify the Back behavior include:
+How to implement proper Back navigation in these situations is described +in the following sections.
-When using fragments in your application, individual {@link android.app.FragmentTransaction} objects can represent context changes that should be added to the back stack. For example, if you are implementing a master/detail flow on a handset by swapping out fragments (thus emulating a {@link android.app.Activity#startActivity startActivity()} call), you should ensure that pressing the Back button on a detail screen returns the user to the master screen. To do so, you can use {@link android.app.FragmentTransaction#addToBackStack addToBackStack()}:
+Ordinarily, the system incrementally builds the back stack as the user navigates from one +activity to the next. However, when the user enters your app with a deep link that +starts the activity in its own task, it's necessary for you to synthesize a new +back stack because the activity is running in a new task without any back stack at all.
+ +For example, when a notification takes the user to an activity deep in your app hierarchy, +you should add activities into your task's back stack so that pressing Back navigates +up the app hierarchy instead of exiting the app. This pattern is described further in the +Navigation design guide.
+ + +Beginning in Android 4.1 (API level 16), you can declare the logical parent of each +activity by specifying the {@code +android:parentActivityName} attribute +in the {@code +<activity>} element. This allows the system to facilitate navigation patterns +because it can determine the logical Back or Up navigation path with this +information.
+ +If your app supports Android 4.0 and lower, include the +Support Library with your app and +add a {@code <meta-data>} +element inside the {@code +<activity>}. Then specify the parent activity as the value +for {@code android.support.PARENT_ACTIVITY}, matching the {@code +android:parentActivityName} attribute.
+ +For example:
+ ++<application ... > + ... + <!-- The main/home activity (it 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" > + <!-- The meta-data element is needed for versions lower than 4.1 --> + <meta-data + android:name="android.support.PARENT_ACTIVITY" + android:value="com.example.myfirstapp.MainActivity" /> + </activity> +</application> ++ +
With the parent activity declared this way, you can use the +{@link android.support.v4.app.NavUtils} APIs to synthesize a new back stack by identifying which +activity is the appropriate parent for each activity.
+ + + +Adding activities to the back stack begins upon the event that takes the user into your app. +That is, instead of calling {@link android.content.Context#startActivity startActivity()}, use the +{@link android.support.v4.app.TaskStackBuilder} APIs to define each activity that should +be placed into a new back stack. Then begin the target activity by calling {@link +android.support.v4.app.TaskStackBuilder#startActivities startActivities()}, or create the +appropriate {@link android.app.PendingIntent} by calling {@link +android.support.v4.app.TaskStackBuilder#getPendingIntent getPendingIntent()}.
+ +For example, when a notification takes the user to an activity deep in your app hierarchy, +you can use this code to create a {@link android.app.PendingIntent} +that starts an activity and inserts a new back stack into the target task:
+ ++// Intent for the activity to open when user selects the notification +Intent detailsIntent = new Intent(this, DetailsActivity.class); + +// Use TaskStackBuilder to build the back stack and get the PendingIntent +PendingIntent pendingIntent = + TaskStackBuilder.create(this) + // add all of DetailsActivity's parents to the stack, + // followed by DetailsActivity itself + .addNextIntentWithParentStack(upIntent) + .getPendingIntent(0, PendingIntent.FLAG_UPDATE_CURRENT); + +NotificationCompat.Builder builder = new NotificationCompat.Builder(this); +builder.setContentIntent(pendingIntent); +... ++ +
The resulting {@link android.app.PendingIntent} specifies not only the activity to +start (as defined by {@code detailsIntent}), but also the back stack that should be inserted +into the task (all parents of the {@code DetailsActivity} defined by {@code detailsIntent}). +So when the {@code DetailsActivity} starts, pressing Back +navigates backward through each of the {@code DetailsActivity} class's parent activities.
+ +Note: In order for the {@link +android.support.v4.app.TaskStackBuilder#addNextIntentWithParentStack addNextIntentWithParentStack()} +method to work, +you must declare the logical parent of each activity in your manifest file, using the +{@code +android:parentActivityName} attribute (and corresponding {@code <meta-data>} element) +as described above.
+ + + + + +When using fragments in your app, individual {@link android.app.FragmentTransaction} +objects may represent context changes that should be added to the back stack. For example, if you +are implementing a master/detail flow on a handset by +swapping out fragments, you should ensure that pressing the Back button on a detail +screen returns the user to the master screen. To do so, call {@link +android.app.FragmentTransaction#addToBackStack addToBackStack()} before you commit +the transaction:
// Works with either the framework FragmentManager or the // support package FragmentManager (getSupportFragmentManager). -getFragmentManager().beginTransaction() - .add(detailFragment, "detail") - - // Add this transaction to the back stack and commit. - .addToBackStack() - .commit(); +getSupportFragmentManager().beginTransaction() + .add(detailFragment, "detail") + // Add this transaction to the back stack + .addToBackStack() + .commit();-
The activity's {@link android.app.FragmentManager} handles Back button presses if there are {@link android.app.FragmentTransaction} objects on the back stack. When this happens, the {@link android.app.FragmentManager} pops the most recent transaction off the back stack and performs the reverse action (e.g., removing a fragment if the transaction added it).
+When there are {@link android.app.FragmentTransaction} objects on the back stack and the user +presses the Back button, +the {@link android.app.FragmentManager} pops the most recent transaction off the back stack and +performs the reverse action (such as removing a fragment if the transaction added it).
-If your application updates other user interface elements to reflect the current state of your fragments, such as the action bar, remember to update the UI when you commit the transaction. You should update your user interface after the fragment manager back stack changes in addition to when you commit the transaction. You can listen for when a FragmentTransaction is reverted by setting up an {@link android.app.FragmentManager.OnBackStackChangedListener}:
Note: You should not add transactions to the back +stack when the transaction is for horizontal navigation (such as when switching tabs) +or when modifying the content appearance (such as when adjusting filters). For more information, +about when Back navigation is appropriate, +see the Navigation design guide.
+ +If your application updates other user interface elements to reflect the current state of your +fragments, such as the action bar, remember to update the UI when you commit the transaction. You +should update your user interface after the back stack changes in addition to +when you commit the transaction. You can listen for when a {@link android.app.FragmentTransaction} +is reverted by setting up an {@link android.app.FragmentManager.OnBackStackChangedListener}:
-getFragmentManager().addOnBackStackChangedListener(
+getSupportFragmentManager().addOnBackStackChangedListener(
new FragmentManager.OnBackStackChangedListener() {
public void onBackStackChanged() {
// Update your UI here.
@@ -63,9 +217,14 @@ getFragmentManager().addOnBackStackChangedListener(
});
-If a part of your application is contained in a {@link android.webkit.WebView}, it may be appropriate for Back to traverse browser history. To do so, you can override {@link android.app.Activity#onBackPressed onBackPressed()} and proxy to the WebView if it has history state:
If a part of your application is contained in a {@link android.webkit.WebView}, it may be +appropriate for Back to traverse browser history. To do so, you can override {@link +android.app.Activity#onBackPressed onBackPressed()} and proxy to the +{@link android.webkit.WebView} if it has history state:
{@literal @}Override
@@ -80,4 +239,9 @@ public void onBackPressed() {
}
-Be careful when using this mechanism with highly dynamic web pages that can grow a large history. Pages that generate an extensive history, such as those that make frequent changes to the document hash, may make it tedious for users to get out of your activity.
+Be careful when using this mechanism with highly dynamic web pages that can grow a large +history. Pages that generate an extensive history, such as those that make frequent changes to +the document hash, may make it tedious for users to get out of your activity.
+ +For more information about using {@link android.webkit.WebView}, read Building Web Apps in WebView. diff --git a/docs/html/training/training_toc.cs b/docs/html/training/training_toc.cs index f0d33595e776e..0fdb4aaebf58c 100644 --- a/docs/html/training/training_toc.cs +++ b/docs/html/training/training_toc.cs @@ -614,20 +614,25 @@