RowsSupportFragment.java revision 80a1d2dfbe5c1f26370cc1753c3ae321f126f5d2
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 android.animation.TimeAnimator; 19import android.animation.TimeAnimator.TimeListener; 20import android.os.Bundle; 21import android.support.v17.leanback.R; 22import android.support.v17.leanback.widget.HorizontalGridView; 23import android.support.v17.leanback.widget.ItemBridgeAdapter; 24import android.support.v17.leanback.widget.ListRowPresenter; 25import android.support.v17.leanback.widget.OnItemViewClickedListener; 26import android.support.v17.leanback.widget.OnItemViewSelectedListener; 27import android.support.v17.leanback.widget.Presenter; 28import android.support.v17.leanback.widget.RowPresenter; 29import android.support.v17.leanback.widget.VerticalGridView; 30import android.support.v17.leanback.widget.ViewHolderTask; 31import android.support.v7.widget.RecyclerView; 32import android.util.Log; 33import android.view.LayoutInflater; 34import android.view.View; 35import android.view.ViewGroup; 36import android.view.animation.DecelerateInterpolator; 37import android.view.animation.Interpolator; 38 39import java.util.ArrayList; 40 41/** 42 * An ordered set of rows of leanback widgets. 43 * <p> 44 * A RowsSupportFragment renders the elements of its 45 * {@link android.support.v17.leanback.widget.ObjectAdapter} as a set 46 * of rows in a vertical list. The elements in this adapter must be subclasses 47 * of {@link android.support.v17.leanback.widget.Row}. 48 * </p> 49 */ 50public class RowsSupportFragment extends BaseRowSupportFragment { 51 52 /** 53 * Internal helper class that manages row select animation and apply a default 54 * dim to each row. 55 */ 56 final class RowViewHolderExtra implements TimeListener { 57 final RowPresenter mRowPresenter; 58 final Presenter.ViewHolder mRowViewHolder; 59 60 final TimeAnimator mSelectAnimator = new TimeAnimator(); 61 62 int mSelectAnimatorDurationInUse; 63 Interpolator mSelectAnimatorInterpolatorInUse; 64 float mSelectLevelAnimStart; 65 float mSelectLevelAnimDelta; 66 67 RowViewHolderExtra(ItemBridgeAdapter.ViewHolder ibvh) { 68 mRowPresenter = (RowPresenter) ibvh.getPresenter(); 69 mRowViewHolder = ibvh.getViewHolder(); 70 mSelectAnimator.setTimeListener(this); 71 } 72 73 @Override 74 public void onTimeUpdate(TimeAnimator animation, long totalTime, long deltaTime) { 75 if (mSelectAnimator.isRunning()) { 76 updateSelect(totalTime, deltaTime); 77 } 78 } 79 80 void updateSelect(long totalTime, long deltaTime) { 81 float fraction; 82 if (totalTime >= mSelectAnimatorDurationInUse) { 83 fraction = 1; 84 mSelectAnimator.end(); 85 } else { 86 fraction = (float) (totalTime / (double) mSelectAnimatorDurationInUse); 87 } 88 if (mSelectAnimatorInterpolatorInUse != null) { 89 fraction = mSelectAnimatorInterpolatorInUse.getInterpolation(fraction); 90 } 91 float level = mSelectLevelAnimStart + fraction * mSelectLevelAnimDelta; 92 mRowPresenter.setSelectLevel(mRowViewHolder, level); 93 } 94 95 void animateSelect(boolean select, boolean immediate) { 96 mSelectAnimator.end(); 97 final float end = select ? 1 : 0; 98 if (immediate) { 99 mRowPresenter.setSelectLevel(mRowViewHolder, end); 100 } else if (mRowPresenter.getSelectLevel(mRowViewHolder) != end) { 101 mSelectAnimatorDurationInUse = mSelectAnimatorDuration; 102 mSelectAnimatorInterpolatorInUse = mSelectAnimatorInterpolator; 103 mSelectLevelAnimStart = mRowPresenter.getSelectLevel(mRowViewHolder); 104 mSelectLevelAnimDelta = end - mSelectLevelAnimStart; 105 mSelectAnimator.start(); 106 } 107 } 108 109 } 110 111 private static final String TAG = "RowsSupportFragment"; 112 private static final boolean DEBUG = false; 113 114 private ItemBridgeAdapter.ViewHolder mSelectedViewHolder; 115 private int mSubPosition; 116 private boolean mExpand = true; 117 private boolean mViewsCreated; 118 private int mAlignedTop; 119 private boolean mAfterEntranceTransition = true; 120 121 private OnItemViewSelectedListener mOnItemViewSelectedListener; 122 private OnItemViewClickedListener mOnItemViewClickedListener; 123 124 // Select animation and interpolator are not intended to be 125 // exposed at this moment. They might be synced with vertical scroll 126 // animation later. 127 int mSelectAnimatorDuration; 128 Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2); 129 130 private RecyclerView.RecycledViewPool mRecycledViewPool; 131 private ArrayList<Presenter> mPresenterMapper; 132 133 private ItemBridgeAdapter.AdapterListener mExternalAdapterListener; 134 135 @Override 136 protected VerticalGridView findGridViewFromRoot(View view) { 137 return (VerticalGridView) view.findViewById(R.id.container_list); 138 } 139 140 /** 141 * Sets an item clicked listener on the fragment. 142 * OnItemViewClickedListener 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 */ 146 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 147 mOnItemViewClickedListener = listener; 148 if (mViewsCreated) { 149 throw new IllegalStateException( 150 "Item clicked listener must be set before views are created"); 151 } 152 } 153 154 /** 155 * Returns the item clicked listener. 156 */ 157 public OnItemViewClickedListener getOnItemViewClickedListener() { 158 return mOnItemViewClickedListener; 159 } 160 161 /** 162 * @deprecated use {@link BrowseSupportFragment#enableRowScaling(boolean)} instead. 163 * 164 * @param enable true to enable row scaling 165 */ 166 public void enableRowScaling(boolean enable) { 167 } 168 169 /** 170 * Set the visibility of titles/hovercard of browse rows. 171 */ 172 public void setExpand(boolean expand) { 173 mExpand = expand; 174 VerticalGridView listView = getVerticalGridView(); 175 if (listView != null) { 176 final int count = listView.getChildCount(); 177 if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count); 178 for (int i = 0; i < count; i++) { 179 View view = listView.getChildAt(i); 180 ItemBridgeAdapter.ViewHolder vh 181 = (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 182 setRowViewExpanded(vh, mExpand); 183 } 184 } 185 } 186 187 /** 188 * Sets an item selection listener. 189 */ 190 public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) { 191 mOnItemViewSelectedListener = listener; 192 VerticalGridView listView = getVerticalGridView(); 193 if (listView != null) { 194 final int count = listView.getChildCount(); 195 for (int i = 0; i < count; i++) { 196 View view = listView.getChildAt(i); 197 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 198 listView.getChildViewHolder(view); 199 getRowViewHolder(ibvh).setOnItemViewSelectedListener(mOnItemViewSelectedListener); 200 } 201 } 202 } 203 204 /** 205 * Returns an item selection listener. 206 */ 207 public OnItemViewSelectedListener getOnItemViewSelectedListener() { 208 return mOnItemViewSelectedListener; 209 } 210 211 @Override 212 void onRowSelected(RecyclerView parent, RecyclerView.ViewHolder viewHolder, 213 int position, int subposition) { 214 if (mSelectedViewHolder != viewHolder || mSubPosition != subposition) { 215 if (DEBUG) Log.v(TAG, "new row selected position " + position + " subposition " 216 + subposition + " view " + viewHolder.itemView); 217 mSubPosition = subposition; 218 if (mSelectedViewHolder != null) { 219 setRowViewSelected(mSelectedViewHolder, false, false); 220 } 221 mSelectedViewHolder = (ItemBridgeAdapter.ViewHolder) viewHolder; 222 if (mSelectedViewHolder != null) { 223 setRowViewSelected(mSelectedViewHolder, true, false); 224 } 225 } 226 } 227 228 /** 229 * Get row ViewHolder at adapter position. Returns null if the row object is not in adapter or 230 * the row object has not been bound to a row view. 231 * 232 * @param position Position of row in adapter. 233 * @return Row ViewHolder at a given adapter position. 234 */ 235 public RowPresenter.ViewHolder getRowViewHolder(int position) { 236 VerticalGridView verticalView = getVerticalGridView(); 237 if (verticalView == null) { 238 return null; 239 } 240 return getRowViewHolder((ItemBridgeAdapter.ViewHolder) 241 verticalView.findViewHolderForAdapterPosition(position)); 242 } 243 244 @Override 245 int getLayoutResourceId() { 246 return R.layout.lb_rows_fragment; 247 } 248 249 @Override 250 public void onCreate(Bundle savedInstanceState) { 251 super.onCreate(savedInstanceState); 252 mSelectAnimatorDuration = getResources().getInteger( 253 R.integer.lb_browse_rows_anim_duration); 254 } 255 256 @Override 257 public void onViewCreated(View view, Bundle savedInstanceState) { 258 if (DEBUG) Log.v(TAG, "onViewCreated"); 259 super.onViewCreated(view, savedInstanceState); 260 // Align the top edge of child with id row_content. 261 // Need set this for directly using RowsSupportFragment. 262 getVerticalGridView().setItemAlignmentViewId(R.id.row_content); 263 getVerticalGridView().setSaveChildrenPolicy(VerticalGridView.SAVE_LIMITED_CHILD); 264 265 setAlignment(mAlignedTop); 266 267 mRecycledViewPool = null; 268 mPresenterMapper = null; 269 } 270 271 @Override 272 public void onDestroyView() { 273 mViewsCreated = false; 274 super.onDestroyView(); 275 } 276 277 void setExternalAdapterListener(ItemBridgeAdapter.AdapterListener listener) { 278 mExternalAdapterListener = listener; 279 } 280 281 private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) { 282 ((RowPresenter) vh.getPresenter()).setRowViewExpanded(vh.getViewHolder(), expanded); 283 } 284 285 private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, 286 boolean immediate) { 287 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 288 extra.animateSelect(selected, immediate); 289 ((RowPresenter) vh.getPresenter()).setRowViewSelected(vh.getViewHolder(), selected); 290 } 291 292 private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = 293 new ItemBridgeAdapter.AdapterListener() { 294 @Override 295 public void onAddPresenter(Presenter presenter, int type) { 296 if (mExternalAdapterListener != null) { 297 mExternalAdapterListener.onAddPresenter(presenter, type); 298 } 299 } 300 301 @Override 302 public void onCreate(ItemBridgeAdapter.ViewHolder vh) { 303 VerticalGridView listView = getVerticalGridView(); 304 if (listView != null) { 305 // set clip children false for slide animation 306 listView.setClipChildren(false); 307 } 308 setupSharedViewPool(vh); 309 mViewsCreated = true; 310 vh.setExtraObject(new RowViewHolderExtra(vh)); 311 // selected state is initialized to false, then driven by grid view onChildSelected 312 // events. When there is rebind, grid view fires onChildSelected event properly. 313 // So we don't need do anything special later in onBind or onAttachedToWindow. 314 setRowViewSelected(vh, false, true); 315 if (mExternalAdapterListener != null) { 316 mExternalAdapterListener.onCreate(vh); 317 } 318 } 319 320 @Override 321 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) { 322 if (DEBUG) Log.v(TAG, "onAttachToWindow"); 323 // All views share the same mExpand value. When we attach a view to grid view, 324 // we should make sure it pick up the latest mExpand value we set early on other 325 // attached views. For no-structure-change update, the view is rebound to new data, 326 // but again it should use the unchanged mExpand value, so we don't need do any 327 // thing in onBind. 328 setRowViewExpanded(vh, mExpand); 329 RowPresenter rowPresenter = (RowPresenter) vh.getPresenter(); 330 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(vh.getViewHolder()); 331 rowVh.setOnItemViewSelectedListener(mOnItemViewSelectedListener); 332 rowVh.setOnItemViewClickedListener(mOnItemViewClickedListener); 333 rowPresenter.setEntranceTransitionState(rowVh, mAfterEntranceTransition); 334 if (mExternalAdapterListener != null) { 335 mExternalAdapterListener.onAttachedToWindow(vh); 336 } 337 } 338 339 @Override 340 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder vh) { 341 if (mSelectedViewHolder == vh) { 342 setRowViewSelected(mSelectedViewHolder, false, true); 343 mSelectedViewHolder = null; 344 } 345 if (mExternalAdapterListener != null) { 346 mExternalAdapterListener.onDetachedFromWindow(vh); 347 } 348 } 349 350 @Override 351 public void onBind(ItemBridgeAdapter.ViewHolder vh) { 352 if (mExternalAdapterListener != null) { 353 mExternalAdapterListener.onBind(vh); 354 } 355 } 356 357 @Override 358 public void onUnbind(ItemBridgeAdapter.ViewHolder vh) { 359 setRowViewSelected(vh, false, true); 360 if (mExternalAdapterListener != null) { 361 mExternalAdapterListener.onUnbind(vh); 362 } 363 } 364 }; 365 366 private void setupSharedViewPool(ItemBridgeAdapter.ViewHolder bridgeVh) { 367 RowPresenter rowPresenter = (RowPresenter) bridgeVh.getPresenter(); 368 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(bridgeVh.getViewHolder()); 369 370 if (rowVh instanceof ListRowPresenter.ViewHolder) { 371 HorizontalGridView view = ((ListRowPresenter.ViewHolder) rowVh).getGridView(); 372 // Recycled view pool is shared between all list rows 373 if (mRecycledViewPool == null) { 374 mRecycledViewPool = view.getRecycledViewPool(); 375 } else { 376 view.setRecycledViewPool(mRecycledViewPool); 377 } 378 379 ItemBridgeAdapter bridgeAdapter = 380 ((ListRowPresenter.ViewHolder) rowVh).getBridgeAdapter(); 381 if (mPresenterMapper == null) { 382 mPresenterMapper = bridgeAdapter.getPresenterMapper(); 383 } else { 384 bridgeAdapter.setPresenterMapper(mPresenterMapper); 385 } 386 } 387 } 388 389 @Override 390 void updateAdapter() { 391 super.updateAdapter(); 392 mSelectedViewHolder = null; 393 mViewsCreated = false; 394 395 ItemBridgeAdapter adapter = getBridgeAdapter(); 396 if (adapter != null) { 397 adapter.setAdapterListener(mBridgeAdapterListener); 398 } 399 } 400 401 @Override 402 public boolean onTransitionPrepare() { 403 boolean prepared = super.onTransitionPrepare(); 404 if (prepared) { 405 freezeRows(true); 406 } 407 return prepared; 408 } 409 410 @Override 411 public void onTransitionEnd() { 412 super.onTransitionEnd(); 413 freezeRows(false); 414 } 415 416 private void freezeRows(boolean freeze) { 417 VerticalGridView verticalView = getVerticalGridView(); 418 if (verticalView != null) { 419 final int count = verticalView.getChildCount(); 420 for (int i = 0; i < count; i++) { 421 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 422 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 423 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 424 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 425 rowPresenter.freeze(vh, freeze); 426 } 427 } 428 } 429 430 /** 431 * For rows that willing to participate entrance transition, this function 432 * hide views if afterTransition is true, show views if afterTransition is false. 433 */ 434 public void setEntranceTransitionState(boolean afterTransition) { 435 mAfterEntranceTransition = afterTransition; 436 VerticalGridView verticalView = getVerticalGridView(); 437 if (verticalView != null) { 438 final int count = verticalView.getChildCount(); 439 for (int i = 0; i < count; i++) { 440 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 441 verticalView.getChildViewHolder(verticalView.getChildAt(i)); 442 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 443 RowPresenter.ViewHolder vh = rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 444 rowPresenter.setEntranceTransitionState(vh, mAfterEntranceTransition); 445 } 446 } 447 } 448 449 /** 450 * Selects a Row and perform an optional task on the Row. For example 451 * <code>setSelectedPosition(10, true, new ListRowPresenterSelectItemViewHolderTask(5))</code> 452 * Scroll to 11th row and selects 6th item on that row. The method will be ignored if 453 * RowsSupportFragment has not been created (i.e. before {@link #onCreateView(LayoutInflater, 454 * ViewGroup, Bundle)}). 455 * 456 * @param rowPosition Which row to select. 457 * @param smooth True to scroll to the row, false for no animation. 458 * @param rowHolderTask Task to perform on the Row. 459 */ 460 public void setSelectedPosition(int rowPosition, boolean smooth, 461 final Presenter.ViewHolderTask rowHolderTask) { 462 VerticalGridView verticalView = getVerticalGridView(); 463 if (verticalView == null) { 464 return; 465 } 466 ViewHolderTask task = null; 467 if (rowHolderTask != null) { 468 task = new ViewHolderTask() { 469 @Override 470 public void run(RecyclerView.ViewHolder rvh) { 471 rowHolderTask.run(getRowViewHolder((ItemBridgeAdapter.ViewHolder) rvh)); 472 } 473 }; 474 } 475 if (smooth) { 476 verticalView.setSelectedPositionSmooth(rowPosition, task); 477 } else { 478 verticalView.setSelectedPosition(rowPosition, task); 479 } 480 } 481 482 static RowPresenter.ViewHolder getRowViewHolder(ItemBridgeAdapter.ViewHolder ibvh) { 483 if (ibvh == null) { 484 return null; 485 } 486 RowPresenter rowPresenter = (RowPresenter) ibvh.getPresenter(); 487 return rowPresenter.getRowViewHolder(ibvh.getViewHolder()); 488 } 489 490 public boolean isScrolling() { 491 if (getVerticalGridView() == null) { 492 return false; 493 } 494 return getVerticalGridView().getScrollState() != HorizontalGridView.SCROLL_STATE_IDLE; 495 } 496 497 @Override 498 public void setAlignment(int windowAlignOffsetFromTop) { 499 mAlignedTop = windowAlignOffsetFromTop; 500 final VerticalGridView gridView = getVerticalGridView(); 501 502 if (gridView != null) { 503 gridView.setItemAlignmentOffset(0); 504 gridView.setItemAlignmentOffsetPercent( 505 VerticalGridView.ITEM_ALIGN_OFFSET_PERCENT_DISABLED); 506 gridView.setItemAlignmentOffsetWithPadding(true); 507 gridView.setWindowAlignmentOffset(mAlignedTop); 508 // align to a fixed position from top 509 gridView.setWindowAlignmentOffsetPercent( 510 VerticalGridView.WINDOW_ALIGN_OFFSET_PERCENT_DISABLED); 511 gridView.setWindowAlignment(VerticalGridView.WINDOW_ALIGN_NO_EDGE); 512 } 513 } 514} 515