RowsFragment.java revision 4bf1df568033630004b24b1c1289f4943db8368c
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.graphics.Canvas; 21import android.os.Bundle; 22import android.support.v17.leanback.R; 23import android.support.v17.leanback.graphics.ColorOverlayDimmer; 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.animation.DecelerateInterpolator; 40import android.view.animation.Interpolator; 41 42/** 43 * An ordered set of rows of leanback widgets. 44 */ 45public class RowsFragment extends BaseRowFragment { 46 47 /** 48 * Internal helper class that manages row select animation and apply a default 49 * dim to each row. 50 */ 51 final class RowViewHolderExtra implements TimeListener { 52 final RowPresenter mRowPresenter; 53 final Presenter.ViewHolder mRowViewHolder; 54 55 final TimeAnimator mSelectAnimator = new TimeAnimator(); 56 final ColorOverlayDimmer mColorDimmer; 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 if (mRowPresenter.getSelectEffectEnabled() 68 && mRowPresenter.isUsingDefaultSelectEffect()) { 69 mColorDimmer = ColorOverlayDimmer.createDefault(ibvh.itemView.getContext()); 70 } else { 71 mColorDimmer = null; 72 } 73 } 74 75 @Override 76 public void onTimeUpdate(TimeAnimator animation, long totalTime, long deltaTime) { 77 if (mSelectAnimator.isRunning()) { 78 updateSelect(totalTime, deltaTime); 79 } 80 } 81 82 void updateSelect(long totalTime, long deltaTime) { 83 float fraction; 84 if (totalTime >= mSelectAnimatorDurationInUse) { 85 fraction = 1; 86 mSelectAnimator.end(); 87 } else { 88 fraction = (float) (totalTime / (double) mSelectAnimatorDurationInUse); 89 } 90 if (mSelectAnimatorInterpolatorInUse != null) { 91 fraction = mSelectAnimatorInterpolatorInUse.getInterpolation(fraction); 92 } 93 float level = mSelectLevelAnimStart + fraction * mSelectLevelAnimDelta; 94 if (mColorDimmer != null) { 95 mColorDimmer.setActiveLevel(level); 96 if (getVerticalGridView() != null) { 97 getVerticalGridView().invalidate(); 98 } 99 } 100 mRowPresenter.setSelectLevel(mRowViewHolder, level); 101 } 102 103 void animateSelect(boolean select, boolean immediate) { 104 endSelectAnimation(); 105 final float end = select ? 1 : 0; 106 if (immediate) { 107 mRowPresenter.setSelectLevel(mRowViewHolder, end); 108 if (mColorDimmer != null) { 109 mColorDimmer.setActiveLevel(end); 110 } 111 } else if (mRowPresenter.getSelectLevel(mRowViewHolder) != end) { 112 mSelectAnimatorDurationInUse = mSelectAnimatorDuration; 113 mSelectAnimatorInterpolatorInUse = mSelectAnimatorInterpolator; 114 mSelectLevelAnimStart = mRowPresenter.getSelectLevel(mRowViewHolder); 115 mSelectLevelAnimDelta = end - mSelectLevelAnimStart; 116 mSelectAnimator.start(); 117 } 118 } 119 120 void endAnimations() { 121 endSelectAnimation(); 122 } 123 124 void endSelectAnimation() { 125 mSelectAnimator.end(); 126 } 127 128 void drawDimForSelection(Canvas c) { 129 if (mColorDimmer != null) { 130 mColorDimmer.drawColorOverlay(c, mRowViewHolder.view, false); 131 } 132 } 133 } 134 135 private static final String TAG = "RowsFragment"; 136 private static final boolean DEBUG = false; 137 138 private ItemBridgeAdapter.ViewHolder mSelectedViewHolder; 139 private boolean mExpand = true; 140 private boolean mViewsCreated; 141 142 private OnItemSelectedListener mOnItemSelectedListener; 143 private OnItemViewSelectedListener mOnItemViewSelectedListener; 144 private OnItemClickedListener mOnItemClickedListener; 145 private OnItemViewClickedListener mOnItemViewClickedListener; 146 147 // Select animation and interpolator are not intended to be 148 // exposed at this moment. They might be synced with vertical scroll 149 // animation later. 150 int mSelectAnimatorDuration; 151 Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2); 152 153 private RecyclerView.RecycledViewPool mRecycledViewPool; 154 private ArrayList<Presenter> mPresenterMapper; 155 156 private ItemBridgeAdapter.AdapterListener mExternalAdapterListener; 157 158 /** 159 * Sets an item clicked listener on the fragment. 160 * OnItemClickedListener will override {@link View.OnClickListener} that 161 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 162 * So in general, developer should choose one of the listeners but not both. 163 * @deprecated Use {@link #setOnItemViewClickedListener(OnItemViewClickedListener)} 164 */ 165 public void setOnItemClickedListener(OnItemClickedListener listener) { 166 mOnItemClickedListener = listener; 167 if (mViewsCreated) { 168 throw new IllegalStateException( 169 "Item clicked listener must be set before views are created"); 170 } 171 } 172 173 /** 174 * Returns the item clicked listener. 175 * @deprecated Use {@link #getOnItemClickedListener()} 176 */ 177 public OnItemClickedListener getOnItemClickedListener() { 178 return mOnItemClickedListener; 179 } 180 181 /** 182 * Sets an item clicked listener on the fragment. 183 * OnItemViewClickedListener will override {@link View.OnClickListener} that 184 * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}. 185 * So in general, developer should choose one of the listeners but not both. 186 */ 187 public void setOnItemViewClickedListener(OnItemViewClickedListener listener) { 188 mOnItemViewClickedListener = listener; 189 if (mViewsCreated) { 190 throw new IllegalStateException( 191 "Item clicked listener must be set before views are created"); 192 } 193 } 194 195 /** 196 * Returns the item clicked listener. 197 */ 198 public OnItemViewClickedListener getOnItemViewClickedListener() { 199 return mOnItemViewClickedListener; 200 } 201 202 /** 203 * Set the visibility of titles/hovercard of browse rows. 204 */ 205 public void setExpand(boolean expand) { 206 mExpand = expand; 207 VerticalGridView listView = getVerticalGridView(); 208 if (listView != null) { 209 final int count = listView.getChildCount(); 210 if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count); 211 for (int i = 0; i < count; i++) { 212 View view = listView.getChildAt(i); 213 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 214 setRowViewExpanded(vh, mExpand); 215 } 216 } 217 } 218 219 /** 220 * Sets an item selection listener. 221 * @deprecated Use {@link #setOnItemViewSelectedListener(OnItemViewSelectedListener)} 222 */ 223 public void setOnItemSelectedListener(OnItemSelectedListener listener) { 224 mOnItemSelectedListener = 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 setOnItemSelectedListener(vh, mOnItemSelectedListener); 233 } 234 } 235 } 236 237 /** 238 * Sets an item selection listener. 239 */ 240 public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) { 241 mOnItemViewSelectedListener = listener; 242 VerticalGridView listView = getVerticalGridView(); 243 if (listView != null) { 244 final int count = listView.getChildCount(); 245 for (int i = 0; i < count; i++) { 246 View view = listView.getChildAt(i); 247 ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) 248 listView.getChildViewHolder(view); 249 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 250 } 251 } 252 } 253 254 /** 255 * Returns an item selection listener. 256 */ 257 public OnItemViewSelectedListener getOnItemViewSelectedListener() { 258 return mOnItemViewSelectedListener; 259 } 260 261 @Override 262 protected void onRowSelected(ViewGroup parent, View view, int position, long id) { 263 VerticalGridView listView = getVerticalGridView(); 264 if (listView == null) { 265 return; 266 } 267 ItemBridgeAdapter.ViewHolder vh = (view == null) ? null : 268 (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view); 269 270 if (mSelectedViewHolder != vh) { 271 if (DEBUG) Log.v(TAG, "new row selected position " + position + " view " + view); 272 273 if (mSelectedViewHolder != null) { 274 setRowViewSelected(mSelectedViewHolder, false, false); 275 } 276 mSelectedViewHolder = vh; 277 if (mSelectedViewHolder != null) { 278 setRowViewSelected(mSelectedViewHolder, true, false); 279 } 280 } 281 } 282 283 @Override 284 protected int getLayoutResourceId() { 285 return R.layout.lb_rows_fragment; 286 } 287 288 @Override 289 public void onCreate(Bundle savedInstanceState) { 290 super.onCreate(savedInstanceState); 291 mSelectAnimatorDuration = getResources().getInteger(R.integer.lb_browse_rows_anim_duration); 292 } 293 294 @Override 295 public void onViewCreated(View view, Bundle savedInstanceState) { 296 if (DEBUG) Log.v(TAG, "onViewCreated"); 297 super.onViewCreated(view, savedInstanceState); 298 // Align the top edge of child with id row_content. 299 // Need set this for directly using RowsFragment. 300 getVerticalGridView().setItemAlignmentViewId(R.id.row_content); 301 getVerticalGridView().addItemDecoration(mItemDecoration); 302 303 mRecycledViewPool = null; 304 mPresenterMapper = null; 305 } 306 307 @Override 308 void setItemAlignment() { 309 super.setItemAlignment(); 310 if (getVerticalGridView() != null) { 311 getVerticalGridView().setItemAlignmentOffsetWithPadding(true); 312 } 313 } 314 315 void setExternalAdapterListener(ItemBridgeAdapter.AdapterListener listener) { 316 mExternalAdapterListener = listener; 317 } 318 319 private RecyclerView.ItemDecoration mItemDecoration = new RecyclerView.ItemDecoration() { 320 @Override 321 public void onDrawOver(Canvas c, RecyclerView parent) { 322 final int count = parent.getChildCount(); 323 for (int i = 0; i < count; i++) { 324 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) 325 parent.getChildViewHolder(parent.getChildAt(i)); 326 RowViewHolderExtra extra = (RowViewHolderExtra) ibvh.getExtraObject(); 327 extra.drawDimForSelection(c); 328 } 329 } 330 }; 331 332 private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) { 333 ((RowPresenter) vh.getPresenter()).setRowViewExpanded(vh.getViewHolder(), expanded); 334 } 335 336 private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, 337 boolean immediate) { 338 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 339 extra.animateSelect(selected, immediate); 340 ((RowPresenter) vh.getPresenter()).setRowViewSelected(vh.getViewHolder(), selected); 341 } 342 343 private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh, 344 OnItemSelectedListener listener) { 345 ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener); 346 } 347 348 private static void setOnItemViewSelectedListener(ItemBridgeAdapter.ViewHolder vh, 349 OnItemViewSelectedListener listener) { 350 ((RowPresenter) vh.getPresenter()).setOnItemViewSelectedListener(listener); 351 } 352 353 private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = 354 new ItemBridgeAdapter.AdapterListener() { 355 @Override 356 public void onAddPresenter(Presenter presenter, int type) { 357 ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener); 358 ((RowPresenter) presenter).setOnItemViewClickedListener(mOnItemViewClickedListener); 359 if (mExternalAdapterListener != null) { 360 mExternalAdapterListener.onAddPresenter(presenter, type); 361 } 362 } 363 @Override 364 public void onCreate(ItemBridgeAdapter.ViewHolder vh) { 365 VerticalGridView listView = getVerticalGridView(); 366 if (listView != null && ((RowPresenter) vh.getPresenter()).canDrawOutOfBounds()) { 367 listView.setClipChildren(false); 368 } 369 setupSharedViewPool(vh); 370 mViewsCreated = true; 371 vh.setExtraObject(new RowViewHolderExtra(vh)); 372 // selected state is initialized to false, then driven by grid view onChildSelected 373 // events. When there is rebind, grid view fires onChildSelected event properly. 374 // So we don't need do anything special later in onBind or onAttachedToWindow. 375 setRowViewSelected(vh, false, true); 376 if (mExternalAdapterListener != null) { 377 mExternalAdapterListener.onCreate(vh); 378 } 379 } 380 @Override 381 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) { 382 if (DEBUG) Log.v(TAG, "onAttachToWindow"); 383 // All views share the same mExpand value. When we attach a view to grid view, 384 // we should make sure it pick up the latest mExpand value we set early on other 385 // attached views. For no-structure-change update, the view is rebound to new data, 386 // but again it should use the unchanged mExpand value, so we don't need do any 387 // thing in onBind. 388 setRowViewExpanded(vh, mExpand); 389 setOnItemSelectedListener(vh, mOnItemSelectedListener); 390 setOnItemViewSelectedListener(vh, mOnItemViewSelectedListener); 391 if (mExternalAdapterListener != null) { 392 mExternalAdapterListener.onAttachedToWindow(vh); 393 } 394 } 395 @Override 396 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder vh) { 397 if (mExternalAdapterListener != null) { 398 mExternalAdapterListener.onDetachedFromWindow(vh); 399 } 400 } 401 @Override 402 public void onBind(ItemBridgeAdapter.ViewHolder vh) { 403 if (mExternalAdapterListener != null) { 404 mExternalAdapterListener.onBind(vh); 405 } 406 } 407 @Override 408 public void onUnbind(ItemBridgeAdapter.ViewHolder vh) { 409 RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject(); 410 extra.endAnimations(); 411 if (mExternalAdapterListener != null) { 412 mExternalAdapterListener.onUnbind(vh); 413 } 414 } 415 }; 416 417 private void setupSharedViewPool(ItemBridgeAdapter.ViewHolder bridgeVh) { 418 RowPresenter rowPresenter = (RowPresenter) bridgeVh.getPresenter(); 419 RowPresenter.ViewHolder rowVh = rowPresenter.getRowViewHolder(bridgeVh.getViewHolder()); 420 421 if (rowVh instanceof ListRowPresenter.ViewHolder) { 422 HorizontalGridView view = ((ListRowPresenter.ViewHolder) rowVh).getGridView(); 423 // Recycled view pool is shared between all list rows 424 if (mRecycledViewPool == null) { 425 mRecycledViewPool = view.getRecycledViewPool(); 426 } else { 427 view.setRecycledViewPool(mRecycledViewPool); 428 } 429 430 ItemBridgeAdapter bridgeAdapter = 431 ((ListRowPresenter.ViewHolder) rowVh).getBridgeAdapter(); 432 if (mPresenterMapper == null) { 433 mPresenterMapper = bridgeAdapter.getPresenterMapper(); 434 } else { 435 bridgeAdapter.setPresenterMapper(mPresenterMapper); 436 } 437 } 438 } 439 440 @Override 441 protected void updateAdapter() { 442 super.updateAdapter(); 443 mSelectedViewHolder = null; 444 mViewsCreated = false; 445 446 ItemBridgeAdapter adapter = getBridgeAdapter(); 447 if (adapter != null) { 448 adapter.setAdapterListener(mBridgeAdapterListener); 449 } 450 } 451 452} 453