RowsSupportFragment.java revision 3f0f3eb255bde49549a77c0b5d252decaa2a0202
1/* This file is auto-generated from RowsFragment.java. DO NOT MODIFY. */ 2 3/* 4 * Copyright (C) 2014 The Android Open Source Project 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 7 * in compliance with the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software distributed under the License 12 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 13 * or implied. See the License for the specific language governing permissions and limitations under 14 * the License. 15 */ 16package android.support.v17.leanback.app; 17 18import java.util.ArrayList; 19 20import android.animation.TimeAnimator; 21import android.animation.TimeAnimator.TimeListener; 22import android.os.Bundle; 23import android.support.v17.leanback.R; 24import android.support.v17.leanback.widget.ItemBridgeAdapter; 25import android.support.v17.leanback.widget.OnItemViewClickedListener; 26import android.support.v17.leanback.widget.OnItemViewSelectedListener; 27import android.support.v17.leanback.widget.RowPresenter.ViewHolder; 28import android.support.v17.leanback.widget.ScaleFrameLayout; 29import android.support.v17.leanback.widget.VerticalGridView; 30import android.support.v17.leanback.widget.HorizontalGridView; 31import android.support.v17.leanback.widget.OnItemSelectedListener; 32import android.support.v17.leanback.widget.OnItemClickedListener; 33import android.support.v17.leanback.widget.RowPresenter; 34import android.support.v17.leanback.widget.ListRowPresenter; 35import android.support.v17.leanback.widget.Presenter; 36import android.support.v7.widget.RecyclerView; 37import android.util.Log; 38import android.view.LayoutInflater; 39import android.view.View; 40import android.view.ViewGroup; 41import android.view.ViewTreeObserver; 42import android.view.animation.DecelerateInterpolator; 43import android.view.animation.Interpolator; 44 45/** 46 * An ordered set of rows of leanback widgets. 47 */ 48public class RowsSupportFragment extends BaseRowSupportFragment { 49 50 /** 51 * Internal helper class that manages row select animation and apply a default 52 * dim to each row. 53 */ 54 final class RowViewHolderExtra implements TimeListener { 55 final RowPresenter mRowPresenter; 56 final Presenter.ViewHolder mRowViewHolder; 57 58 final TimeAnimator mSelectAnimator = new TimeAnimator(); 59 60 int mSelectAnimatorDurationInUse; 61 Interpolator mSelectAnimatorInterpolatorInUse; 62 float mSelectLevelAnimStart; 63 float mSelectLevelAnimDelta; 64 65 RowViewHolderExtra(ItemBridgeAdapter.ViewHolder ibvh) { 66 mRowPresenter = (RowPresenter) ibvh.getPresenter(); 67 mRowViewHolder = ibvh.getViewHolder(); 68 mSelectAnimator.setTimeListener(this); 69 } 70 71 @Override 72 public void onTimeUpdate(TimeAnimator animation, long totalTime, long deltaTime) { 73 if (mSelectAnimator.isRunning()) { 74 updateSelect(totalTime, deltaTime); 75 } 76 } 77 78 void updateSelect(long totalTime, long deltaTime) { 79 float fraction; 80 if (totalTime >= mSelectAnimatorDurationInUse) { 81 fraction = 1; 82 mSelectAnimator.end(); 83 } else { 84 fraction = (float) (totalTime / (double) mSelectAnimatorDurationInUse); 85 } 86 if (mSelectAnimatorInterpolatorInUse != null) { 87 fraction = mSelectAnimatorInterpolatorInUse.getInterpolation(fraction); 88 } 89 float level = mSelectLevelAnimStart + fraction * mSelectLevelAnimDelta; 90 mRowPresenter.setSelectLevel(mRowViewHolder, level); 91 } 92 93 void animateSelect(boolean select, boolean immediate) { 94 endSelectAnimation(); 95 final float end = select ? 1 : 0; 96 if (immediate) { 97 mRowPresenter.setSelectLevel(mRowViewHolder, end); 98 } else if (mRowPresenter.getSelectLevel(mRowViewHolder) != end) { 99 mSelectAnimatorDurationInUse = mSelectAnimatorDuration; 100 mSelectAnimatorInterpolatorInUse = mSelectAnimatorInterpolator; 101 mSelectLevelAnimStart = mRowPresenter.getSelectLevel(mRowViewHolder); 102 mSelectLevelAnimDelta = end - mSelectLevelAnimStart; 103 mSelectAnimator.start(); 104 } 105 } 106 107 void endAnimations() { 108 endSelectAnimation(); 109 } 110 111 void endSelectAnimation() { 112 mSelectAnimator.end(); 113 } 114 115 } 116 117 private static final String TAG = "RowsSupportFragment"; 118 private static final boolean DEBUG = false; 119 120 private ItemBridgeAdapter.ViewHolder mSelectedViewHolder; 121 private boolean mExpand = true; 122 private boolean mViewsCreated; 123 private float mRowScaleFactor; 124 private int mAlignedTop; 125 private boolean mRowScaleEnabled; 126 private ScaleFrameLayout mScaleFrameLayout; 127 private boolean mInTransition; 128 private boolean mAfterEntranceTransition = true; 129 130 private OnItemSelectedListener mOnItemSelectedListener; 131 private OnItemViewSelectedListener mOnItemViewSelectedListener; 132 private OnItemClickedListener mOnItemClickedListener; 133 private OnItemViewClickedListener mOnItemViewClickedListener; 134 135 // Select animation and interpolator are not intended to be 136 // exposed at this moment. They might be synced with vertical scroll 137 // animation later. 138 int mSelectAnimatorDuration; 139 Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2); 140 141 private RecyclerView.RecycledViewPool mRecycledViewPool; 142 private ArrayList<Presenter> mPresenterMapper; 143 144 private ItemBridgeAdapter.AdapterListener mExternalAdapterListener; 145 146 @Override 147 protected VerticalGridView findGridViewFromRoot(View view) { 148 return (VerticalGridView) view.findViewById(R.id.container_list); 149 } 150 151 /** 152 * Sets an item clicked listener on the fragment. 153 * OnItemClickedListener will override {@link View.OnClickListener} that 154 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 155 * So in general, developer should choose one of the listeners but not both. 156 * @deprecated Use {@link #setOnItemViewClickedListener(OnItemViewClickedListener)} 157 */ 158 public void setOnItemClickedListener(OnItemClickedListener listener) { 159 mOnItemClickedListener = listener; 160 if (mViewsCreated) { 161 throw new IllegalStateException( 162 "Item clicked listener must be set before views are created"); 163 } 164 } 165 166 /** 167 * Returns the item clicked listener. 168 * @deprecated Use {@link #getOnItemClickedListener()} 169 */ 170 public OnItemClickedListener getOnItemClickedListener() { 171 return mOnItemClickedListener; 172 } 173 174 /** 175 * Sets an item clicked listener on the fragment. 176 * OnItemViewClickedListener will override {@link View.OnClickListener} that 177 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 178 * So in general, developer should choose one of the listeners but not both. 179 */ 180 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 181 mOnItemViewClickedListener = listener; 182 if (mViewsCreated) { 183 throw new IllegalStateException( 184 "Item clicked listener must be set before views are created"); 185 } 186 } 187 188 /** 189 * Returns the item clicked listener. 190 */ 191 public OnItemViewClickedListener getOnItemViewClickedListener() { 192 return mOnItemViewClickedListener; 193 } 194 195 /** 196 * Set the visibility of titles/hovercard of browse rows. 197 */ 198 public void setExpand(boolean expand) { 199 mExpand = expand; 200 VerticalGridView listView = getVerticalGridView(); 201 if (listView != null) { 202 updateRowScaling(); 203 final int count = listView.getChildCount(); 204 if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count); 205 for (int i = 0; i < count; i++) { 206 View view = listView.getChildAt(i); 207 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 208 setRowViewExpanded(vh, mExpand); 209 } 210 } 211 } 212 213 /** 214 * Sets an item selection listener. 215 * @deprecated Use {@link #setOnItemViewSelectedListener(OnItemViewSelectedListener)} 216 */ 217 public void setOnItemSelectedListener(OnItemSelectedListener listener) { 218 mOnItemSelectedListener = listener; 219 VerticalGridView listView = getVerticalGridView(); 220 if (listView != null) { 221 final int count = listView.getChildCount(); 222 for (int i = 0; i < count; i++) { 223 View view = listView.getChildAt(i); 224 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) 225 listView.getChildViewHolder(view); 226 setOnItemSelectedListener(vh, mOnItemSelectedListener); 227 } 228 } 229 } 230 231 /** 232 * Sets an item selection listener. 233 */ 234 public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) { 235 mOnItemViewSelectedListener = listener; 236 VerticalGridView listView = getVerticalGridView(); 237 if (listView != null) { 238 final int count = listView.getChildCount(); 239 for (int i = 0; i < count; i++) { 240 View view = listView.getChildAt(i); 241 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) 242 listView.getChildViewHolder(view); 243 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 244 } 245 } 246 } 247 248 /** 249 * Returns an item selection listener. 250 */ 251 public OnItemViewSelectedListener getOnItemViewSelectedListener() { 252 return mOnItemViewSelectedListener; 253 } 254 255 /** 256 * Enables scaling of rows. 257 * 258 * @param enable true to enable row scaling 259 */ 260 public void enableRowScaling(boolean enable) { 261 mRowScaleEnabled = enable; 262 } 263 264 @Override 265 void onRowSelected(ViewGroup parent, View view, int position, long id) { 266 VerticalGridView listView = getVerticalGridView(); 267 if (listView == null) { 268 return; 269 } 270 ItemBridgeAdapter.ViewHolder vh = (view == null) ? null : 271 (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 272 273 if (mSelectedViewHolder != vh) { 274 if (DEBUG) Log.v(TAG, "new row selected position " + position + " view " + view); 275 276 if (mSelectedViewHolder != null) { 277 setRowViewSelected(mSelectedViewHolder, false, false); 278 } 279 mSelectedViewHolder = vh; 280 if (mSelectedViewHolder != null) { 281 setRowViewSelected(mSelectedViewHolder, true, false); 282 } 283 } 284 } 285 286 @Override 287 int getLayoutResourceId() { 288 return R.layout.lb_rows_fragment; 289 } 290 291 @Override 292 public void onCreate(Bundle savedInstanceState) { 293 super.onCreate(savedInstanceState); 294 mSelectAnimatorDuration = getResources().getInteger( 295 R.integer.lb_browse_rows_anim_duration); 296 mRowScaleFactor = getResources().getFraction( 297 R.fraction.lb_browse_rows_scale, 1, 1); 298 } 299 300 @Override 301 public View onCreateView(LayoutInflater inflater, ViewGroup container, 302 Bundle savedInstanceState) { 303 View view = super.onCreateView(inflater, container, savedInstanceState); 304 mScaleFrameLayout = (ScaleFrameLayout) view.findViewById(R.id.scale_frame); 305 return view; 306 } 307 308 @Override 309 public void onViewCreated(View view, Bundle savedInstanceState) { 310 if (DEBUG) Log.v(TAG, "onViewCreated"); 311 super.onViewCreated(view, savedInstanceState); 312 // Align the top edge of child with id row_content. 313 // Need set this for directly using RowsSupportFragment. 314 getVerticalGridView().setItemAlignmentViewId(R.id.row_content); 315 getVerticalGridView().setSaveChildrenPolicy(VerticalGridView.SAVE_LIMITED_CHILD); 316 317 mRecycledViewPool = null; 318 mPresenterMapper = null; 319 } 320 321 @Override 322 void setItemAlignment() { 323 super.setItemAlignment(); 324 if (getVerticalGridView() != null) { 325 getVerticalGridView().setItemAlignmentOffsetWithPadding(true); 326 } 327 } 328 329 void setExternalAdapterListener(ItemBridgeAdapter.AdapterListener listener) { 330 mExternalAdapterListener = listener; 331 } 332 333 /** 334 * Get the view that will change scale. 335 */ 336 View getScaleView() { 337 return getVerticalGridView(); 338 } 339 340 /** 341 * Set pivots to scale rows fragment. 342 */ 343 void setScalePivots(float pivotX, float pivotY) { 344 // set pivot on ScaleFrameLayout, it will be propagated to its child VerticalGridView 345 // where we actually change scale. 346 mScaleFrameLayout.setPivotX(pivotX); 347 mScaleFrameLayout.setPivotY(pivotY); 348 } 349 350 private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) { 351 ((RowPresenter) vh.getPresenter()).setRowViewExpanded(vh.getViewHolder(), expanded); 352 } 353 354 private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, 355 boolean immediate) { 356 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 357 extra.animateSelect(selected, immediate); 358 ((RowPresenter) vh.getPresenter()).setRowViewSelected(vh.getViewHolder(), selected); 359 } 360 361 private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh, 362 OnItemSelectedListener listener) { 363 ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener); 364 } 365 366 private static void setOnItemViewSelectedListener(ItemBridgeAdapter.ViewHolder vh, 367 OnItemViewSelectedListener listener) { 368 ((RowPresenter) vh.getPresenter()).setOnItemViewSelectedListener(listener); 369 } 370 371 private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = 372 new ItemBridgeAdapter.AdapterListener() { 373 @Override 374 public void onAddPresenter(Presenter presenter, int type) { 375 ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener); 376 ((RowPresenter) presenter).setOnItemViewClickedListener(mOnItemViewClickedListener); 377 if (mExternalAdapterListener != null) { 378 mExternalAdapterListener.onAddPresenter(presenter, type); 379 } 380 } 381 @Override 382 public void onCreate(ItemBridgeAdapter.ViewHolder vh) { 383 VerticalGridView listView = getVerticalGridView(); 384 if (listView != null) { 385 // set clip children false for slide animation 386 listView.setClipChildren(false); 387 } 388 setupSharedViewPool(vh); 389 mViewsCreated = true; 390 vh.setExtraObject(new RowViewHolderExtra(vh)); 391 // selected state is initialized to false, then driven by grid view onChildSelected 392 // events. When there is rebind, grid view fires onChildSelected event properly. 393 // So we don't need do anything special later in onBind or onAttachedToWindow. 394 setRowViewSelected(vh, false, true); 395 if (mExternalAdapterListener != null) { 396 mExternalAdapterListener.onCreate(vh); 397 } 398 } 399 @Override 400 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) { 401 if (DEBUG) Log.v(TAG, "onAttachToWindow"); 402 // All views share the same mExpand value. When we attach a view to grid view, 403 // we should make sure it pick up the latest mExpand value we set early on other 404 // attached views. For no-structure-change update, the view is rebound to new data, 405 // but again it should use the unchanged mExpand value, so we don't need do any 406 // thing in onBind. 407 setRowViewExpanded(vh, mExpand); 408 setOnItemSelectedListener(vh, mOnItemSelectedListener); 409 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 410 RowPresenter rowPresenter = (RowPresenter) vh.getPresenter(); 411 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(vh.getViewHolder()); 412 rowPresenter.setEntranceTransitionState(rowVh, mAfterEntranceTransition); 413 if (mExternalAdapterListener != null) { 414 mExternalAdapterListener.onAttachedToWindow(vh); 415 } 416 } 417 @Override 418 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder vh) { 419 if (mSelectedViewHolder == vh) { 420 setRowViewSelected(mSelectedViewHolder, false, true); 421 mSelectedViewHolder = null; 422 } 423 if (mExternalAdapterListener != null) { 424 mExternalAdapterListener.onDetachedFromWindow(vh); 425 } 426 } 427 @Override 428 public void onBind(ItemBridgeAdapter.ViewHolder vh) { 429 if (mExternalAdapterListener != null) { 430 mExternalAdapterListener.onBind(vh); 431 } 432 } 433 @Override 434 public void onUnbind(ItemBridgeAdapter.ViewHolder vh) { 435 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 436 extra.endAnimations(); 437 if (mExternalAdapterListener != null) { 438 mExternalAdapterListener.onUnbind(vh); 439 } 440 } 441 }; 442 443 private void setupSharedViewPool(ItemBridgeAdapter.ViewHolder bridgeVh) { 444 RowPresenter rowPresenter = (RowPresenter) bridgeVh.getPresenter(); 445 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(bridgeVh.getViewHolder()); 446 447 if (rowVh instanceof ListRowPresenter.ViewHolder) { 448 HorizontalGridView view = ((ListRowPresenter.ViewHolder) rowVh).getGridView(); 449 // Recycled view pool is shared between all list rows 450 if (mRecycledViewPool == null) { 451 mRecycledViewPool = view.getRecycledViewPool(); 452 } else { 453 view.setRecycledViewPool(mRecycledViewPool); 454 } 455 456 ItemBridgeAdapter bridgeAdapter = 457 ((ListRowPresenter.ViewHolder) rowVh).getBridgeAdapter(); 458 if (mPresenterMapper == null) { 459 mPresenterMapper = bridgeAdapter.getPresenterMapper(); 460 } else { 461 bridgeAdapter.setPresenterMapper(mPresenterMapper); 462 } 463 } 464 } 465 466 @Override 467 void updateAdapter() { 468 super.updateAdapter(); 469 mSelectedViewHolder = null; 470 mViewsCreated = false; 471 472 ItemBridgeAdapter adapter = getBridgeAdapter(); 473 if (adapter != null) { 474 adapter.setAdapterListener(mBridgeAdapterListener); 475 } 476 } 477 478 @Override 479 void onTransitionStart() { 480 super.onTransitionStart(); 481 mInTransition = true; 482 freezeRows(true); 483 } 484 485 class ExpandPreLayout implements ViewTreeObserver.OnPreDrawListener { 486 487 final View mVerticalView; 488 final Runnable mCallback; 489 int mState; 490 491 final static int STATE_INIT = 0; 492 final static int STATE_FIRST_DRAW = 1; 493 final static int STATE_SECOND_DRAW = 2; 494 495 ExpandPreLayout(Runnable callback) { 496 mVerticalView = getVerticalGridView(); 497 mCallback = callback; 498 } 499 500 void execute() { 501 mVerticalView.getViewTreeObserver().addOnPreDrawListener(this); 502 setExpand(false); 503 mState = STATE_INIT; 504 } 505 506 @Override 507 public boolean onPreDraw() { 508 if (mState == STATE_INIT) { 509 setExpand(true); 510 mState = STATE_FIRST_DRAW; 511 } else if (mState == STATE_FIRST_DRAW) { 512 mCallback.run(); 513 mVerticalView.getViewTreeObserver().removeOnPreDrawListener(this); 514 mState = STATE_SECOND_DRAW; 515 } 516 return false; 517 } 518 } 519 520 void onExpandTransitionStart(boolean expand, final Runnable callback) { 521 onTransitionStart(); 522 if (expand) { 523 callback.run(); 524 return; 525 } 526 // Run a "pre" layout when we go non-expand, in order to get the initial 527 // positions of added rows. 528 new ExpandPreLayout(callback).execute(); 529 } 530 531 private boolean needsScale() { 532 return mRowScaleEnabled && !mExpand; 533 } 534 535 private void updateRowScaling() { 536 final float scaleFactor = needsScale() ? mRowScaleFactor : 1f; 537 mScaleFrameLayout.setLayoutScaleY(scaleFactor); 538 getScaleView().setScaleY(scaleFactor); 539 getScaleView().setScaleX(scaleFactor); 540 updateWindowAlignOffset(); 541 } 542 543 private void updateWindowAlignOffset() { 544 int alignOffset = mAlignedTop; 545 if (needsScale()) { 546 alignOffset = (int) (alignOffset / mRowScaleFactor + 0.5f); 547 } 548 getVerticalGridView().setWindowAlignmentOffset(alignOffset); 549 } 550 551 @Override 552 void setWindowAlignmentFromTop(int alignedTop) { 553 mAlignedTop = alignedTop; 554 final VerticalGridView gridView = getVerticalGridView(); 555 if (gridView != null) { 556 updateWindowAlignOffset(); 557 // align to a fixed position from top 558 gridView.setWindowAlignmentOffsetPercent( 559 VerticalGridView.WINDOW_ALIGN_OFFSET_PERCENT_DISABLED); 560 gridView.setWindowAlignment(VerticalGridView.WINDOW_ALIGN_NO_EDGE); 561 } 562 } 563 564 @Override 565 void onTransitionEnd() { 566 super.onTransitionEnd(); 567 mInTransition = false; 568 freezeRows(false); 569 } 570 571 private void freezeRows(boolean freeze) { 572 VerticalGridView verticalView = getVerticalGridView(); 573 if (verticalView != null) { 574 final int count = verticalView.getChildCount(); 575 for (int i = 0; i < count; i++) { 576 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 577 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 578 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 579 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 580 rowPresenter.freeze(vh, freeze); 581 } 582 } 583 } 584 585 /** 586 * For rows that willing to participate entrance transition, this function 587 * hide views if afterTransition is true, show views if afterTransition is false. 588 */ 589 void setEntranceTransitionState(boolean afterTransition) { 590 mAfterEntranceTransition = afterTransition; 591 VerticalGridView verticalView = getVerticalGridView(); 592 if (verticalView != null) { 593 final int count = verticalView.getChildCount(); 594 for (int i = 0; i < count; i++) { 595 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 596 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 597 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 598 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 599 rowPresenter.setEntranceTransitionState(vh, mAfterEntranceTransition); 600 } 601 } 602 } 603} 604