BrowseFragment.java revision 3595aa0cbdaa8e754365ca94a0b9eb8fc52b9796
1/* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 5 * in compliance with the License. You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software distributed under the License 10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 11 * or implied. See the License for the specific language governing permissions and limitations under 12 * the License. 13 */ 14package android.support.v17.leanback.app; 15 16import android.support.v17.leanback.R; 17import android.support.v17.leanback.transition.TransitionHelper; 18import android.support.v17.leanback.transition.TransitionListener; 19import android.support.v17.leanback.widget.BrowseFrameLayout; 20import android.support.v17.leanback.widget.HorizontalGridView; 21import android.support.v17.leanback.widget.ItemBridgeAdapter; 22import android.support.v17.leanback.widget.OnItemViewClickedListener; 23import android.support.v17.leanback.widget.OnItemViewSelectedListener; 24import android.support.v17.leanback.widget.Presenter; 25import android.support.v17.leanback.widget.PresenterSelector; 26import android.support.v17.leanback.widget.RowPresenter; 27import android.support.v17.leanback.widget.TitleView; 28import android.support.v17.leanback.widget.VerticalGridView; 29import android.support.v17.leanback.widget.Row; 30import android.support.v17.leanback.widget.ObjectAdapter; 31import android.support.v17.leanback.widget.OnItemSelectedListener; 32import android.support.v17.leanback.widget.OnItemClickedListener; 33import android.support.v17.leanback.widget.SearchOrbView; 34import android.util.Log; 35import android.app.Activity; 36import android.app.Fragment; 37import android.app.FragmentManager; 38import android.app.FragmentManager.BackStackEntry; 39import android.content.Context; 40import android.content.res.TypedArray; 41import android.os.Bundle; 42import android.view.LayoutInflater; 43import android.view.View; 44import android.view.View.OnClickListener; 45import android.view.ViewGroup; 46import android.view.ViewGroup.MarginLayoutParams; 47import android.view.ViewTreeObserver; 48import android.graphics.Color; 49import android.graphics.Rect; 50import android.graphics.drawable.Drawable; 51 52import static android.support.v7.widget.RecyclerView.NO_POSITION; 53 54/** 55 * A fragment for creating Leanback browse screens. It is composed of a 56 * RowsFragment and a HeadersFragment. 57 * <p> 58 * A BrowseFragment renders the elements of its {@link ObjectAdapter} as a set 59 * of rows in a vertical list. The elements in this adapter must be subclasses 60 * of {@link Row}. 61 * <p> 62 * The HeadersFragment can be set to be either shown or hidden by default, or 63 * may be disabled entirely. See {@link #setHeadersState} for details. 64 * <p> 65 * By default the BrowseFragment includes support for returning to the headers 66 * when the user presses Back. For Activities that customize {@link 67 * android.app.Activity#onBackPressed()}, you must disable this default Back key support by 68 * calling {@link #setHeadersTransitionOnBackEnabled(boolean)} with false and 69 * use {@link BrowseFragment.BrowseTransitionListener} and 70 * {@link #startHeadersTransition(boolean)}. 71 */ 72public class BrowseFragment extends Fragment { 73 74 // BUNDLE attribute for saving header show/hide status when backstack is used: 75 static final String HEADER_STACK_INDEX = "headerStackIndex"; 76 // BUNDLE attribute for saving header show/hide status when backstack is not used: 77 static final String HEADER_SHOW = "headerShow"; 78 // BUNDLE attribute for title is showing 79 static final String TITLE_SHOW = "titleShow"; 80 81 final class BackStackListener implements FragmentManager.OnBackStackChangedListener { 82 int mLastEntryCount; 83 int mIndexOfHeadersBackStack; 84 85 BackStackListener() { 86 mLastEntryCount = getFragmentManager().getBackStackEntryCount(); 87 mIndexOfHeadersBackStack = -1; 88 } 89 90 void load(Bundle savedInstanceState) { 91 if (savedInstanceState != null) { 92 mIndexOfHeadersBackStack = savedInstanceState.getInt(HEADER_STACK_INDEX, -1); 93 mShowingHeaders = mIndexOfHeadersBackStack == -1; 94 } else { 95 if (!mShowingHeaders) { 96 getFragmentManager().beginTransaction() 97 .addToBackStack(mWithHeadersBackStackName).commit(); 98 } 99 } 100 } 101 102 void save(Bundle outState) { 103 outState.putInt(HEADER_STACK_INDEX, mIndexOfHeadersBackStack); 104 } 105 106 107 @Override 108 public void onBackStackChanged() { 109 if (getFragmentManager() == null) { 110 Log.w(TAG, "getFragmentManager() is null, stack:", new Exception()); 111 return; 112 } 113 int count = getFragmentManager().getBackStackEntryCount(); 114 // if backstack is growing and last pushed entry is "headers" backstack, 115 // remember the index of the entry. 116 if (count > mLastEntryCount) { 117 BackStackEntry entry = getFragmentManager().getBackStackEntryAt(count - 1); 118 if (mWithHeadersBackStackName.equals(entry.getName())) { 119 mIndexOfHeadersBackStack = count - 1; 120 } 121 } else if (count < mLastEntryCount) { 122 // if popped "headers" backstack, initiate the show header transition if needed 123 if (mIndexOfHeadersBackStack >= count) { 124 mIndexOfHeadersBackStack = -1; 125 if (!mShowingHeaders) { 126 startHeadersTransitionInternal(true); 127 } 128 } 129 } 130 mLastEntryCount = count; 131 } 132 } 133 134 /** 135 * Listener for transitions between browse headers and rows. 136 */ 137 public static class BrowseTransitionListener { 138 /** 139 * Callback when headers transition starts. 140 * 141 * @param withHeaders True if the transition will result in headers 142 * being shown, false otherwise. 143 */ 144 public void onHeadersTransitionStart(boolean withHeaders) { 145 } 146 /** 147 * Callback when headers transition stops. 148 * 149 * @param withHeaders True if the transition will result in headers 150 * being shown, false otherwise. 151 */ 152 public void onHeadersTransitionStop(boolean withHeaders) { 153 } 154 } 155 156 private static final String TAG = "BrowseFragment"; 157 158 private static final String LB_HEADERS_BACKSTACK = "lbHeadersBackStack_"; 159 160 private static boolean DEBUG = false; 161 162 /** The headers fragment is enabled and shown by default. */ 163 public static final int HEADERS_ENABLED = 1; 164 165 /** The headers fragment is enabled and hidden by default. */ 166 public static final int HEADERS_HIDDEN = 2; 167 168 /** The headers fragment is disabled and will never be shown. */ 169 public static final int HEADERS_DISABLED = 3; 170 171 private static final float SLIDE_DISTANCE_FACTOR = 2; 172 173 private RowsFragment mRowsFragment; 174 private HeadersFragment mHeadersFragment; 175 176 private ObjectAdapter mAdapter; 177 178 private String mTitle; 179 private Drawable mBadgeDrawable; 180 private int mHeadersState = HEADERS_ENABLED; 181 private int mBrandColor = Color.TRANSPARENT; 182 private boolean mBrandColorSet; 183 184 private BrowseFrameLayout mBrowseFrame; 185 private TitleView mTitleView; 186 private boolean mShowingTitle = true; 187 private boolean mHeadersBackStackEnabled = true; 188 private String mWithHeadersBackStackName; 189 private boolean mShowingHeaders = true; 190 private boolean mCanShowHeaders = true; 191 private int mContainerListMarginLeft; 192 private int mContainerListAlignTop; 193 private boolean mRowScaleEnabled = true; 194 private SearchOrbView.Colors mSearchAffordanceColors; 195 private boolean mSearchAffordanceColorSet; 196 private OnItemSelectedListener mExternalOnItemSelectedListener; 197 private OnClickListener mExternalOnSearchClickedListener; 198 private OnItemClickedListener mOnItemClickedListener; 199 private OnItemViewSelectedListener mExternalOnItemViewSelectedListener; 200 private OnItemViewClickedListener mOnItemViewClickedListener; 201 private int mSelectedPosition = -1; 202 203 private PresenterSelector mHeaderPresenterSelector; 204 205 // transition related: 206 private static TransitionHelper sTransitionHelper = TransitionHelper.getInstance(); 207 private int mReparentHeaderId = View.generateViewId(); 208 private Object mSceneWithTitle; 209 private Object mSceneWithoutTitle; 210 private Object mSceneWithHeaders; 211 private Object mSceneWithoutHeaders; 212 private Object mSceneAfterEntranceTransition; 213 private Object mTitleUpTransition; 214 private Object mTitleDownTransition; 215 private Object mHeadersTransition; 216 private Object mEntranceTransition; 217 private int mHeadersTransitionStartDelay; 218 private int mHeadersTransitionDuration; 219 private BackStackListener mBackStackChangedListener; 220 private BrowseTransitionListener mBrowseTransitionListener; 221 222 private boolean mEntranceTransitionEnabled = false; 223 private boolean mStartEntranceTransitionPending = false; 224 225 private static final String ARG_TITLE = BrowseFragment.class.getCanonicalName() + ".title"; 226 private static final String ARG_BADGE_URI = BrowseFragment.class.getCanonicalName() + ".badge"; 227 private static final String ARG_HEADERS_STATE = 228 BrowseFragment.class.getCanonicalName() + ".headersState"; 229 230 /** 231 * Create arguments for a browse fragment. 232 * 233 * @param args The Bundle to place arguments into, or null if the method 234 * should return a new Bundle. 235 * @param title The title of the BrowseFragment. 236 * @param headersState The initial state of the headers of the 237 * BrowseFragment. Must be one of {@link #HEADERS_ENABLED}, {@link 238 * #HEADERS_HIDDEN}, or {@link #HEADERS_DISABLED}. 239 * @return A Bundle with the given arguments for creating a BrowseFragment. 240 */ 241 public static Bundle createArgs(Bundle args, String title, int headersState) { 242 if (args == null) { 243 args = new Bundle(); 244 } 245 args.putString(ARG_TITLE, title); 246 args.putInt(ARG_HEADERS_STATE, headersState); 247 return args; 248 } 249 250 /** 251 * Sets the brand color for the browse fragment. The brand color is used as 252 * the primary color for UI elements in the browse fragment. For example, 253 * the background color of the headers fragment uses the brand color. 254 * 255 * @param color The color to use as the brand color of the fragment. 256 */ 257 public void setBrandColor(int color) { 258 mBrandColor = color; 259 mBrandColorSet = true; 260 261 if (mHeadersFragment != null) { 262 mHeadersFragment.setBackgroundColor(mBrandColor); 263 } 264 } 265 266 /** 267 * Returns the brand color for the browse fragment. 268 * The default is transparent. 269 */ 270 public int getBrandColor() { 271 return mBrandColor; 272 } 273 274 /** 275 * Sets the adapter containing the rows for the fragment. 276 * 277 * <p>The items referenced by the adapter must be be derived from 278 * {@link Row}. These rows will be used by the rows fragment and the headers 279 * fragment (if not disabled) to render the browse rows. 280 * 281 * @param adapter An ObjectAdapter for the browse rows. All items must 282 * derive from {@link Row}. 283 */ 284 public void setAdapter(ObjectAdapter adapter) { 285 mAdapter = adapter; 286 if (mRowsFragment != null) { 287 mRowsFragment.setAdapter(adapter); 288 mHeadersFragment.setAdapter(adapter); 289 } 290 } 291 292 /** 293 * Returns the adapter containing the rows for the fragment. 294 */ 295 public ObjectAdapter getAdapter() { 296 return mAdapter; 297 } 298 299 /** 300 * Sets an item selection listener. This listener will be called when an 301 * item or row is selected by a user. 302 * 303 * @param listener The listener to call when an item or row is selected. 304 * @deprecated Use {@link #setOnItemViewSelectedListener(OnItemViewSelectedListener)} 305 */ 306 public void setOnItemSelectedListener(OnItemSelectedListener listener) { 307 mExternalOnItemSelectedListener = listener; 308 } 309 310 /** 311 * Sets an item selection listener. 312 */ 313 public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) { 314 mExternalOnItemViewSelectedListener = listener; 315 } 316 317 /** 318 * Returns an item selection listener. 319 */ 320 public OnItemViewSelectedListener getOnItemViewSelectedListener() { 321 return mExternalOnItemViewSelectedListener; 322 } 323 324 /** 325 * Sets an item clicked listener on the fragment. 326 * 327 * <p>OnItemClickedListener will override {@link View.OnClickListener} that 328 * an item presenter may set during 329 * {@link Presenter#onCreateViewHolder(ViewGroup)}. So in general, you 330 * should choose to use an {@link OnItemClickedListener} or a 331 * {@link View.OnClickListener} on your item views, but not both. 332 * 333 * @param listener The listener to call when an item is clicked. 334 * @deprecated Use {@link #setOnItemViewClickedListener(OnItemViewClickedListener)} 335 */ 336 public void setOnItemClickedListener(OnItemClickedListener listener) { 337 mOnItemClickedListener = listener; 338 if (mRowsFragment != null) { 339 mRowsFragment.setOnItemClickedListener(listener); 340 } 341 } 342 343 /** 344 * Returns the item clicked listener. 345 * @deprecated Use {@link #getOnItemViewClickedListener()} 346 */ 347 public OnItemClickedListener getOnItemClickedListener() { 348 return mOnItemClickedListener; 349 } 350 351 /** 352 * Sets an item clicked listener on the fragment. 353 * OnItemViewClickedListener will override {@link View.OnClickListener} that 354 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 355 * So in general, developer should choose one of the listeners but not both. 356 */ 357 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 358 mOnItemViewClickedListener = listener; 359 if (mRowsFragment != null) { 360 mRowsFragment.setOnItemViewClickedListener(listener); 361 } 362 } 363 364 /** 365 * Returns the item Clicked listener. 366 */ 367 public OnItemViewClickedListener getOnItemViewClickedListener() { 368 return mOnItemViewClickedListener; 369 } 370 371 /** 372 * Sets a click listener for the search affordance. 373 * 374 * <p>The presence of a listener will change the visibility of the search 375 * affordance in the fragment title. When set to non-null, the title will 376 * contain an element that a user may click to begin a search. 377 * 378 * <p>The listener's {@link View.OnClickListener#onClick onClick} method 379 * will be invoked when the user clicks on the search element. 380 * 381 * @param listener The listener to call when the search element is clicked. 382 */ 383 public void setOnSearchClickedListener(View.OnClickListener listener) { 384 mExternalOnSearchClickedListener = listener; 385 if (mTitleView != null) { 386 mTitleView.setOnSearchClickedListener(listener); 387 } 388 } 389 390 /** 391 * Sets the {@link SearchOrbView.Colors} used to draw the search affordance. 392 */ 393 public void setSearchAffordanceColors(SearchOrbView.Colors colors) { 394 mSearchAffordanceColors = colors; 395 mSearchAffordanceColorSet = true; 396 if (mTitleView != null) { 397 mTitleView.setSearchAffordanceColors(mSearchAffordanceColors); 398 } 399 } 400 401 /** 402 * Returns the {@link SearchOrbView.Colors} used to draw the search affordance. 403 */ 404 public SearchOrbView.Colors getSearchAffordanceColors() { 405 if (mSearchAffordanceColorSet) { 406 return mSearchAffordanceColors; 407 } 408 if (mTitleView == null) { 409 throw new IllegalStateException("Fragment views not yet created"); 410 } 411 return mTitleView.getSearchAffordanceColors(); 412 } 413 414 /** 415 * Sets the color used to draw the search affordance. 416 * A default brighter color will be set by the framework. 417 * 418 * @param color The color to use for the search affordance. 419 */ 420 public void setSearchAffordanceColor(int color) { 421 setSearchAffordanceColors(new SearchOrbView.Colors(color)); 422 } 423 424 /** 425 * Returns the color used to draw the search affordance. 426 */ 427 public int getSearchAffordanceColor() { 428 return getSearchAffordanceColors().color; 429 } 430 431 /** 432 * Start a headers transition. 433 * 434 * <p>This method will begin a transition to either show or hide the 435 * headers, depending on the value of withHeaders. If headers are disabled 436 * for this browse fragment, this method will throw an exception. 437 * 438 * @param withHeaders True if the headers should transition to being shown, 439 * false if the transition should result in headers being hidden. 440 */ 441 public void startHeadersTransition(boolean withHeaders) { 442 if (!mCanShowHeaders) { 443 throw new IllegalStateException("Cannot start headers transition"); 444 } 445 if (isInHeadersTransition() || mShowingHeaders == withHeaders) { 446 return; 447 } 448 startHeadersTransitionInternal(withHeaders); 449 } 450 451 /** 452 * Returns true if the headers transition is currently running. 453 */ 454 public boolean isInHeadersTransition() { 455 return mHeadersTransition != null; 456 } 457 458 /** 459 * Returns true if headers are shown. 460 */ 461 public boolean isShowingHeaders() { 462 return mShowingHeaders; 463 } 464 465 /** 466 * Set a listener for browse fragment transitions. 467 * 468 * @param listener The listener to call when a browse headers transition 469 * begins or ends. 470 */ 471 public void setBrowseTransitionListener(BrowseTransitionListener listener) { 472 mBrowseTransitionListener = listener; 473 } 474 475 /** 476 * Enables scaling of rows when headers are present. 477 * By default enabled to increase density. 478 * 479 * @param enable true to enable row scaling 480 */ 481 public void enableRowScaling(boolean enable) { 482 mRowScaleEnabled = enable; 483 if (mRowsFragment != null) { 484 mRowsFragment.enableRowScaling(mRowScaleEnabled); 485 } 486 } 487 488 private void startHeadersTransitionInternal(final boolean withHeaders) { 489 if (getFragmentManager().isDestroyed()) { 490 return; 491 } 492 mShowingHeaders = withHeaders; 493 mRowsFragment.onExpandTransitionStart(!withHeaders, new Runnable() { 494 @Override 495 public void run() { 496 mHeadersFragment.onTransitionStart(); 497 createHeadersTransition(); 498 if (mBrowseTransitionListener != null) { 499 mBrowseTransitionListener.onHeadersTransitionStart(withHeaders); 500 } 501 sTransitionHelper.runTransition(withHeaders ? mSceneWithHeaders : mSceneWithoutHeaders, 502 mHeadersTransition); 503 if (mHeadersBackStackEnabled) { 504 if (!withHeaders) { 505 getFragmentManager().beginTransaction() 506 .addToBackStack(mWithHeadersBackStackName).commit(); 507 } else { 508 int index = mBackStackChangedListener.mIndexOfHeadersBackStack; 509 if (index >= 0) { 510 BackStackEntry entry = getFragmentManager().getBackStackEntryAt(index); 511 getFragmentManager().popBackStackImmediate(entry.getId(), 512 FragmentManager.POP_BACK_STACK_INCLUSIVE); 513 } 514 } 515 } 516 } 517 }); 518 } 519 520 private boolean isVerticalScrolling() { 521 // don't run transition 522 return mHeadersFragment.getVerticalGridView().getScrollState() 523 != HorizontalGridView.SCROLL_STATE_IDLE 524 || mRowsFragment.getVerticalGridView().getScrollState() 525 != HorizontalGridView.SCROLL_STATE_IDLE; 526 } 527 528 private final BrowseFrameLayout.OnFocusSearchListener mOnFocusSearchListener = 529 new BrowseFrameLayout.OnFocusSearchListener() { 530 @Override 531 public View onFocusSearch(View focused, int direction) { 532 // If headers fragment is disabled, just return null. 533 if (!mCanShowHeaders) return null; 534 535 final View searchOrbView = mTitleView.getSearchAffordanceView(); 536 // if headers is running transition, focus stays 537 if (isInHeadersTransition()) return focused; 538 if (DEBUG) Log.v(TAG, "onFocusSearch focused " + focused + " + direction " + direction); 539 if (direction == View.FOCUS_LEFT) { 540 if (isVerticalScrolling() || mShowingHeaders) { 541 return focused; 542 } 543 return mHeadersFragment.getVerticalGridView(); 544 } else if (direction == View.FOCUS_RIGHT) { 545 if (isVerticalScrolling() || !mShowingHeaders) { 546 return focused; 547 } 548 return mRowsFragment.getVerticalGridView(); 549 } else if (focused == searchOrbView && direction == View.FOCUS_DOWN) { 550 return mShowingHeaders ? mHeadersFragment.getVerticalGridView() : 551 mRowsFragment.getVerticalGridView(); 552 553 } else if (focused != searchOrbView && searchOrbView.getVisibility() == View.VISIBLE 554 && direction == View.FOCUS_UP) { 555 return searchOrbView; 556 557 } else { 558 return null; 559 } 560 } 561 }; 562 563 private final BrowseFrameLayout.OnChildFocusListener mOnChildFocusListener = 564 new BrowseFrameLayout.OnChildFocusListener() { 565 566 @Override 567 public boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) { 568 if (getChildFragmentManager().isDestroyed()) { 569 return true; 570 } 571 // Make sure not changing focus when requestFocus() is called. 572 if (mCanShowHeaders && mShowingHeaders) { 573 if (mHeadersFragment.getView().requestFocus(direction, previouslyFocusedRect)) { 574 return true; 575 } 576 } 577 if (mRowsFragment.getView().requestFocus(direction, previouslyFocusedRect)) { 578 return true; 579 } 580 return mTitleView.requestFocus(direction, previouslyFocusedRect); 581 }; 582 583 @Override 584 public void onRequestChildFocus(View child, View focused) { 585 if (getChildFragmentManager().isDestroyed()) { 586 return; 587 } 588 if (!mCanShowHeaders || isInHeadersTransition()) return; 589 int childId = child.getId(); 590 if (childId == R.id.browse_container_dock && mShowingHeaders) { 591 startHeadersTransitionInternal(false); 592 } else if (childId == R.id.browse_headers_dock && !mShowingHeaders) { 593 startHeadersTransitionInternal(true); 594 } 595 } 596 }; 597 598 @Override 599 public void onSaveInstanceState(Bundle outState) { 600 if (mBackStackChangedListener != null) { 601 mBackStackChangedListener.save(outState); 602 } else { 603 outState.putBoolean(HEADER_SHOW, mShowingHeaders); 604 } 605 outState.putBoolean(TITLE_SHOW, mShowingTitle); 606 } 607 608 @Override 609 public void onCreate(Bundle savedInstanceState) { 610 super.onCreate(savedInstanceState); 611 TypedArray ta = getActivity().obtainStyledAttributes(R.styleable.LeanbackTheme); 612 mContainerListMarginLeft = (int) ta.getDimension( 613 R.styleable.LeanbackTheme_browseRowsMarginStart, 0); 614 mContainerListAlignTop = (int) ta.getDimension( 615 R.styleable.LeanbackTheme_browseRowsMarginTop, 0); 616 ta.recycle(); 617 618 mHeadersTransitionStartDelay = getResources() 619 .getInteger(R.integer.lb_browse_headers_transition_delay); 620 mHeadersTransitionDuration = getResources() 621 .getInteger(R.integer.lb_browse_headers_transition_duration); 622 623 readArguments(getArguments()); 624 625 if (mCanShowHeaders) { 626 if (mHeadersBackStackEnabled) { 627 mWithHeadersBackStackName = LB_HEADERS_BACKSTACK + this; 628 mBackStackChangedListener = new BackStackListener(); 629 getFragmentManager().addOnBackStackChangedListener(mBackStackChangedListener); 630 mBackStackChangedListener.load(savedInstanceState); 631 } else { 632 if (savedInstanceState != null) { 633 mShowingHeaders = savedInstanceState.getBoolean(HEADER_SHOW); 634 } 635 } 636 } 637 638 } 639 640 @Override 641 public void onDestroy() { 642 if (mBackStackChangedListener != null) { 643 getFragmentManager().removeOnBackStackChangedListener(mBackStackChangedListener); 644 } 645 super.onDestroy(); 646 } 647 648 @Override 649 public View onCreateView(LayoutInflater inflater, ViewGroup container, 650 Bundle savedInstanceState) { 651 if (getChildFragmentManager().findFragmentById(R.id.browse_container_dock) == null) { 652 mRowsFragment = new RowsFragment(); 653 mHeadersFragment = new HeadersFragment(); 654 getChildFragmentManager().beginTransaction() 655 .replace(R.id.browse_headers_dock, mHeadersFragment) 656 .replace(R.id.browse_container_dock, mRowsFragment).commit(); 657 } else { 658 mHeadersFragment = (HeadersFragment) getChildFragmentManager() 659 .findFragmentById(R.id.browse_headers_dock); 660 mRowsFragment = (RowsFragment) getChildFragmentManager() 661 .findFragmentById(R.id.browse_container_dock); 662 } 663 664 mHeadersFragment.setHeadersGone(!mCanShowHeaders); 665 666 mRowsFragment.setAdapter(mAdapter); 667 if (mHeaderPresenterSelector != null) { 668 mHeadersFragment.setPresenterSelector(mHeaderPresenterSelector); 669 } 670 mHeadersFragment.setAdapter(mAdapter); 671 672 mRowsFragment.enableRowScaling(mRowScaleEnabled); 673 mRowsFragment.setOnItemSelectedListener(mRowSelectedListener); 674 mRowsFragment.setOnItemViewSelectedListener(mRowViewSelectedListener); 675 mHeadersFragment.setOnItemSelectedListener(mHeaderSelectedListener); 676 mHeadersFragment.setOnHeaderClickedListener(mHeaderClickedListener); 677 mRowsFragment.setOnItemClickedListener(mOnItemClickedListener); 678 mRowsFragment.setOnItemViewClickedListener(mOnItemViewClickedListener); 679 680 View root = inflater.inflate(R.layout.lb_browse_fragment, container, false); 681 682 mBrowseFrame = (BrowseFrameLayout) root.findViewById(R.id.browse_frame); 683 mBrowseFrame.setOnFocusSearchListener(mOnFocusSearchListener); 684 mBrowseFrame.setOnChildFocusListener(mOnChildFocusListener); 685 686 mTitleView = (TitleView) root.findViewById(R.id.browse_title_group); 687 mTitleView.setTitle(mTitle); 688 mTitleView.setBadgeDrawable(mBadgeDrawable); 689 if (mSearchAffordanceColorSet) { 690 mTitleView.setSearchAffordanceColors(mSearchAffordanceColors); 691 } 692 if (mExternalOnSearchClickedListener != null) { 693 mTitleView.setOnSearchClickedListener(mExternalOnSearchClickedListener); 694 } 695 696 if (mBrandColorSet) { 697 mHeadersFragment.setBackgroundColor(mBrandColor); 698 } 699 700 mSceneWithTitle = sTransitionHelper.createScene(mBrowseFrame, new Runnable() { 701 @Override 702 public void run() { 703 mTitleView.setVisibility(View.VISIBLE); 704 } 705 }); 706 mSceneWithoutTitle = sTransitionHelper.createScene(mBrowseFrame, new Runnable() { 707 @Override 708 public void run() { 709 mTitleView.setVisibility(View.INVISIBLE); 710 } 711 }); 712 mSceneWithHeaders = sTransitionHelper.createScene(mBrowseFrame, new Runnable() { 713 @Override 714 public void run() { 715 showHeaders(true); 716 } 717 }); 718 mSceneWithoutHeaders = sTransitionHelper.createScene(mBrowseFrame, new Runnable() { 719 @Override 720 public void run() { 721 showHeaders(false); 722 } 723 }); 724 mSceneAfterEntranceTransition = sTransitionHelper.createScene(mBrowseFrame, new Runnable() { 725 @Override 726 public void run() { 727 setEntranceTransitionEndState(); 728 } 729 }); 730 mTitleUpTransition = TitleTransitionHelper.createTransitionTitleUp(sTransitionHelper); 731 mTitleDownTransition = TitleTransitionHelper.createTransitionTitleDown(sTransitionHelper); 732 733 sTransitionHelper.excludeChildren(mTitleUpTransition, R.id.browse_headers, true); 734 sTransitionHelper.excludeChildren(mTitleDownTransition, R.id.browse_headers, true); 735 sTransitionHelper.excludeChildren(mTitleUpTransition, R.id.container_list, true); 736 sTransitionHelper.excludeChildren(mTitleDownTransition, R.id.container_list, true); 737 738 if (savedInstanceState != null) { 739 mShowingTitle = savedInstanceState.getBoolean(TITLE_SHOW); 740 } 741 mTitleView.setVisibility(mShowingTitle ? View.VISIBLE: View.INVISIBLE); 742 743 return root; 744 } 745 746 @Override 747 public void onViewCreated(View view, Bundle savedInstanceState) { 748 super.onViewCreated(view, savedInstanceState); 749 if (mStartEntranceTransitionPending) { 750 mStartEntranceTransitionPending = false; 751 startEntranceTransition(); 752 } 753 } 754 755 private void createHeadersTransition() { 756 mHeadersTransition = sTransitionHelper.createTransitionSet(false); 757 sTransitionHelper.excludeChildren(mHeadersTransition, R.id.browse_title_group, true); 758 Object changeBounds = sTransitionHelper.createChangeBounds(false); 759 Object fadeIn = sTransitionHelper.createFadeTransition(TransitionHelper.FADE_IN); 760 Object fadeOut = sTransitionHelper.createFadeTransition(TransitionHelper.FADE_OUT); 761 Object scale = sTransitionHelper.createScale(); 762 if (TransitionHelper.systemSupportsTransitions()) { 763 Context context = getView().getContext(); 764 sTransitionHelper.setInterpolator(changeBounds, 765 sTransitionHelper.createDefaultInterpolator(context)); 766 sTransitionHelper.setInterpolator(fadeIn, 767 sTransitionHelper.createDefaultInterpolator(context)); 768 sTransitionHelper.setInterpolator(fadeOut, 769 sTransitionHelper.createDefaultInterpolator(context)); 770 sTransitionHelper.setInterpolator(scale, 771 sTransitionHelper.createDefaultInterpolator(context)); 772 } 773 774 sTransitionHelper.setDuration(fadeOut, mHeadersTransitionDuration); 775 sTransitionHelper.addTransition(mHeadersTransition, fadeOut); 776 777 if (mShowingHeaders) { 778 sTransitionHelper.setStartDelay(changeBounds, mHeadersTransitionStartDelay); 779 sTransitionHelper.setStartDelay(scale, mHeadersTransitionStartDelay); 780 } 781 sTransitionHelper.setDuration(changeBounds, mHeadersTransitionDuration); 782 sTransitionHelper.addTransition(mHeadersTransition, changeBounds); 783 sTransitionHelper.addTarget(scale, mRowsFragment.getScaleView()); 784 sTransitionHelper.setDuration(scale, mHeadersTransitionDuration); 785 sTransitionHelper.addTransition(mHeadersTransition, scale); 786 787 sTransitionHelper.setDuration(fadeIn, mHeadersTransitionDuration); 788 sTransitionHelper.setStartDelay(fadeIn, mHeadersTransitionStartDelay); 789 sTransitionHelper.addTransition(mHeadersTransition, fadeIn); 790 791 sTransitionHelper.setTransitionListener(mHeadersTransition, new TransitionListener() { 792 @Override 793 public void onTransitionStart(Object transition) { 794 } 795 @Override 796 public void onTransitionEnd(Object transition) { 797 mHeadersTransition = null; 798 mRowsFragment.onTransitionEnd(); 799 mHeadersFragment.onTransitionEnd(); 800 if (mShowingHeaders) { 801 VerticalGridView headerGridView = mHeadersFragment.getVerticalGridView(); 802 if (headerGridView != null && !headerGridView.hasFocus()) { 803 headerGridView.requestFocus(); 804 } 805 } else { 806 VerticalGridView rowsGridView = mRowsFragment.getVerticalGridView(); 807 if (rowsGridView != null && !rowsGridView.hasFocus()) { 808 rowsGridView.requestFocus(); 809 } 810 } 811 if (mBrowseTransitionListener != null) { 812 mBrowseTransitionListener.onHeadersTransitionStop(mShowingHeaders); 813 } 814 } 815 }); 816 } 817 818 /** 819 * Sets the {@link PresenterSelector} used to render the row headers. 820 * 821 * @param headerPresenterSelector The PresenterSelector that will determine 822 * the Presenter for each row header. 823 */ 824 public void setHeaderPresenterSelector(PresenterSelector headerPresenterSelector) { 825 mHeaderPresenterSelector = headerPresenterSelector; 826 if (mHeadersFragment != null) { 827 mHeadersFragment.setPresenterSelector(mHeaderPresenterSelector); 828 } 829 } 830 831 private void setRowsAlignedLeft(boolean alignLeft) { 832 MarginLayoutParams lp; 833 View containerList; 834 containerList = mRowsFragment.getView(); 835 lp = (MarginLayoutParams) containerList.getLayoutParams(); 836 lp.leftMargin = alignLeft ? 0 : mContainerListMarginLeft; 837 containerList.setLayoutParams(lp); 838 } 839 840 private void setHeadersOnScreen(boolean onScreen) { 841 MarginLayoutParams lp; 842 View containerList; 843 containerList = mHeadersFragment.getView(); 844 lp = (MarginLayoutParams) containerList.getLayoutParams(); 845 lp.leftMargin = onScreen ? 0 : -mContainerListMarginLeft; 846 containerList.setLayoutParams(lp); 847 } 848 849 private void showHeaders(boolean show) { 850 if (DEBUG) Log.v(TAG, "showHeaders " + show); 851 mHeadersFragment.setHeadersEnabled(show); 852 setHeadersOnScreen(show); 853 setRowsAlignedLeft(!show); 854 mRowsFragment.setExpand(!show); 855 } 856 857 private HeadersFragment.OnHeaderClickedListener mHeaderClickedListener = 858 new HeadersFragment.OnHeaderClickedListener() { 859 @Override 860 public void onHeaderClicked() { 861 if (!mCanShowHeaders || !mShowingHeaders || isInHeadersTransition()) { 862 return; 863 } 864 startHeadersTransitionInternal(false); 865 mRowsFragment.getVerticalGridView().requestFocus(); 866 } 867 }; 868 869 private OnItemViewSelectedListener mRowViewSelectedListener = new OnItemViewSelectedListener() { 870 @Override 871 public void onItemSelected(Presenter.ViewHolder itemViewHolder, Object item, 872 RowPresenter.ViewHolder rowViewHolder, Row row) { 873 int position = mRowsFragment.getVerticalGridView().getSelectedPosition(); 874 if (DEBUG) Log.v(TAG, "row selected position " + position); 875 onRowSelected(position); 876 if (mExternalOnItemViewSelectedListener != null) { 877 mExternalOnItemViewSelectedListener.onItemSelected(itemViewHolder, item, 878 rowViewHolder, row); 879 } 880 } 881 }; 882 883 private OnItemSelectedListener mRowSelectedListener = new OnItemSelectedListener() { 884 @Override 885 public void onItemSelected(Object item, Row row) { 886 if (mExternalOnItemSelectedListener != null) { 887 mExternalOnItemSelectedListener.onItemSelected(item, row); 888 } 889 } 890 }; 891 892 private OnItemSelectedListener mHeaderSelectedListener = new OnItemSelectedListener() { 893 @Override 894 public void onItemSelected(Object item, Row row) { 895 int position = mHeadersFragment.getVerticalGridView().getSelectedPosition(); 896 if (DEBUG) Log.v(TAG, "header selected position " + position); 897 onRowSelected(position); 898 } 899 }; 900 901 private void onRowSelected(int position) { 902 if (position != mSelectedPosition) { 903 mSetSelectionRunnable.mPosition = position; 904 mBrowseFrame.getHandler().post(mSetSelectionRunnable); 905 906 if (getAdapter() == null || getAdapter().size() == 0 || position == 0) { 907 if (!mShowingTitle) { 908 sTransitionHelper.runTransition(mSceneWithTitle, mTitleDownTransition); 909 mShowingTitle = true; 910 } 911 } else if (mShowingTitle) { 912 sTransitionHelper.runTransition(mSceneWithoutTitle, mTitleUpTransition); 913 mShowingTitle = false; 914 } 915 } 916 } 917 918 private class SetSelectionRunnable implements Runnable { 919 int mPosition; 920 @Override 921 public void run() { 922 setSelection(mPosition); 923 } 924 } 925 926 private final SetSelectionRunnable mSetSelectionRunnable = new SetSelectionRunnable(); 927 928 private void setSelection(int position) { 929 if (position != NO_POSITION) { 930 mRowsFragment.setSelectedPosition(position); 931 mHeadersFragment.setSelectedPosition(position); 932 } 933 mSelectedPosition = position; 934 } 935 936 @Override 937 public void onStart() { 938 super.onStart(); 939 mHeadersFragment.setWindowAlignmentFromTop(mContainerListAlignTop); 940 mHeadersFragment.setItemAlignment(); 941 mRowsFragment.setWindowAlignmentFromTop(mContainerListAlignTop); 942 mRowsFragment.setItemAlignment(); 943 944 mRowsFragment.setScalePivots(0, mContainerListAlignTop); 945 946 if (mCanShowHeaders && mShowingHeaders && mHeadersFragment.getView() != null) { 947 mHeadersFragment.getView().requestFocus(); 948 } else if ((!mCanShowHeaders || !mShowingHeaders) 949 && mRowsFragment.getView() != null) { 950 mRowsFragment.getView().requestFocus(); 951 } 952 if (mCanShowHeaders) { 953 showHeaders(mShowingHeaders); 954 } 955 if (mEntranceTransitionEnabled) { 956 setEntranceTransitionStartState(); 957 } 958 } 959 960 /** 961 * Enable/disable headers transition on back key support. This is enabled by 962 * default. The BrowseFragment will add a back stack entry when headers are 963 * showing. Running a headers transition when the back key is pressed only 964 * works when the headers state is {@link #HEADERS_ENABLED} or 965 * {@link #HEADERS_HIDDEN}. 966 * <p> 967 * NOTE: If an Activity has its own onBackPressed() handling, you must 968 * disable this feature. You may use {@link #startHeadersTransition(boolean)} 969 * and {@link BrowseTransitionListener} in your own back stack handling. 970 */ 971 public final void setHeadersTransitionOnBackEnabled(boolean headersBackStackEnabled) { 972 mHeadersBackStackEnabled = headersBackStackEnabled; 973 } 974 975 /** 976 * Returns true if headers transition on back key support is enabled. 977 */ 978 public final boolean isHeadersTransitionOnBackEnabled() { 979 return mHeadersBackStackEnabled; 980 } 981 982 private void readArguments(Bundle args) { 983 if (args == null) { 984 return; 985 } 986 if (args.containsKey(ARG_TITLE)) { 987 setTitle(args.getString(ARG_TITLE)); 988 } 989 if (args.containsKey(ARG_HEADERS_STATE)) { 990 setHeadersState(args.getInt(ARG_HEADERS_STATE)); 991 } 992 } 993 994 /** 995 * Sets the drawable displayed in the browse fragment title. 996 * 997 * @param drawable The Drawable to display in the browse fragment title. 998 */ 999 public void setBadgeDrawable(Drawable drawable) { 1000 if (mBadgeDrawable != drawable) { 1001 mBadgeDrawable = drawable; 1002 if (mTitleView != null) { 1003 mTitleView.setBadgeDrawable(drawable); 1004 } 1005 } 1006 } 1007 1008 /** 1009 * Returns the badge drawable used in the fragment title. 1010 */ 1011 public Drawable getBadgeDrawable() { 1012 return mBadgeDrawable; 1013 } 1014 1015 /** 1016 * Sets a title for the browse fragment. 1017 * 1018 * @param title The title of the browse fragment. 1019 */ 1020 public void setTitle(String title) { 1021 mTitle = title; 1022 if (mTitleView != null) { 1023 mTitleView.setTitle(title); 1024 } 1025 } 1026 1027 /** 1028 * Returns the title for the browse fragment. 1029 */ 1030 public String getTitle() { 1031 return mTitle; 1032 } 1033 1034 /** 1035 * Sets the state for the headers column in the browse fragment. Must be one 1036 * of {@link #HEADERS_ENABLED}, {@link #HEADERS_HIDDEN}, or 1037 * {@link #HEADERS_DISABLED}. 1038 * 1039 * @param headersState The state of the headers for the browse fragment. 1040 */ 1041 public void setHeadersState(int headersState) { 1042 if (headersState < HEADERS_ENABLED || headersState > HEADERS_DISABLED) { 1043 throw new IllegalArgumentException("Invalid headers state: " + headersState); 1044 } 1045 if (DEBUG) Log.v(TAG, "setHeadersState " + headersState); 1046 1047 if (headersState != mHeadersState) { 1048 mHeadersState = headersState; 1049 switch (headersState) { 1050 case HEADERS_ENABLED: 1051 mCanShowHeaders = true; 1052 mShowingHeaders = true; 1053 break; 1054 case HEADERS_HIDDEN: 1055 mCanShowHeaders = true; 1056 mShowingHeaders = false; 1057 break; 1058 case HEADERS_DISABLED: 1059 mCanShowHeaders = false; 1060 mShowingHeaders = false; 1061 break; 1062 default: 1063 Log.w(TAG, "Unknown headers state: " + headersState); 1064 break; 1065 } 1066 if (mHeadersFragment != null) { 1067 mHeadersFragment.setHeadersGone(!mCanShowHeaders); 1068 } 1069 } 1070 } 1071 1072 /** 1073 * Returns the state of the headers column in the browse fragment. 1074 */ 1075 public int getHeadersState() { 1076 return mHeadersState; 1077 } 1078 1079 /** 1080 * Enable or disable entrance transition. Typically this is set in onCreate() 1081 * when savedInstance is null. When the entrance transition is enabled, the 1082 * fragment is initially having headers and content hidden. 1083 * When data of rows are ready, you must call startEntranceTransition() to kick off 1084 * the transition. 1085 */ 1086 public void setEntranceTransitionEnabled(boolean runEntranceTransition) { 1087 mEntranceTransitionEnabled = runEntranceTransition; 1088 } 1089 1090 /** 1091 * Return true if entrance transition is enabled and not started yet. 1092 */ 1093 public boolean isEntranceTransitionEnabled() { 1094 return mEntranceTransitionEnabled; 1095 } 1096 1097 /** 1098 * Starts entrance transition if setEntranceTransitionEnabled(true) is called 1099 * and entrance transition is not started yet. 1100 * When fragment finishes loading data of rows, it should call startEntranceTransition() 1101 * to execute the entrance transition. Calling startEntranceTransition() multiple 1102 * times is safe. 1103 */ 1104 public void startEntranceTransition() { 1105 if (!mEntranceTransitionEnabled || mEntranceTransition != null) { 1106 return; 1107 } 1108 // if view is not created yet, delay until onViewCreated() 1109 if (getView() == null) { 1110 mStartEntranceTransitionPending = true; 1111 return; 1112 } 1113 // wait till views get their initial position before start transition 1114 final View view = getView(); 1115 view.getViewTreeObserver().addOnPreDrawListener( 1116 new ViewTreeObserver.OnPreDrawListener() { 1117 @Override 1118 public boolean onPreDraw() { 1119 view.getViewTreeObserver().removeOnPreDrawListener(this); 1120 createEntranceTransition(); 1121 mEntranceTransitionEnabled = false; 1122 sTransitionHelper.runTransition(mSceneAfterEntranceTransition, 1123 mEntranceTransition); 1124 return false; 1125 } 1126 }); 1127 view.invalidate(); 1128 } 1129 1130 void createEntranceTransition() { 1131 mEntranceTransition = sTransitionHelper.loadTransition(getActivity(), 1132 R.transition.lb_browse_entrance_transition); 1133 if (mEntranceTransition == null) { 1134 return; 1135 } 1136 sTransitionHelper.setTransitionListener(mEntranceTransition, new TransitionListener() { 1137 @Override 1138 public void onTransitionStart(Object transition) { 1139 mHeadersFragment.onTransitionStart(); 1140 mRowsFragment.onTransitionStart(); 1141 } 1142 @Override 1143 public void onTransitionEnd(Object transition) { 1144 mRowsFragment.onTransitionEnd(); 1145 mHeadersFragment.onTransitionEnd(); 1146 mEntranceTransition = null; 1147 } 1148 }); 1149 } 1150 1151 private void setSearchOrbViewOnScreen(boolean onScreen) { 1152 View searchOrbView = mTitleView.getSearchAffordanceView(); 1153 MarginLayoutParams lp = (MarginLayoutParams) searchOrbView.getLayoutParams(); 1154 lp.leftMargin = onScreen ? 0 : -mContainerListMarginLeft; 1155 searchOrbView.setLayoutParams(lp); 1156 } 1157 1158 void setEntranceTransitionStartState() { 1159 setHeadersOnScreen(false); 1160 setSearchOrbViewOnScreen(false); 1161 mRowsFragment.setViewsVisible(false); 1162 } 1163 1164 void setEntranceTransitionEndState() { 1165 setHeadersOnScreen(mShowingHeaders); 1166 setSearchOrbViewOnScreen(true); 1167 mRowsFragment.setViewsVisible(true); 1168 } 1169 1170} 1171 1172