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