PreferenceActivity.java revision b1a6e439f63e4fa2b07a4905f00b6badf58e6420
1/* 2 * Copyright (C) 2007 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.preference; 18 19import com.android.internal.util.XmlUtils; 20 21import org.xmlpull.v1.XmlPullParser; 22import org.xmlpull.v1.XmlPullParserException; 23 24import android.app.ActionBar; 25import android.app.Fragment; 26import android.app.FragmentBreadCrumbs; 27import android.app.FragmentManager; 28import android.app.FragmentTransaction; 29import android.app.ListActivity; 30import android.content.Context; 31import android.content.Intent; 32import android.content.res.Configuration; 33import android.content.res.Resources; 34import android.content.res.TypedArray; 35import android.content.res.XmlResourceParser; 36import android.os.Bundle; 37import android.os.Handler; 38import android.os.Message; 39import android.os.Parcel; 40import android.os.Parcelable; 41import android.text.TextUtils; 42import android.util.AttributeSet; 43import android.util.TypedValue; 44import android.util.Xml; 45import android.view.LayoutInflater; 46import android.view.View; 47import android.view.View.OnClickListener; 48import android.view.ViewGroup; 49import android.widget.AbsListView; 50import android.widget.ArrayAdapter; 51import android.widget.Button; 52import android.widget.FrameLayout; 53import android.widget.ImageView; 54import android.widget.ListView; 55import android.widget.TextView; 56 57import java.io.IOException; 58import java.util.ArrayList; 59import java.util.List; 60 61/** 62 * This is the base class for an activity to show a hierarchy of preferences 63 * to the user. Prior to {@link android.os.Build.VERSION_CODES#HONEYCOMB} 64 * this class only allowed the display of a single set of preference; this 65 * functionality should now be found in the new {@link PreferenceFragment} 66 * class. If you are using PreferenceActivity in its old mode, the documentation 67 * there applies to the deprecated APIs here. 68 * 69 * <p>This activity shows one or more headers of preferences, each of with 70 * is associated with a {@link PreferenceFragment} to display the preferences 71 * of that header. The actual layout and display of these associations can 72 * however vary; currently there are two major approaches it may take: 73 * 74 * <ul> 75 * <li>On a small screen it may display only the headers as a single list 76 * when first launched. Selecting one of the header items will re-launch 77 * the activity with it only showing the PreferenceFragment of that header. 78 * <li>On a large screen in may display both the headers and current 79 * PreferenceFragment together as panes. Selecting a header item switches 80 * to showing the correct PreferenceFragment for that item. 81 * </ul> 82 * 83 * <p>Subclasses of PreferenceActivity should implement 84 * {@link #onBuildHeaders} to populate the header list with the desired 85 * items. Doing this implicitly switches the class into its new "headers 86 * + fragments" mode rather than the old style of just showing a single 87 * preferences list. 88 * 89 * <a name="SampleCode"></a> 90 * <h3>Sample Code</h3> 91 * 92 * <p>The following sample code shows a simple preference activity that 93 * has two different sets of preferences. The implementation, consisting 94 * of the activity itself as well as its two preference fragments is:</p> 95 * 96 * {@sample development/samples/ApiDemos/src/com/example/android/apis/preference/PreferenceWithHeaders.java 97 * activity} 98 * 99 * <p>The preference_headers resource describes the headers to be displayed 100 * and the fragments associated with them. It is: 101 * 102 * {@sample development/samples/ApiDemos/res/xml/preference_headers.xml headers} 103 * 104 * <p>The first header is shown by Prefs1Fragment, which populates itself 105 * from the following XML resource:</p> 106 * 107 * {@sample development/samples/ApiDemos/res/xml/fragmented_preferences.xml preferences} 108 * 109 * <p>Note that this XML resource contains a preference screen holding another 110 * fragment, the Prefs1FragmentInner implemented here. This allows the user 111 * to traverse down a hierarchy of preferences; pressing back will pop each 112 * fragment off the stack to return to the previous preferences. 113 * 114 * <p>See {@link PreferenceFragment} for information on implementing the 115 * fragments themselves. 116 */ 117public abstract class PreferenceActivity extends ListActivity implements 118 PreferenceManager.OnPreferenceTreeClickListener, 119 PreferenceFragment.OnPreferenceStartFragmentCallback { 120 private static final String TAG = "PreferenceActivity"; 121 122 // Constants for state save/restore 123 private static final String HEADERS_TAG = ":android:headers"; 124 private static final String CUR_HEADER_TAG = ":android:cur_header"; 125 private static final String PREFERENCES_TAG = ":android:preferences"; 126 127 /** 128 * When starting this activity, the invoking Intent can contain this extra 129 * string to specify which fragment should be initially displayed. 130 */ 131 public static final String EXTRA_SHOW_FRAGMENT = ":android:show_fragment"; 132 133 /** 134 * When starting this activity and using {@link #EXTRA_SHOW_FRAGMENT}, 135 * this extra can also be specify to supply a Bundle of arguments to pass 136 * to that fragment when it is instantiated during the initial creation 137 * of PreferenceActivity. 138 */ 139 public static final String EXTRA_SHOW_FRAGMENT_ARGUMENTS = ":android:show_fragment_args"; 140 141 /** 142 * When starting this activity, the invoking Intent can contain this extra 143 * boolean that the header list should not be displayed. This is most often 144 * used in conjunction with {@link #EXTRA_SHOW_FRAGMENT} to launch 145 * the activity to display a specific fragment that the user has navigated 146 * to. 147 */ 148 public static final String EXTRA_NO_HEADERS = ":android:no_headers"; 149 150 private static final String BACK_STACK_PREFS = ":android:prefs"; 151 152 // extras that allow any preference activity to be launched as part of a wizard 153 154 // show Back and Next buttons? takes boolean parameter 155 // Back will then return RESULT_CANCELED and Next RESULT_OK 156 private static final String EXTRA_PREFS_SHOW_BUTTON_BAR = "extra_prefs_show_button_bar"; 157 158 // add a Skip button? 159 private static final String EXTRA_PREFS_SHOW_SKIP = "extra_prefs_show_skip"; 160 161 // specify custom text for the Back or Next buttons, or cause a button to not appear 162 // at all by setting it to null 163 private static final String EXTRA_PREFS_SET_NEXT_TEXT = "extra_prefs_set_next_text"; 164 private static final String EXTRA_PREFS_SET_BACK_TEXT = "extra_prefs_set_back_text"; 165 166 // --- State for new mode when showing a list of headers + prefs fragment 167 168 private final ArrayList<Header> mHeaders = new ArrayList<Header>(); 169 170 private HeaderAdapter mAdapter; 171 172 private FrameLayout mListFooter; 173 174 private ViewGroup mPrefsContainer; 175 176 private FragmentBreadCrumbs mFragmentBreadCrumbs; 177 178 private boolean mSinglePane; 179 180 private Header mCurHeader; 181 182 // --- State for old mode when showing a single preference list 183 184 private PreferenceManager mPreferenceManager; 185 186 private Bundle mSavedInstanceState; 187 188 // --- Common state 189 190 private Button mNextButton; 191 192 /** 193 * The starting request code given out to preference framework. 194 */ 195 private static final int FIRST_REQUEST_CODE = 100; 196 197 private static final int MSG_BIND_PREFERENCES = 1; 198 private static final int MSG_BUILD_HEADERS = 2; 199 private Handler mHandler = new Handler() { 200 @Override 201 public void handleMessage(Message msg) { 202 switch (msg.what) { 203 case MSG_BIND_PREFERENCES: { 204 bindPreferences(); 205 } break; 206 case MSG_BUILD_HEADERS: { 207 ArrayList<Header> oldHeaders = new ArrayList<Header>(mHeaders); 208 mHeaders.clear(); 209 onBuildHeaders(mHeaders); 210 if (mAdapter != null) { 211 mAdapter.notifyDataSetChanged(); 212 } 213 Header header = onGetNewHeader(); 214 if (header != null && header.fragment != null) { 215 Header mappedHeader = findBestMatchingHeader(header, oldHeaders); 216 if (mappedHeader == null || mCurHeader != mappedHeader) { 217 switchToHeader(header); 218 } 219 } else if (mCurHeader != null) { 220 Header mappedHeader = findBestMatchingHeader(mCurHeader, mHeaders); 221 if (mappedHeader != null) { 222 setSelectedHeader(mappedHeader); 223 } 224 } 225 } break; 226 } 227 } 228 }; 229 230 private static class HeaderAdapter extends ArrayAdapter<Header> { 231 private static class HeaderViewHolder { 232 ImageView icon; 233 TextView title; 234 TextView summary; 235 } 236 237 private LayoutInflater mInflater; 238 239 public HeaderAdapter(Context context, List<Header> objects) { 240 super(context, 0, objects); 241 mInflater = (LayoutInflater)context.getSystemService(Context.LAYOUT_INFLATER_SERVICE); 242 } 243 244 @Override 245 public View getView(int position, View convertView, ViewGroup parent) { 246 HeaderViewHolder holder; 247 View view; 248 249 if (convertView == null) { 250 view = mInflater.inflate(com.android.internal.R.layout.preference_header_item, 251 parent, false); 252 holder = new HeaderViewHolder(); 253 holder.icon = (ImageView) view.findViewById(com.android.internal.R.id.icon); 254 holder.title = (TextView) view.findViewById(com.android.internal.R.id.title); 255 holder.summary = (TextView) view.findViewById(com.android.internal.R.id.summary); 256 view.setTag(holder); 257 } else { 258 view = convertView; 259 holder = (HeaderViewHolder) view.getTag(); 260 } 261 262 // All view fields must be updated every time, because the view may be recycled 263 Header header = getItem(position); 264 holder.icon.setImageResource(header.iconRes); 265 holder.title.setText(header.getTitle(getContext().getResources())); 266 CharSequence summary = header.getSummary(getContext().getResources()); 267 if (!TextUtils.isEmpty(summary)) { 268 holder.summary.setVisibility(View.VISIBLE); 269 holder.summary.setText(summary); 270 } else { 271 holder.summary.setVisibility(View.GONE); 272 } 273 274 return view; 275 } 276 } 277 278 /** 279 * Default value for {@link Header#id Header.id} indicating that no 280 * identifier value is set. All other values (including those below -1) 281 * are valid. 282 */ 283 public static final long HEADER_ID_UNDEFINED = -1; 284 285 /** 286 * Description of a single Header item that the user can select. 287 */ 288 public static final class Header implements Parcelable { 289 /** 290 * Identifier for this header, to correlate with a new list when 291 * it is updated. The default value is 292 * {@link PreferenceActivity#HEADER_ID_UNDEFINED}, meaning no id. 293 * @attr ref android.R.styleable#PreferenceHeader_id 294 */ 295 public long id = HEADER_ID_UNDEFINED; 296 297 /** 298 * Resource ID of title of the header that is shown to the user. 299 * @attr ref android.R.styleable#PreferenceHeader_title 300 */ 301 public int titleRes; 302 303 /** 304 * Title of the header that is shown to the user. 305 * @attr ref android.R.styleable#PreferenceHeader_title 306 */ 307 public CharSequence title; 308 309 /** 310 * Resource ID of optional summary describing what this header controls. 311 * @attr ref android.R.styleable#PreferenceHeader_summary 312 */ 313 public int summaryRes; 314 315 /** 316 * Optional summary describing what this header controls. 317 * @attr ref android.R.styleable#PreferenceHeader_summary 318 */ 319 public CharSequence summary; 320 321 /** 322 * Resource ID of optional text to show as the title in the bread crumb. 323 * @attr ref android.R.styleable#PreferenceHeader_breadCrumbTitle 324 */ 325 public int breadCrumbTitleRes; 326 327 /** 328 * Optional text to show as the title in the bread crumb. 329 * @attr ref android.R.styleable#PreferenceHeader_breadCrumbTitle 330 */ 331 public CharSequence breadCrumbTitle; 332 333 /** 334 * Resource ID of optional text to show as the short title in the bread crumb. 335 * @attr ref android.R.styleable#PreferenceHeader_breadCrumbShortTitle 336 */ 337 public int breadCrumbShortTitleRes; 338 339 /** 340 * Optional text to show as the short title in the bread crumb. 341 * @attr ref android.R.styleable#PreferenceHeader_breadCrumbShortTitle 342 */ 343 public CharSequence breadCrumbShortTitle; 344 345 /** 346 * Optional icon resource to show for this header. 347 * @attr ref android.R.styleable#PreferenceHeader_icon 348 */ 349 public int iconRes; 350 351 /** 352 * Full class name of the fragment to display when this header is 353 * selected. 354 * @attr ref android.R.styleable#PreferenceHeader_fragment 355 */ 356 public String fragment; 357 358 /** 359 * Optional arguments to supply to the fragment when it is 360 * instantiated. 361 */ 362 public Bundle fragmentArguments; 363 364 /** 365 * Intent to launch when the preference is selected. 366 */ 367 public Intent intent; 368 369 /** 370 * Optional additional data for use by subclasses of PreferenceActivity. 371 */ 372 public Bundle extras; 373 374 public Header() { 375 } 376 377 /** 378 * Return the currently set title. If {@link #titleRes} is set, 379 * this resource is loaded from <var>res</var> and returned. Otherwise 380 * {@link #title} is returned. 381 */ 382 public CharSequence getTitle(Resources res) { 383 if (titleRes != 0) { 384 return res.getText(titleRes); 385 } 386 return title; 387 } 388 389 /** 390 * Return the currently set summary. If {@link #summaryRes} is set, 391 * this resource is loaded from <var>res</var> and returned. Otherwise 392 * {@link #summary} is returned. 393 */ 394 public CharSequence getSummary(Resources res) { 395 if (summaryRes != 0) { 396 return res.getText(summaryRes); 397 } 398 return summary; 399 } 400 401 /** 402 * Return the currently set bread crumb title. If {@link #breadCrumbTitleRes} is set, 403 * this resource is loaded from <var>res</var> and returned. Otherwise 404 * {@link #breadCrumbTitle} is returned. 405 */ 406 public CharSequence getBreadCrumbTitle(Resources res) { 407 if (breadCrumbTitleRes != 0) { 408 return res.getText(breadCrumbTitleRes); 409 } 410 return breadCrumbTitle; 411 } 412 413 /** 414 * Return the currently set bread crumb short title. If 415 * {@link #breadCrumbShortTitleRes} is set, 416 * this resource is loaded from <var>res</var> and returned. Otherwise 417 * {@link #breadCrumbShortTitle} is returned. 418 */ 419 public CharSequence getBreadCrumbShortTitle(Resources res) { 420 if (breadCrumbShortTitleRes != 0) { 421 return res.getText(breadCrumbShortTitleRes); 422 } 423 return breadCrumbShortTitle; 424 } 425 426 @Override 427 public int describeContents() { 428 return 0; 429 } 430 431 @Override 432 public void writeToParcel(Parcel dest, int flags) { 433 dest.writeLong(id); 434 dest.writeInt(titleRes); 435 TextUtils.writeToParcel(title, dest, flags); 436 dest.writeInt(summaryRes); 437 TextUtils.writeToParcel(summary, dest, flags); 438 dest.writeInt(breadCrumbTitleRes); 439 TextUtils.writeToParcel(breadCrumbTitle, dest, flags); 440 dest.writeInt(breadCrumbShortTitleRes); 441 TextUtils.writeToParcel(breadCrumbShortTitle, dest, flags); 442 dest.writeInt(iconRes); 443 dest.writeString(fragment); 444 dest.writeBundle(fragmentArguments); 445 if (intent != null) { 446 dest.writeInt(1); 447 intent.writeToParcel(dest, flags); 448 } else { 449 dest.writeInt(0); 450 } 451 dest.writeBundle(extras); 452 } 453 454 public void readFromParcel(Parcel in) { 455 id = in.readLong(); 456 titleRes = in.readInt(); 457 title = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 458 summaryRes = in.readInt(); 459 summary = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 460 breadCrumbTitleRes = in.readInt(); 461 breadCrumbTitle = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 462 breadCrumbShortTitleRes = in.readInt(); 463 breadCrumbShortTitle = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 464 iconRes = in.readInt(); 465 fragment = in.readString(); 466 fragmentArguments = in.readBundle(); 467 if (in.readInt() != 0) { 468 intent = Intent.CREATOR.createFromParcel(in); 469 } 470 extras = in.readBundle(); 471 } 472 473 Header(Parcel in) { 474 readFromParcel(in); 475 } 476 477 public static final Creator<Header> CREATOR = new Creator<Header>() { 478 public Header createFromParcel(Parcel source) { 479 return new Header(source); 480 } 481 public Header[] newArray(int size) { 482 return new Header[size]; 483 } 484 }; 485 } 486 487 @Override 488 protected void onCreate(Bundle savedInstanceState) { 489 super.onCreate(savedInstanceState); 490 491 setContentView(com.android.internal.R.layout.preference_list_content); 492 493 mListFooter = (FrameLayout)findViewById(com.android.internal.R.id.list_footer); 494 mPrefsContainer = (ViewGroup) findViewById(com.android.internal.R.id.prefs_frame); 495 boolean hidingHeaders = onIsHidingHeaders(); 496 mSinglePane = hidingHeaders || !onIsMultiPane(); 497 String initialFragment = getIntent().getStringExtra(EXTRA_SHOW_FRAGMENT); 498 Bundle initialArguments = getIntent().getBundleExtra(EXTRA_SHOW_FRAGMENT_ARGUMENTS); 499 500 if (savedInstanceState != null) { 501 // We are restarting from a previous saved state; used that to 502 // initialize, instead of starting fresh. 503 ArrayList<Header> headers = savedInstanceState.getParcelableArrayList(HEADERS_TAG); 504 if (headers != null) { 505 mHeaders.addAll(headers); 506 int curHeader = savedInstanceState.getInt(CUR_HEADER_TAG, 507 (int)HEADER_ID_UNDEFINED); 508 if (curHeader >= 0 && curHeader < mHeaders.size()) { 509 setSelectedHeader(mHeaders.get(curHeader)); 510 } 511 } 512 513 } else { 514 if (initialFragment != null && mSinglePane) { 515 // If we are just showing a fragment, we want to run in 516 // new fragment mode, but don't need to compute and show 517 // the headers. 518 switchToHeader(initialFragment, initialArguments); 519 520 } else { 521 // We need to try to build the headers. 522 onBuildHeaders(mHeaders); 523 524 // If there are headers, then at this point we need to show 525 // them and, depending on the screen, we may also show in-line 526 // the currently selected preference fragment. 527 if (mHeaders.size() > 0) { 528 if (!mSinglePane) { 529 if (initialFragment == null) { 530 Header h = onGetInitialHeader(); 531 switchToHeader(h); 532 } else { 533 switchToHeader(initialFragment, initialArguments); 534 } 535 } 536 } 537 } 538 } 539 540 // The default configuration is to only show the list view. Adjust 541 // visibility for other configurations. 542 if (initialFragment != null && mSinglePane) { 543 // Single pane, showing just a prefs fragment. 544 findViewById(com.android.internal.R.id.headers).setVisibility(View.GONE); 545 mPrefsContainer.setVisibility(View.VISIBLE); 546 } else if (mHeaders.size() > 0) { 547 mAdapter = new HeaderAdapter(this, mHeaders); 548 setListAdapter(mAdapter); 549 if (!mSinglePane) { 550 // Multi-pane. 551 getListView().setChoiceMode(AbsListView.CHOICE_MODE_SINGLE); 552 if (mCurHeader != null) { 553 setSelectedHeader(mCurHeader); 554 } 555 mPrefsContainer.setVisibility(View.VISIBLE); 556 } 557 } else { 558 // If there are no headers, we are in the old "just show a screen 559 // of preferences" mode. 560 setContentView(com.android.internal.R.layout.preference_list_content_single); 561 mListFooter = (FrameLayout) findViewById(com.android.internal.R.id.list_footer); 562 mPrefsContainer = (ViewGroup) findViewById(com.android.internal.R.id.prefs); 563 mPreferenceManager = new PreferenceManager(this, FIRST_REQUEST_CODE); 564 mPreferenceManager.setOnPreferenceTreeClickListener(this); 565 } 566 567 getListView().setScrollBarStyle(View.SCROLLBARS_INSIDE_OVERLAY); 568 569 // see if we should show Back/Next buttons 570 Intent intent = getIntent(); 571 if (intent.getBooleanExtra(EXTRA_PREFS_SHOW_BUTTON_BAR, false)) { 572 573 findViewById(com.android.internal.R.id.button_bar).setVisibility(View.VISIBLE); 574 575 Button backButton = (Button)findViewById(com.android.internal.R.id.back_button); 576 backButton.setOnClickListener(new OnClickListener() { 577 public void onClick(View v) { 578 setResult(RESULT_CANCELED); 579 finish(); 580 } 581 }); 582 Button skipButton = (Button)findViewById(com.android.internal.R.id.skip_button); 583 skipButton.setOnClickListener(new OnClickListener() { 584 public void onClick(View v) { 585 setResult(RESULT_OK); 586 finish(); 587 } 588 }); 589 mNextButton = (Button)findViewById(com.android.internal.R.id.next_button); 590 mNextButton.setOnClickListener(new OnClickListener() { 591 public void onClick(View v) { 592 setResult(RESULT_OK); 593 finish(); 594 } 595 }); 596 597 // set our various button parameters 598 if (intent.hasExtra(EXTRA_PREFS_SET_NEXT_TEXT)) { 599 String buttonText = intent.getStringExtra(EXTRA_PREFS_SET_NEXT_TEXT); 600 if (TextUtils.isEmpty(buttonText)) { 601 mNextButton.setVisibility(View.GONE); 602 } 603 else { 604 mNextButton.setText(buttonText); 605 } 606 } 607 if (intent.hasExtra(EXTRA_PREFS_SET_BACK_TEXT)) { 608 String buttonText = intent.getStringExtra(EXTRA_PREFS_SET_BACK_TEXT); 609 if (TextUtils.isEmpty(buttonText)) { 610 backButton.setVisibility(View.GONE); 611 } 612 else { 613 backButton.setText(buttonText); 614 } 615 } 616 if (intent.getBooleanExtra(EXTRA_PREFS_SHOW_SKIP, false)) { 617 skipButton.setVisibility(View.VISIBLE); 618 } 619 } 620 } 621 622 /** 623 * Returns true if this activity is currently showing the header list. 624 */ 625 public boolean hasHeaders() { 626 return getListView().getVisibility() == View.VISIBLE 627 && mPreferenceManager == null; 628 } 629 630 /** 631 * Returns true if this activity is showing multiple panes -- the headers 632 * and a preference fragment. 633 */ 634 public boolean isMultiPane() { 635 return hasHeaders() && mPrefsContainer.getVisibility() == View.VISIBLE; 636 } 637 638 /** 639 * Called to determine if the activity should run in multi-pane mode. 640 * The default implementation returns true if the screen is large 641 * enough. 642 */ 643 public boolean onIsMultiPane() { 644 Configuration config = getResources().getConfiguration(); 645 if ((config.screenLayout&Configuration.SCREENLAYOUT_SIZE_MASK) 646 == Configuration.SCREENLAYOUT_SIZE_XLARGE) { 647 return true; 648 } 649 if ((config.screenLayout&Configuration.SCREENLAYOUT_SIZE_MASK) 650 == Configuration.SCREENLAYOUT_SIZE_LARGE 651 && config.orientation == Configuration.ORIENTATION_LANDSCAPE) { 652 return true; 653 } 654 return false; 655 } 656 657 /** 658 * Called to determine whether the header list should be hidden. 659 * The default implementation returns the 660 * value given in {@link #EXTRA_NO_HEADERS} or false if it is not supplied. 661 * This is set to false, for example, when the activity is being re-launched 662 * to show a particular preference activity. 663 */ 664 public boolean onIsHidingHeaders() { 665 return getIntent().getBooleanExtra(EXTRA_NO_HEADERS, false); 666 } 667 668 /** 669 * Called to determine the initial header to be shown. The default 670 * implementation simply returns the fragment of the first header. Note 671 * that the returned Header object does not actually need to exist in 672 * your header list -- whatever its fragment is will simply be used to 673 * show for the initial UI. 674 */ 675 public Header onGetInitialHeader() { 676 return mHeaders.get(0); 677 } 678 679 /** 680 * Called after the header list has been updated ({@link #onBuildHeaders} 681 * has been called and returned due to {@link #invalidateHeaders()}) to 682 * specify the header that should now be selected. The default implementation 683 * returns null to keep whatever header is currently selected. 684 */ 685 public Header onGetNewHeader() { 686 return null; 687 } 688 689 /** 690 * Called when the activity needs its list of headers build. By 691 * implementing this and adding at least one item to the list, you 692 * will cause the activity to run in its modern fragment mode. Note 693 * that this function may not always be called; for example, if the 694 * activity has been asked to display a particular fragment without 695 * the header list, there is no need to build the headers. 696 * 697 * <p>Typical implementations will use {@link #loadHeadersFromResource} 698 * to fill in the list from a resource. 699 * 700 * @param target The list in which to place the headers. 701 */ 702 public void onBuildHeaders(List<Header> target) { 703 } 704 705 /** 706 * Call when you need to change the headers being displayed. Will result 707 * in onBuildHeaders() later being called to retrieve the new list. 708 */ 709 public void invalidateHeaders() { 710 if (!mHandler.hasMessages(MSG_BUILD_HEADERS)) { 711 mHandler.sendEmptyMessage(MSG_BUILD_HEADERS); 712 } 713 } 714 715 /** 716 * Parse the given XML file as a header description, adding each 717 * parsed Header into the target list. 718 * 719 * @param resid The XML resource to load and parse. 720 * @param target The list in which the parsed headers should be placed. 721 */ 722 public void loadHeadersFromResource(int resid, List<Header> target) { 723 XmlResourceParser parser = null; 724 try { 725 parser = getResources().getXml(resid); 726 AttributeSet attrs = Xml.asAttributeSet(parser); 727 728 int type; 729 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT 730 && type != XmlPullParser.START_TAG) { 731 } 732 733 String nodeName = parser.getName(); 734 if (!"preference-headers".equals(nodeName)) { 735 throw new RuntimeException( 736 "XML document must start with <preference-headers> tag; found" 737 + nodeName + " at " + parser.getPositionDescription()); 738 } 739 740 Bundle curBundle = null; 741 742 final int outerDepth = parser.getDepth(); 743 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT 744 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) { 745 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) { 746 continue; 747 } 748 749 nodeName = parser.getName(); 750 if ("header".equals(nodeName)) { 751 Header header = new Header(); 752 753 TypedArray sa = getResources().obtainAttributes(attrs, 754 com.android.internal.R.styleable.PreferenceHeader); 755 header.id = sa.getResourceId( 756 com.android.internal.R.styleable.PreferenceHeader_id, 757 (int)HEADER_ID_UNDEFINED); 758 TypedValue tv = sa.peekValue( 759 com.android.internal.R.styleable.PreferenceHeader_title); 760 if (tv != null && tv.type == TypedValue.TYPE_STRING) { 761 if (tv.resourceId != 0) { 762 header.titleRes = tv.resourceId; 763 } else { 764 header.title = tv.string; 765 } 766 } 767 tv = sa.peekValue( 768 com.android.internal.R.styleable.PreferenceHeader_summary); 769 if (tv != null && tv.type == TypedValue.TYPE_STRING) { 770 if (tv.resourceId != 0) { 771 header.summaryRes = tv.resourceId; 772 } else { 773 header.summary = tv.string; 774 } 775 } 776 tv = sa.peekValue( 777 com.android.internal.R.styleable.PreferenceHeader_breadCrumbTitle); 778 if (tv != null && tv.type == TypedValue.TYPE_STRING) { 779 if (tv.resourceId != 0) { 780 header.breadCrumbTitleRes = tv.resourceId; 781 } else { 782 header.breadCrumbTitle = tv.string; 783 } 784 } 785 tv = sa.peekValue( 786 com.android.internal.R.styleable.PreferenceHeader_breadCrumbShortTitle); 787 if (tv != null && tv.type == TypedValue.TYPE_STRING) { 788 if (tv.resourceId != 0) { 789 header.breadCrumbShortTitleRes = tv.resourceId; 790 } else { 791 header.breadCrumbShortTitle = tv.string; 792 } 793 } 794 header.iconRes = sa.getResourceId( 795 com.android.internal.R.styleable.PreferenceHeader_icon, 0); 796 header.fragment = sa.getString( 797 com.android.internal.R.styleable.PreferenceHeader_fragment); 798 sa.recycle(); 799 800 if (curBundle == null) { 801 curBundle = new Bundle(); 802 } 803 804 final int innerDepth = parser.getDepth(); 805 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT 806 && (type != XmlPullParser.END_TAG || parser.getDepth() > innerDepth)) { 807 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) { 808 continue; 809 } 810 811 String innerNodeName = parser.getName(); 812 if (innerNodeName.equals("extra")) { 813 getResources().parseBundleExtra("extra", attrs, curBundle); 814 XmlUtils.skipCurrentTag(parser); 815 816 } else if (innerNodeName.equals("intent")) { 817 header.intent = Intent.parseIntent(getResources(), parser, attrs); 818 819 } else { 820 XmlUtils.skipCurrentTag(parser); 821 } 822 } 823 824 if (curBundle.size() > 0) { 825 header.fragmentArguments = curBundle; 826 curBundle = null; 827 } 828 829 target.add(header); 830 } else { 831 XmlUtils.skipCurrentTag(parser); 832 } 833 } 834 835 } catch (XmlPullParserException e) { 836 throw new RuntimeException("Error parsing headers", e); 837 } catch (IOException e) { 838 throw new RuntimeException("Error parsing headers", e); 839 } finally { 840 if (parser != null) parser.close(); 841 } 842 843 } 844 845 /** 846 * Set a footer that should be shown at the bottom of the header list. 847 */ 848 public void setListFooter(View view) { 849 mListFooter.removeAllViews(); 850 mListFooter.addView(view, new FrameLayout.LayoutParams( 851 FrameLayout.LayoutParams.MATCH_PARENT, 852 FrameLayout.LayoutParams.WRAP_CONTENT)); 853 } 854 855 @Override 856 protected void onStop() { 857 super.onStop(); 858 859 if (mPreferenceManager != null) { 860 mPreferenceManager.dispatchActivityStop(); 861 } 862 } 863 864 @Override 865 protected void onDestroy() { 866 super.onDestroy(); 867 868 if (mPreferenceManager != null) { 869 mPreferenceManager.dispatchActivityDestroy(); 870 } 871 } 872 873 @Override 874 protected void onSaveInstanceState(Bundle outState) { 875 super.onSaveInstanceState(outState); 876 877 if (mHeaders.size() > 0) { 878 outState.putParcelableArrayList(HEADERS_TAG, mHeaders); 879 if (mCurHeader != null) { 880 int index = mHeaders.indexOf(mCurHeader); 881 if (index >= 0) { 882 outState.putInt(CUR_HEADER_TAG, index); 883 } 884 } 885 } 886 887 if (mPreferenceManager != null) { 888 final PreferenceScreen preferenceScreen = getPreferenceScreen(); 889 if (preferenceScreen != null) { 890 Bundle container = new Bundle(); 891 preferenceScreen.saveHierarchyState(container); 892 outState.putBundle(PREFERENCES_TAG, container); 893 } 894 } 895 } 896 897 @Override 898 protected void onRestoreInstanceState(Bundle state) { 899 if (mPreferenceManager != null) { 900 Bundle container = state.getBundle(PREFERENCES_TAG); 901 if (container != null) { 902 final PreferenceScreen preferenceScreen = getPreferenceScreen(); 903 if (preferenceScreen != null) { 904 preferenceScreen.restoreHierarchyState(container); 905 mSavedInstanceState = state; 906 return; 907 } 908 } 909 } 910 911 // Only call this if we didn't save the instance state for later. 912 // If we did save it, it will be restored when we bind the adapter. 913 super.onRestoreInstanceState(state); 914 } 915 916 @Override 917 protected void onActivityResult(int requestCode, int resultCode, Intent data) { 918 super.onActivityResult(requestCode, resultCode, data); 919 920 if (mPreferenceManager != null) { 921 mPreferenceManager.dispatchActivityResult(requestCode, resultCode, data); 922 } 923 } 924 925 @Override 926 public void onContentChanged() { 927 super.onContentChanged(); 928 929 if (mPreferenceManager != null) { 930 postBindPreferences(); 931 } 932 } 933 934 @Override 935 protected void onListItemClick(ListView l, View v, int position, long id) { 936 super.onListItemClick(l, v, position, id); 937 938 if (mAdapter != null) { 939 onHeaderClick(mHeaders.get(position), position); 940 } 941 } 942 943 /** 944 * Called when the user selects an item in the header list. The default 945 * implementation will call either {@link #startWithFragment(String, Bundle, Fragment, int)} 946 * or {@link #switchToHeader(Header)} as appropriate. 947 * 948 * @param header The header that was selected. 949 * @param position The header's position in the list. 950 */ 951 public void onHeaderClick(Header header, int position) { 952 if (header.fragment != null) { 953 if (mSinglePane) { 954 startWithFragment(header.fragment, header.fragmentArguments, null, 0); 955 } else { 956 switchToHeader(header); 957 } 958 } else if (header.intent != null) { 959 startActivity(header.intent); 960 } 961 } 962 963 /** 964 * Called by {@link #startWithFragment(String, Bundle, Fragment, int)} when 965 * in single-pane mode, to build an Intent to launch a new activity showing 966 * the selected fragment. The default implementation constructs an Intent 967 * that re-launches the current activity with the appropriate arguments to 968 * display the fragment. 969 * 970 * @param fragmentName The name of the fragment to display. 971 * @param args Optional arguments to supply to the fragment. 972 * @return Returns an Intent that can be launched to display the given 973 * fragment. 974 */ 975 public Intent onBuildStartFragmentIntent(String fragmentName, Bundle args) { 976 Intent intent = new Intent(Intent.ACTION_MAIN); 977 intent.setClass(this, getClass()); 978 intent.putExtra(EXTRA_SHOW_FRAGMENT, fragmentName); 979 intent.putExtra(EXTRA_SHOW_FRAGMENT_ARGUMENTS, args); 980 intent.putExtra(EXTRA_NO_HEADERS, true); 981 return intent; 982 } 983 984 /** 985 * Start a new instance of this activity, showing only the given 986 * preference fragment. When launched in this mode, the header list 987 * will be hidden and the given preference fragment will be instantiated 988 * and fill the entire activity. 989 * 990 * @param fragmentName The name of the fragment to display. 991 * @param args Optional arguments to supply to the fragment. 992 * @param resultTo Option fragment that should receive the result of 993 * the activity launch. 994 * @param resultRequestCode If resultTo is non-null, this is the request 995 * code in which to report the result. 996 */ 997 public void startWithFragment(String fragmentName, Bundle args, 998 Fragment resultTo, int resultRequestCode) { 999 Intent intent = onBuildStartFragmentIntent(fragmentName, args); 1000 if (resultTo == null) { 1001 startActivity(intent); 1002 } else { 1003 resultTo.startActivityForResult(intent, resultRequestCode); 1004 } 1005 } 1006 1007 /** 1008 * Change the base title of the bread crumbs for the current preferences. 1009 * This will normally be called for you. See 1010 * {@link android.app.FragmentBreadCrumbs} for more information. 1011 */ 1012 public void showBreadCrumbs(CharSequence title, CharSequence shortTitle) { 1013 if (mFragmentBreadCrumbs == null) { 1014 View crumbs = findViewById(android.R.id.title); 1015 // For screens with a different kind of title, don't create breadcrumbs. 1016 if (!(crumbs instanceof FragmentBreadCrumbs)) return; 1017 mFragmentBreadCrumbs = (FragmentBreadCrumbs) findViewById(android.R.id.title); 1018 if (mFragmentBreadCrumbs == null) { 1019 mFragmentBreadCrumbs = new FragmentBreadCrumbs(this); 1020 ActionBar actionBar = getActionBar(); 1021 if (actionBar != null) { 1022 actionBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM, 1023 ActionBar.DISPLAY_SHOW_TITLE | ActionBar.DISPLAY_SHOW_CUSTOM); 1024 actionBar.setCustomView(mFragmentBreadCrumbs); 1025 } 1026 } 1027 mFragmentBreadCrumbs.setMaxVisible(2); 1028 mFragmentBreadCrumbs.setActivity(this); 1029 } 1030 mFragmentBreadCrumbs.setTitle(title, shortTitle); 1031 mFragmentBreadCrumbs.setParentTitle(null, null, null); 1032 } 1033 1034 /** 1035 * Should be called after onCreate to ensure that the breadcrumbs, if any, were created. 1036 * This prepends a title to the fragment breadcrumbs and attaches a listener to any clicks 1037 * on the parent entry. 1038 * @param title the title for the breadcrumb 1039 * @param shortTitle the short title for the breadcrumb 1040 */ 1041 public void setParentTitle(CharSequence title, CharSequence shortTitle, 1042 OnClickListener listener) { 1043 if (mFragmentBreadCrumbs != null) { 1044 mFragmentBreadCrumbs.setParentTitle(title, shortTitle, listener); 1045 } 1046 } 1047 1048 void setSelectedHeader(Header header) { 1049 mCurHeader = header; 1050 int index = mHeaders.indexOf(header); 1051 if (index >= 0) { 1052 getListView().setItemChecked(index, true); 1053 } else { 1054 getListView().clearChoices(); 1055 } 1056 if (header != null) { 1057 CharSequence title = header.getBreadCrumbTitle(getResources()); 1058 if (title == null) title = header.getTitle(getResources()); 1059 if (title == null) title = getTitle(); 1060 showBreadCrumbs(title, header.getBreadCrumbShortTitle(getResources())); 1061 } else { 1062 showBreadCrumbs(getTitle(), null); 1063 } 1064 } 1065 1066 private void switchToHeaderInner(String fragmentName, Bundle args, int direction) { 1067 getFragmentManager().popBackStack(BACK_STACK_PREFS, 1068 FragmentManager.POP_BACK_STACK_INCLUSIVE); 1069 Fragment f = Fragment.instantiate(this, fragmentName, args); 1070 FragmentTransaction transaction = getFragmentManager().beginTransaction(); 1071 transaction.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_FADE); 1072 transaction.replace(com.android.internal.R.id.prefs, f); 1073 transaction.commitAllowingStateLoss(); 1074 } 1075 1076 /** 1077 * When in two-pane mode, switch the fragment pane to show the given 1078 * preference fragment. 1079 * 1080 * @param fragmentName The name of the fragment to display. 1081 * @param args Optional arguments to supply to the fragment. 1082 */ 1083 public void switchToHeader(String fragmentName, Bundle args) { 1084 setSelectedHeader(null); 1085 switchToHeaderInner(fragmentName, args, 0); 1086 } 1087 1088 /** 1089 * When in two-pane mode, switch to the fragment pane to show the given 1090 * preference fragment. 1091 * 1092 * @param header The new header to display. 1093 */ 1094 public void switchToHeader(Header header) { 1095 if (mCurHeader == header) { 1096 // This is the header we are currently displaying. Just make sure 1097 // to pop the stack up to its root state. 1098 getFragmentManager().popBackStack(BACK_STACK_PREFS, 1099 FragmentManager.POP_BACK_STACK_INCLUSIVE); 1100 } else { 1101 int direction = mHeaders.indexOf(header) - mHeaders.indexOf(mCurHeader); 1102 switchToHeaderInner(header.fragment, header.fragmentArguments, direction); 1103 setSelectedHeader(header); 1104 } 1105 } 1106 1107 Header findBestMatchingHeader(Header cur, ArrayList<Header> from) { 1108 ArrayList<Header> matches = new ArrayList<Header>(); 1109 for (int j=0; j<from.size(); j++) { 1110 Header oh = from.get(j); 1111 if (cur == oh || (cur.id != HEADER_ID_UNDEFINED && cur.id == oh.id)) { 1112 // Must be this one. 1113 matches.clear(); 1114 matches.add(oh); 1115 break; 1116 } 1117 if (cur.fragment != null) { 1118 if (cur.fragment.equals(oh.fragment)) { 1119 matches.add(oh); 1120 } 1121 } else if (cur.intent != null) { 1122 if (cur.intent.equals(oh.intent)) { 1123 matches.add(oh); 1124 } 1125 } else if (cur.title != null) { 1126 if (cur.title.equals(oh.title)) { 1127 matches.add(oh); 1128 } 1129 } 1130 } 1131 final int NM = matches.size(); 1132 if (NM == 1) { 1133 return matches.get(0); 1134 } else if (NM > 1) { 1135 for (int j=0; j<NM; j++) { 1136 Header oh = matches.get(j); 1137 if (cur.fragmentArguments != null && 1138 cur.fragmentArguments.equals(oh.fragmentArguments)) { 1139 return oh; 1140 } 1141 if (cur.extras != null && cur.extras.equals(oh.extras)) { 1142 return oh; 1143 } 1144 if (cur.title != null && cur.title.equals(oh.title)) { 1145 return oh; 1146 } 1147 } 1148 } 1149 return null; 1150 } 1151 1152 /** 1153 * Start a new fragment. 1154 * 1155 * @param fragment The fragment to start 1156 * @param push If true, the current fragment will be pushed onto the back stack. If false, 1157 * the current fragment will be replaced. 1158 */ 1159 public void startPreferenceFragment(Fragment fragment, boolean push) { 1160 FragmentTransaction transaction = getFragmentManager().beginTransaction(); 1161 transaction.replace(com.android.internal.R.id.prefs, fragment); 1162 if (push) { 1163 transaction.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_OPEN); 1164 transaction.addToBackStack(BACK_STACK_PREFS); 1165 } else { 1166 transaction.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_FADE); 1167 } 1168 transaction.commitAllowingStateLoss(); 1169 } 1170 1171 /** 1172 * Start a new fragment containing a preference panel. If the prefences 1173 * are being displayed in multi-pane mode, the given fragment class will 1174 * be instantiated and placed in the appropriate pane. If running in 1175 * single-pane mode, a new activity will be launched in which to show the 1176 * fragment. 1177 * 1178 * @param fragmentClass Full name of the class implementing the fragment. 1179 * @param args Any desired arguments to supply to the fragment. 1180 * @param titleRes Optional resource identifier of the title of this 1181 * fragment. 1182 * @param titleText Optional text of the title of this fragment. 1183 * @param resultTo Optional fragment that result data should be sent to. 1184 * If non-null, resultTo.onActivityResult() will be called when this 1185 * preference panel is done. The launched panel must use 1186 * {@link #finishPreferencePanel(Fragment, int, Intent)} when done. 1187 * @param resultRequestCode If resultTo is non-null, this is the caller's 1188 * request code to be received with the resut. 1189 */ 1190 public void startPreferencePanel(String fragmentClass, Bundle args, int titleRes, 1191 CharSequence titleText, Fragment resultTo, int resultRequestCode) { 1192 if (mSinglePane) { 1193 startWithFragment(fragmentClass, args, resultTo, resultRequestCode); 1194 } else { 1195 Fragment f = Fragment.instantiate(this, fragmentClass, args); 1196 if (resultTo != null) { 1197 f.setTargetFragment(resultTo, resultRequestCode); 1198 } 1199 FragmentTransaction transaction = getFragmentManager().beginTransaction(); 1200 transaction.replace(com.android.internal.R.id.prefs, f); 1201 if (titleRes != 0) { 1202 transaction.setBreadCrumbTitle(titleRes); 1203 } else if (titleText != null) { 1204 transaction.setBreadCrumbTitle(titleText); 1205 } 1206 transaction.setTransition(FragmentTransaction.TRANSIT_FRAGMENT_OPEN); 1207 transaction.addToBackStack(BACK_STACK_PREFS); 1208 transaction.commitAllowingStateLoss(); 1209 } 1210 } 1211 1212 /** 1213 * Called by a preference panel fragment to finish itself. 1214 * 1215 * @param caller The fragment that is asking to be finished. 1216 * @param resultCode Optional result code to send back to the original 1217 * launching fragment. 1218 * @param resultData Optional result data to send back to the original 1219 * launching fragment. 1220 */ 1221 public void finishPreferencePanel(Fragment caller, int resultCode, Intent resultData) { 1222 if (mSinglePane) { 1223 setResult(resultCode, resultData); 1224 finish(); 1225 } else { 1226 // XXX be smarter about popping the stack. 1227 onBackPressed(); 1228 if (caller != null) { 1229 if (caller.getTargetFragment() != null) { 1230 caller.getTargetFragment().onActivityResult(caller.getTargetRequestCode(), 1231 resultCode, resultData); 1232 } 1233 } 1234 } 1235 } 1236 1237 @Override 1238 public boolean onPreferenceStartFragment(PreferenceFragment caller, Preference pref) { 1239 startPreferencePanel(pref.getFragment(), pref.getExtras(), 0, pref.getTitle(), null, 0); 1240 return true; 1241 } 1242 1243 /** 1244 * Posts a message to bind the preferences to the list view. 1245 * <p> 1246 * Binding late is preferred as any custom preference types created in 1247 * {@link #onCreate(Bundle)} are able to have their views recycled. 1248 */ 1249 private void postBindPreferences() { 1250 if (mHandler.hasMessages(MSG_BIND_PREFERENCES)) return; 1251 mHandler.obtainMessage(MSG_BIND_PREFERENCES).sendToTarget(); 1252 } 1253 1254 private void bindPreferences() { 1255 final PreferenceScreen preferenceScreen = getPreferenceScreen(); 1256 if (preferenceScreen != null) { 1257 preferenceScreen.bind(getListView()); 1258 if (mSavedInstanceState != null) { 1259 super.onRestoreInstanceState(mSavedInstanceState); 1260 mSavedInstanceState = null; 1261 } 1262 } 1263 } 1264 1265 /** 1266 * Returns the {@link PreferenceManager} used by this activity. 1267 * @return The {@link PreferenceManager}. 1268 * 1269 * @deprecated This function is not relevant for a modern fragment-based 1270 * PreferenceActivity. 1271 */ 1272 @Deprecated 1273 public PreferenceManager getPreferenceManager() { 1274 return mPreferenceManager; 1275 } 1276 1277 private void requirePreferenceManager() { 1278 if (mPreferenceManager == null) { 1279 if (mAdapter == null) { 1280 throw new RuntimeException("This should be called after super.onCreate."); 1281 } 1282 throw new RuntimeException( 1283 "Modern two-pane PreferenceActivity requires use of a PreferenceFragment"); 1284 } 1285 } 1286 1287 /** 1288 * Sets the root of the preference hierarchy that this activity is showing. 1289 * 1290 * @param preferenceScreen The root {@link PreferenceScreen} of the preference hierarchy. 1291 * 1292 * @deprecated This function is not relevant for a modern fragment-based 1293 * PreferenceActivity. 1294 */ 1295 @Deprecated 1296 public void setPreferenceScreen(PreferenceScreen preferenceScreen) { 1297 requirePreferenceManager(); 1298 1299 if (mPreferenceManager.setPreferences(preferenceScreen) && preferenceScreen != null) { 1300 postBindPreferences(); 1301 CharSequence title = getPreferenceScreen().getTitle(); 1302 // Set the title of the activity 1303 if (title != null) { 1304 setTitle(title); 1305 } 1306 } 1307 } 1308 1309 /** 1310 * Gets the root of the preference hierarchy that this activity is showing. 1311 * 1312 * @return The {@link PreferenceScreen} that is the root of the preference 1313 * hierarchy. 1314 * 1315 * @deprecated This function is not relevant for a modern fragment-based 1316 * PreferenceActivity. 1317 */ 1318 @Deprecated 1319 public PreferenceScreen getPreferenceScreen() { 1320 if (mPreferenceManager != null) { 1321 return mPreferenceManager.getPreferenceScreen(); 1322 } 1323 return null; 1324 } 1325 1326 /** 1327 * Adds preferences from activities that match the given {@link Intent}. 1328 * 1329 * @param intent The {@link Intent} to query activities. 1330 * 1331 * @deprecated This function is not relevant for a modern fragment-based 1332 * PreferenceActivity. 1333 */ 1334 @Deprecated 1335 public void addPreferencesFromIntent(Intent intent) { 1336 requirePreferenceManager(); 1337 1338 setPreferenceScreen(mPreferenceManager.inflateFromIntent(intent, getPreferenceScreen())); 1339 } 1340 1341 /** 1342 * Inflates the given XML resource and adds the preference hierarchy to the current 1343 * preference hierarchy. 1344 * 1345 * @param preferencesResId The XML resource ID to inflate. 1346 * 1347 * @deprecated This function is not relevant for a modern fragment-based 1348 * PreferenceActivity. 1349 */ 1350 @Deprecated 1351 public void addPreferencesFromResource(int preferencesResId) { 1352 requirePreferenceManager(); 1353 1354 setPreferenceScreen(mPreferenceManager.inflateFromResource(this, preferencesResId, 1355 getPreferenceScreen())); 1356 } 1357 1358 /** 1359 * {@inheritDoc} 1360 * 1361 * @deprecated This function is not relevant for a modern fragment-based 1362 * PreferenceActivity. 1363 */ 1364 @Deprecated 1365 public boolean onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference) { 1366 return false; 1367 } 1368 1369 /** 1370 * Finds a {@link Preference} based on its key. 1371 * 1372 * @param key The key of the preference to retrieve. 1373 * @return The {@link Preference} with the key, or null. 1374 * @see PreferenceGroup#findPreference(CharSequence) 1375 * 1376 * @deprecated This function is not relevant for a modern fragment-based 1377 * PreferenceActivity. 1378 */ 1379 @Deprecated 1380 public Preference findPreference(CharSequence key) { 1381 1382 if (mPreferenceManager == null) { 1383 return null; 1384 } 1385 1386 return mPreferenceManager.findPreference(key); 1387 } 1388 1389 @Override 1390 protected void onNewIntent(Intent intent) { 1391 if (mPreferenceManager != null) { 1392 mPreferenceManager.dispatchNewIntent(intent); 1393 } 1394 } 1395 1396 // give subclasses access to the Next button 1397 /** @hide */ 1398 protected boolean hasNextButton() { 1399 return mNextButton != null; 1400 } 1401 /** @hide */ 1402 protected Button getNextButton() { 1403 return mNextButton; 1404 } 1405} 1406