RowsSupportFragment.java revision 6193c12a1897723c87b41f4e304a8cd04deef2dc
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.VerticalGridView; 29import android.support.v17.leanback.widget.HorizontalGridView; 30import android.support.v17.leanback.widget.OnItemSelectedListener; 31import android.support.v17.leanback.widget.OnItemClickedListener; 32import android.support.v17.leanback.widget.RowPresenter; 33import android.support.v17.leanback.widget.ListRowPresenter; 34import android.support.v17.leanback.widget.Presenter; 35import android.support.v7.widget.RecyclerView; 36import android.util.Log; 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 RowsSupportFragment extends BaseRowSupportFragment { 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 = "RowsSupportFragment"; 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 boolean mRowScaleEnabled; 123 124 private OnItemSelectedListener mOnItemSelectedListener; 125 private OnItemViewSelectedListener mOnItemViewSelectedListener; 126 private OnItemClickedListener mOnItemClickedListener; 127 private OnItemViewClickedListener mOnItemViewClickedListener; 128 129 // Select animation and interpolator are not intended to be 130 // exposed at this moment. They might be synced with vertical scroll 131 // animation later. 132 int mSelectAnimatorDuration; 133 Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2); 134 135 private RecyclerView.RecycledViewPool mRecycledViewPool; 136 private ArrayList<Presenter> mPresenterMapper; 137 138 private ItemBridgeAdapter.AdapterListener mExternalAdapterListener; 139 140 /** 141 * Sets an item clicked listener on the fragment. 142 * OnItemClickedListener will override {@link View.OnClickListener} that 143 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 144 * So in general, developer should choose one of the listeners but not both. 145 * @deprecated Use {@link #setOnItemViewClickedListener(OnItemViewClickedListener)} 146 */ 147 public void setOnItemClickedListener(OnItemClickedListener listener) { 148 mOnItemClickedListener = listener; 149 if (mViewsCreated) { 150 throw new IllegalStateException( 151 "Item clicked listener must be set before views are created"); 152 } 153 } 154 155 /** 156 * Returns the item clicked listener. 157 * @deprecated Use {@link #getOnItemClickedListener()} 158 */ 159 public OnItemClickedListener getOnItemClickedListener() { 160 return mOnItemClickedListener; 161 } 162 163 /** 164 * Sets an item clicked listener on the fragment. 165 * OnItemViewClickedListener will override {@link View.OnClickListener} that 166 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 167 * So in general, developer should choose one of the listeners but not both. 168 */ 169 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 170 mOnItemViewClickedListener = listener; 171 if (mViewsCreated) { 172 throw new IllegalStateException( 173 "Item clicked listener must be set before views are created"); 174 } 175 } 176 177 /** 178 * Returns the item clicked listener. 179 */ 180 public OnItemViewClickedListener getOnItemViewClickedListener() { 181 return mOnItemViewClickedListener; 182 } 183 184 /** 185 * Set the visibility of titles/hovercard of browse rows. 186 */ 187 public void setExpand(boolean expand) { 188 mExpand = expand; 189 VerticalGridView listView = getVerticalGridView(); 190 if (listView != null) { 191 updateRowScaling(!expand); 192 final int count = listView.getChildCount(); 193 if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count); 194 for (int i = 0; i < count; i++) { 195 View view = listView.getChildAt(i); 196 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 197 setRowViewExpanded(vh, mExpand); 198 } 199 } 200 } 201 202 /** 203 * Sets an item selection listener. 204 * @deprecated Use {@link #setOnItemViewSelectedListener(OnItemViewSelectedListener)} 205 */ 206 public void setOnItemSelectedListener(OnItemSelectedListener listener) { 207 mOnItemSelectedListener = listener; 208 VerticalGridView listView = getVerticalGridView(); 209 if (listView != null) { 210 final int count = listView.getChildCount(); 211 for (int i = 0; i < count; i++) { 212 View view = listView.getChildAt(i); 213 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) 214 listView.getChildViewHolder(view); 215 setOnItemSelectedListener(vh, mOnItemSelectedListener); 216 } 217 } 218 } 219 220 /** 221 * Sets an item selection listener. 222 */ 223 public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) { 224 mOnItemViewSelectedListener = listener; 225 VerticalGridView listView = getVerticalGridView(); 226 if (listView != null) { 227 final int count = listView.getChildCount(); 228 for (int i = 0; i < count; i++) { 229 View view = listView.getChildAt(i); 230 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) 231 listView.getChildViewHolder(view); 232 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 233 } 234 } 235 } 236 237 /** 238 * Returns an item selection listener. 239 */ 240 public OnItemViewSelectedListener getOnItemViewSelectedListener() { 241 return mOnItemViewSelectedListener; 242 } 243 244 /** 245 * Enables scaling of rows. 246 * 247 * @param enable true to enable row scaling 248 */ 249 public void enableRowScaling(boolean enable) { 250 mRowScaleEnabled = enable; 251 } 252 253 @Override 254 protected void onRowSelected(ViewGroup parent, View view, int position, long id) { 255 VerticalGridView listView = getVerticalGridView(); 256 if (listView == null) { 257 return; 258 } 259 ItemBridgeAdapter.ViewHolder vh = (view == null) ? null : 260 (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 261 262 if (mSelectedViewHolder != vh) { 263 if (DEBUG) Log.v(TAG, "new row selected position " + position + " view " + view); 264 265 if (mSelectedViewHolder != null) { 266 setRowViewSelected(mSelectedViewHolder, false, false); 267 } 268 mSelectedViewHolder = vh; 269 if (mSelectedViewHolder != null) { 270 setRowViewSelected(mSelectedViewHolder, true, false); 271 } 272 } 273 } 274 275 @Override 276 protected int getLayoutResourceId() { 277 return R.layout.lb_rows_fragment; 278 } 279 280 @Override 281 public void onCreate(Bundle savedInstanceState) { 282 super.onCreate(savedInstanceState); 283 mSelectAnimatorDuration = getResources().getInteger( 284 R.integer.lb_browse_rows_anim_duration); 285 mRowScaleFactor = getResources().getFraction( 286 R.fraction.lb_browse_rows_scale, 1, 1); 287 } 288 289 @Override 290 public void onViewCreated(View view, Bundle savedInstanceState) { 291 if (DEBUG) Log.v(TAG, "onViewCreated"); 292 super.onViewCreated(view, savedInstanceState); 293 // Align the top edge of child with id row_content. 294 // Need set this for directly using RowsSupportFragment. 295 getVerticalGridView().setItemAlignmentViewId(R.id.row_content); 296 getVerticalGridView().setSaveChildrenPolicy(VerticalGridView.SAVE_LIMITED_CHILD); 297 298 mRecycledViewPool = null; 299 mPresenterMapper = null; 300 } 301 302 @Override 303 void setItemAlignment() { 304 super.setItemAlignment(); 305 if (getVerticalGridView() != null) { 306 getVerticalGridView().setItemAlignmentOffsetWithPadding(true); 307 } 308 } 309 310 void setExternalAdapterListener(ItemBridgeAdapter.AdapterListener listener) { 311 mExternalAdapterListener = listener; 312 } 313 314 private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) { 315 ((RowPresenter) vh.getPresenter()).setRowViewExpanded(vh.getViewHolder(), expanded); 316 } 317 318 private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, 319 boolean immediate) { 320 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 321 extra.animateSelect(selected, immediate); 322 ((RowPresenter) vh.getPresenter()).setRowViewSelected(vh.getViewHolder(), selected); 323 } 324 325 private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh, 326 OnItemSelectedListener listener) { 327 ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener); 328 } 329 330 private static void setOnItemViewSelectedListener(ItemBridgeAdapter.ViewHolder vh, 331 OnItemViewSelectedListener listener) { 332 ((RowPresenter) vh.getPresenter()).setOnItemViewSelectedListener(listener); 333 } 334 335 private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = 336 new ItemBridgeAdapter.AdapterListener() { 337 @Override 338 public void onAddPresenter(Presenter presenter, int type) { 339 ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener); 340 ((RowPresenter) presenter).setOnItemViewClickedListener(mOnItemViewClickedListener); 341 if (mExternalAdapterListener != null) { 342 mExternalAdapterListener.onAddPresenter(presenter, type); 343 } 344 } 345 @Override 346 public void onCreate(ItemBridgeAdapter.ViewHolder vh) { 347 VerticalGridView listView = getVerticalGridView(); 348 if (listView != null && ((RowPresenter) vh.getPresenter()).canDrawOutOfBounds()) { 349 listView.setClipChildren(false); 350 } 351 setupSharedViewPool(vh); 352 mViewsCreated = true; 353 vh.setExtraObject(new RowViewHolderExtra(vh)); 354 // selected state is initialized to false, then driven by grid view onChildSelected 355 // events. When there is rebind, grid view fires onChildSelected event properly. 356 // So we don't need do anything special later in onBind or onAttachedToWindow. 357 setRowViewSelected(vh, false, true); 358 if (mExternalAdapterListener != null) { 359 mExternalAdapterListener.onCreate(vh); 360 } 361 } 362 @Override 363 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) { 364 if (DEBUG) Log.v(TAG, "onAttachToWindow"); 365 // All views share the same mExpand value. When we attach a view to grid view, 366 // we should make sure it pick up the latest mExpand value we set early on other 367 // attached views. For no-structure-change update, the view is rebound to new data, 368 // but again it should use the unchanged mExpand value, so we don't need do any 369 // thing in onBind. 370 setRowViewExpanded(vh, mExpand); 371 setOnItemSelectedListener(vh, mOnItemSelectedListener); 372 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 373 if (mExternalAdapterListener != null) { 374 mExternalAdapterListener.onAttachedToWindow(vh); 375 } 376 } 377 @Override 378 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder vh) { 379 if (mSelectedViewHolder == vh) { 380 setRowViewSelected(mSelectedViewHolder, false, true); 381 mSelectedViewHolder = null; 382 } 383 if (mExternalAdapterListener != null) { 384 mExternalAdapterListener.onDetachedFromWindow(vh); 385 } 386 } 387 @Override 388 public void onBind(ItemBridgeAdapter.ViewHolder vh) { 389 if (mExternalAdapterListener != null) { 390 mExternalAdapterListener.onBind(vh); 391 } 392 } 393 @Override 394 public void onUnbind(ItemBridgeAdapter.ViewHolder vh) { 395 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 396 extra.endAnimations(); 397 if (mExternalAdapterListener != null) { 398 mExternalAdapterListener.onUnbind(vh); 399 } 400 } 401 }; 402 403 private void setupSharedViewPool(ItemBridgeAdapter.ViewHolder bridgeVh) { 404 RowPresenter rowPresenter = (RowPresenter) bridgeVh.getPresenter(); 405 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(bridgeVh.getViewHolder()); 406 407 if (rowVh instanceof ListRowPresenter.ViewHolder) { 408 HorizontalGridView view = ((ListRowPresenter.ViewHolder) rowVh).getGridView(); 409 // Recycled view pool is shared between all list rows 410 if (mRecycledViewPool == null) { 411 mRecycledViewPool = view.getRecycledViewPool(); 412 } else { 413 view.setRecycledViewPool(mRecycledViewPool); 414 } 415 416 ItemBridgeAdapter bridgeAdapter = 417 ((ListRowPresenter.ViewHolder) rowVh).getBridgeAdapter(); 418 if (mPresenterMapper == null) { 419 mPresenterMapper = bridgeAdapter.getPresenterMapper(); 420 } else { 421 bridgeAdapter.setPresenterMapper(mPresenterMapper); 422 } 423 } 424 } 425 426 @Override 427 protected void updateAdapter() { 428 super.updateAdapter(); 429 mSelectedViewHolder = null; 430 mViewsCreated = false; 431 432 ItemBridgeAdapter adapter = getBridgeAdapter(); 433 if (adapter != null) { 434 adapter.setAdapterListener(mBridgeAdapterListener); 435 } 436 } 437 438 @Override 439 void onTransitionStart() { 440 super.onTransitionStart(); 441 freezeRows(true); 442 } 443 444 class ExpandPreLayout implements ViewTreeObserver.OnPreDrawListener { 445 446 final View mVerticalView; 447 final Runnable mCallback; 448 int mState; 449 450 final static int STATE_INIT = 0; 451 final static int STATE_FIRST_DRAW = 1; 452 final static int STATE_SECOND_DRAW = 2; 453 454 ExpandPreLayout(Runnable callback) { 455 mVerticalView = getVerticalGridView(); 456 mCallback = callback; 457 } 458 459 void execute() { 460 mVerticalView.getViewTreeObserver().addOnPreDrawListener(this); 461 setExpand(false); 462 mState = STATE_INIT; 463 } 464 465 @Override 466 public boolean onPreDraw() { 467 if (mState == STATE_INIT) { 468 setExpand(true); 469 mState = STATE_FIRST_DRAW; 470 } else if (mState == STATE_FIRST_DRAW) { 471 mCallback.run(); 472 mVerticalView.getViewTreeObserver().removeOnPreDrawListener(this); 473 mState = STATE_SECOND_DRAW; 474 } 475 return false; 476 } 477 } 478 479 void onExpandTransitionStart(boolean expand, final Runnable callback) { 480 onTransitionStart(); 481 if (expand) { 482 callback.run(); 483 return; 484 } 485 // Run a "pre" layout when we go non-expand, in order to get the initial 486 // positions of added rows. 487 new ExpandPreLayout(callback).execute(); 488 } 489 490 private void updateRowScaling(boolean scale) { 491 VerticalGridView view = getVerticalGridView(); 492 ((ViewGroup) view.getParent()).setClipChildren(!mRowScaleEnabled && scale); 493 view.setPrimaryOverReach((mRowScaleEnabled && scale) ? 1f / mRowScaleFactor : 1f); 494 495 final float scaleFactor = (mRowScaleEnabled && scale) ? mRowScaleFactor : 1f; 496 view.setScaleX(scaleFactor); 497 view.setScaleY(scaleFactor); 498 } 499 500 @Override 501 void onTransitionEnd() { 502 super.onTransitionEnd(); 503 freezeRows(false); 504 } 505 506 private void freezeRows(boolean freeze) { 507 VerticalGridView verticalView = getVerticalGridView(); 508 if (verticalView != null) { 509 final int count = verticalView.getChildCount(); 510 for (int i = 0; i < count; i++) { 511 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 512 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 513 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 514 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 515 rowPresenter.freeze(vh, freeze); 516 } 517 } 518 } 519} 520