RowsSupportFragment.java revision 1f97045e486f6680a5e8ddcff383df6988fc1b56
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 129 private OnItemSelectedListener mOnItemSelectedListener; 130 private OnItemViewSelectedListener mOnItemViewSelectedListener; 131 private OnItemClickedListener mOnItemClickedListener; 132 private OnItemViewClickedListener mOnItemViewClickedListener; 133 134 // Select animation and interpolator are not intended to be 135 // exposed at this moment. They might be synced with vertical scroll 136 // animation later. 137 int mSelectAnimatorDuration; 138 Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2); 139 140 private RecyclerView.RecycledViewPool mRecycledViewPool; 141 private ArrayList<Presenter> mPresenterMapper; 142 143 private ItemBridgeAdapter.AdapterListener mExternalAdapterListener; 144 145 @Override 146 protected VerticalGridView findGridViewFromRoot(View view) { 147 return (VerticalGridView) view.findViewById(R.id.container_list); 148 } 149 150 /** 151 * Sets an item clicked listener on the fragment. 152 * OnItemClickedListener will override {@link View.OnClickListener} that 153 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 154 * So in general, developer should choose one of the listeners but not both. 155 * @deprecated Use {@link #setOnItemViewClickedListener(OnItemViewClickedListener)} 156 */ 157 public void setOnItemClickedListener(OnItemClickedListener listener) { 158 mOnItemClickedListener = listener; 159 if (mViewsCreated) { 160 throw new IllegalStateException( 161 "Item clicked listener must be set before views are created"); 162 } 163 } 164 165 /** 166 * Returns the item clicked listener. 167 * @deprecated Use {@link #getOnItemClickedListener()} 168 */ 169 public OnItemClickedListener getOnItemClickedListener() { 170 return mOnItemClickedListener; 171 } 172 173 /** 174 * Sets an item clicked listener on the fragment. 175 * OnItemViewClickedListener will override {@link View.OnClickListener} that 176 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 177 * So in general, developer should choose one of the listeners but not both. 178 */ 179 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 180 mOnItemViewClickedListener = listener; 181 if (mViewsCreated) { 182 throw new IllegalStateException( 183 "Item clicked listener must be set before views are created"); 184 } 185 } 186 187 /** 188 * Returns the item clicked listener. 189 */ 190 public OnItemViewClickedListener getOnItemViewClickedListener() { 191 return mOnItemViewClickedListener; 192 } 193 194 /** 195 * Set the visibility of titles/hovercard of browse rows. 196 */ 197 public void setExpand(boolean expand) { 198 mExpand = expand; 199 VerticalGridView listView = getVerticalGridView(); 200 if (listView != null) { 201 if (!mInTransition) ((ViewGroup) mScaleFrameLayout.getParent()).setClipChildren(!needsScale()); 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 ((ViewGroup) mScaleFrameLayout.getParent()).setClipChildren(!needsScale()); 318 319 mRecycledViewPool = null; 320 mPresenterMapper = null; 321 } 322 323 @Override 324 void setItemAlignment() { 325 super.setItemAlignment(); 326 if (getVerticalGridView() != null) { 327 getVerticalGridView().setItemAlignmentOffsetWithPadding(true); 328 } 329 } 330 331 void setExternalAdapterListener(ItemBridgeAdapter.AdapterListener listener) { 332 mExternalAdapterListener = listener; 333 } 334 335 ScaleFrameLayout getScaleFrameLayout() { 336 return mScaleFrameLayout; 337 } 338 339 private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) { 340 ((RowPresenter) vh.getPresenter()).setRowViewExpanded(vh.getViewHolder(), expanded); 341 } 342 343 private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, 344 boolean immediate) { 345 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 346 extra.animateSelect(selected, immediate); 347 ((RowPresenter) vh.getPresenter()).setRowViewSelected(vh.getViewHolder(), selected); 348 } 349 350 private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh, 351 OnItemSelectedListener listener) { 352 ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener); 353 } 354 355 private static void setOnItemViewSelectedListener(ItemBridgeAdapter.ViewHolder vh, 356 OnItemViewSelectedListener listener) { 357 ((RowPresenter) vh.getPresenter()).setOnItemViewSelectedListener(listener); 358 } 359 360 private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = 361 new ItemBridgeAdapter.AdapterListener() { 362 @Override 363 public void onAddPresenter(Presenter presenter, int type) { 364 ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener); 365 ((RowPresenter) presenter).setOnItemViewClickedListener(mOnItemViewClickedListener); 366 if (mExternalAdapterListener != null) { 367 mExternalAdapterListener.onAddPresenter(presenter, type); 368 } 369 } 370 @Override 371 public void onCreate(ItemBridgeAdapter.ViewHolder vh) { 372 VerticalGridView listView = getVerticalGridView(); 373 if (listView != null && ((RowPresenter) vh.getPresenter()).canDrawOutOfBounds()) { 374 listView.setClipChildren(false); 375 } 376 setupSharedViewPool(vh); 377 mViewsCreated = true; 378 vh.setExtraObject(new RowViewHolderExtra(vh)); 379 // selected state is initialized to false, then driven by grid view onChildSelected 380 // events. When there is rebind, grid view fires onChildSelected event properly. 381 // So we don't need do anything special later in onBind or onAttachedToWindow. 382 setRowViewSelected(vh, false, true); 383 if (mExternalAdapterListener != null) { 384 mExternalAdapterListener.onCreate(vh); 385 } 386 } 387 @Override 388 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) { 389 if (DEBUG) Log.v(TAG, "onAttachToWindow"); 390 // All views share the same mExpand value. When we attach a view to grid view, 391 // we should make sure it pick up the latest mExpand value we set early on other 392 // attached views. For no-structure-change update, the view is rebound to new data, 393 // but again it should use the unchanged mExpand value, so we don't need do any 394 // thing in onBind. 395 setRowViewExpanded(vh, mExpand); 396 setOnItemSelectedListener(vh, mOnItemSelectedListener); 397 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 398 if (mExternalAdapterListener != null) { 399 mExternalAdapterListener.onAttachedToWindow(vh); 400 } 401 } 402 @Override 403 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder vh) { 404 if (mSelectedViewHolder == vh) { 405 setRowViewSelected(mSelectedViewHolder, false, true); 406 mSelectedViewHolder = null; 407 } 408 if (mExternalAdapterListener != null) { 409 mExternalAdapterListener.onDetachedFromWindow(vh); 410 } 411 } 412 @Override 413 public void onBind(ItemBridgeAdapter.ViewHolder vh) { 414 if (mExternalAdapterListener != null) { 415 mExternalAdapterListener.onBind(vh); 416 } 417 } 418 @Override 419 public void onUnbind(ItemBridgeAdapter.ViewHolder vh) { 420 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 421 extra.endAnimations(); 422 if (mExternalAdapterListener != null) { 423 mExternalAdapterListener.onUnbind(vh); 424 } 425 } 426 }; 427 428 private void setupSharedViewPool(ItemBridgeAdapter.ViewHolder bridgeVh) { 429 RowPresenter rowPresenter = (RowPresenter) bridgeVh.getPresenter(); 430 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(bridgeVh.getViewHolder()); 431 432 if (rowVh instanceof ListRowPresenter.ViewHolder) { 433 HorizontalGridView view = ((ListRowPresenter.ViewHolder) rowVh).getGridView(); 434 // Recycled view pool is shared between all list rows 435 if (mRecycledViewPool == null) { 436 mRecycledViewPool = view.getRecycledViewPool(); 437 } else { 438 view.setRecycledViewPool(mRecycledViewPool); 439 } 440 441 ItemBridgeAdapter bridgeAdapter = 442 ((ListRowPresenter.ViewHolder) rowVh).getBridgeAdapter(); 443 if (mPresenterMapper == null) { 444 mPresenterMapper = bridgeAdapter.getPresenterMapper(); 445 } else { 446 bridgeAdapter.setPresenterMapper(mPresenterMapper); 447 } 448 } 449 } 450 451 @Override 452 void updateAdapter() { 453 super.updateAdapter(); 454 mSelectedViewHolder = null; 455 mViewsCreated = false; 456 457 ItemBridgeAdapter adapter = getBridgeAdapter(); 458 if (adapter != null) { 459 adapter.setAdapterListener(mBridgeAdapterListener); 460 } 461 } 462 463 @Override 464 void onTransitionStart() { 465 super.onTransitionStart(); 466 ((ViewGroup) mScaleFrameLayout.getParent()).setClipChildren(!mRowScaleEnabled); 467 mInTransition = true; 468 freezeRows(true); 469 } 470 471 class ExpandPreLayout implements ViewTreeObserver.OnPreDrawListener { 472 473 final View mVerticalView; 474 final Runnable mCallback; 475 int mState; 476 477 final static int STATE_INIT = 0; 478 final static int STATE_FIRST_DRAW = 1; 479 final static int STATE_SECOND_DRAW = 2; 480 481 ExpandPreLayout(Runnable callback) { 482 mVerticalView = getVerticalGridView(); 483 mCallback = callback; 484 } 485 486 void execute() { 487 mVerticalView.getViewTreeObserver().addOnPreDrawListener(this); 488 setExpand(false); 489 mState = STATE_INIT; 490 } 491 492 @Override 493 public boolean onPreDraw() { 494 if (mState == STATE_INIT) { 495 setExpand(true); 496 mState = STATE_FIRST_DRAW; 497 } else if (mState == STATE_FIRST_DRAW) { 498 mCallback.run(); 499 mVerticalView.getViewTreeObserver().removeOnPreDrawListener(this); 500 mState = STATE_SECOND_DRAW; 501 } 502 return false; 503 } 504 } 505 506 void onExpandTransitionStart(boolean expand, final Runnable callback) { 507 onTransitionStart(); 508 if (expand) { 509 callback.run(); 510 return; 511 } 512 // Run a "pre" layout when we go non-expand, in order to get the initial 513 // positions of added rows. 514 new ExpandPreLayout(callback).execute(); 515 } 516 517 private boolean needsScale() { 518 return mRowScaleEnabled && !mExpand; 519 } 520 521 private void updateRowScaling() { 522 final float scaleFactor = needsScale() ? mRowScaleFactor : 1f; 523 mScaleFrameLayout.setLayoutScaleY(scaleFactor); 524 mScaleFrameLayout.setScaleY(scaleFactor); 525 mScaleFrameLayout.setScaleX(scaleFactor); 526 updateWindowAlignOffset(); 527 } 528 529 private void updateWindowAlignOffset() { 530 int alignOffset = mAlignedTop; 531 if (needsScale()) { 532 alignOffset = (int) (alignOffset / mRowScaleFactor + 0.5f); 533 } 534 getVerticalGridView().setWindowAlignmentOffset(alignOffset); 535 } 536 537 @Override 538 void setWindowAlignmentFromTop(int alignedTop) { 539 mAlignedTop = alignedTop; 540 final VerticalGridView gridView = getVerticalGridView(); 541 if (gridView != null) { 542 updateWindowAlignOffset(); 543 // align to a fixed position from top 544 gridView.setWindowAlignmentOffsetPercent( 545 VerticalGridView.WINDOW_ALIGN_OFFSET_PERCENT_DISABLED); 546 gridView.setWindowAlignment(VerticalGridView.WINDOW_ALIGN_NO_EDGE); 547 } 548 } 549 550 @Override 551 void onTransitionEnd() { 552 super.onTransitionEnd(); 553 mInTransition = false; 554 ((ViewGroup) mScaleFrameLayout.getParent()).setClipChildren(!needsScale()); 555 freezeRows(false); 556 } 557 558 private void freezeRows(boolean freeze) { 559 VerticalGridView verticalView = getVerticalGridView(); 560 if (verticalView != null) { 561 final int count = verticalView.getChildCount(); 562 for (int i = 0; i < count; i++) { 563 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 564 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 565 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 566 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 567 rowPresenter.freeze(vh, freeze); 568 } 569 } 570 } 571} 572