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