ListRowPresenter.java revision 9de363b8db05106b03d115c266859fe200d41db7
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.widget; 15 16import android.content.Context; 17import android.content.res.TypedArray; 18import android.support.v17.leanback.R; 19import android.support.v17.leanback.graphics.ColorOverlayDimmer; 20import android.util.Log; 21import android.view.View; 22import android.view.ViewGroup; 23import android.view.ViewGroup.LayoutParams; 24 25/** 26 * ListRowPresenter renders {@link ListRow} using a 27 * {@link HorizontalGridView} hosted in a {@link ListRowView}. 28 * 29 * <h3>Hover card</h3> 30 * Optionally, {@link #setHoverCardPresenterSelector(PresenterSelector)} can be used to 31 * display a view for the currently focused list item below the rendered 32 * list. This view is known as a hover card. 33 * 34 * <h3>Selection animation</h3> 35 * ListRowPresenter disables {@link RowPresenter}'s default dimming effect and draw 36 * a dim overlay on top of each individual child items. Subclass may override and disable 37 * {@link #isUsingDefaultListSelectEffect()} and write its own dim effect in 38 * {@link #onSelectLevelChanged(RowPresenter.ViewHolder)}. 39 * 40 * <h3>Shadow</h3> 41 * ListRowPresenter applies a default shadow to child of each view. Call 42 * {@link #setShadowEnabled(boolean)} to disable shadow. Subclass may override and return 43 * false in {@link #isUsingDefaultShadow()} and replace with its own shadow implementation. 44 */ 45public class ListRowPresenter extends RowPresenter { 46 47 private static final String TAG = "ListRowPresenter"; 48 private static final boolean DEBUG = false; 49 50 public static class ViewHolder extends RowPresenter.ViewHolder { 51 final ListRowPresenter mListRowPresenter; 52 final HorizontalGridView mGridView; 53 final ItemBridgeAdapter mItemBridgeAdapter = new ItemBridgeAdapter(); 54 final HorizontalHoverCardSwitcher mHoverCardViewSwitcher = new HorizontalHoverCardSwitcher(); 55 final ColorOverlayDimmer mColorDimmer; 56 final int mPaddingTop; 57 final int mPaddingBottom; 58 final int mPaddingLeft; 59 final int mPaddingRight; 60 61 public ViewHolder(View rootView, HorizontalGridView gridView, ListRowPresenter p) { 62 super(rootView); 63 mGridView = gridView; 64 mListRowPresenter = p; 65 mColorDimmer = ColorOverlayDimmer.createDefault(rootView.getContext()); 66 mPaddingTop = mGridView.getPaddingTop(); 67 mPaddingBottom = mGridView.getPaddingBottom(); 68 mPaddingLeft = mGridView.getPaddingLeft(); 69 mPaddingRight = mGridView.getPaddingRight(); 70 } 71 72 public final ListRowPresenter getListRowPresenter() { 73 return mListRowPresenter; 74 } 75 76 public final HorizontalGridView getGridView() { 77 return mGridView; 78 } 79 80 public final ItemBridgeAdapter getBridgeAdapter() { 81 return mItemBridgeAdapter; 82 } 83 } 84 85 private int mRowHeight; 86 private int mExpandedRowHeight; 87 private PresenterSelector mHoverCardPresenterSelector; 88 private int mZoomFactor; 89 private boolean mShadowEnabled = true; 90 private int mBrowseRowsFadingEdgeLength = -1; 91 92 private static int sSelectedRowTopPadding; 93 private static int sExpandedSelectedRowTopPadding; 94 private static int sExpandedRowNoHovercardBottomPadding; 95 96 /** 97 * Constructs a ListRowPresenter with defaults. 98 * Uses {@link FocusHighlight#ZOOM_FACTOR_MEDIUM} for focus zooming. 99 */ 100 public ListRowPresenter() { 101 this(FocusHighlight.ZOOM_FACTOR_MEDIUM); 102 } 103 104 /** 105 * Constructs a ListRowPresenter with the given parameters. 106 * 107 * @param zoomFactor Controls the zoom factor used when an item view is focused. One of 108 * {@link FocusHighlight#ZOOM_FACTOR_NONE}, 109 * {@link FocusHighlight#ZOOM_FACTOR_SMALL}, 110 * {@link FocusHighlight#ZOOM_FACTOR_MEDIUM}, 111 * {@link FocusHighlight#ZOOM_FACTOR_LARGE} 112 */ 113 public ListRowPresenter(int zoomFactor) { 114 mZoomFactor = zoomFactor; 115 } 116 117 /** 118 * Sets the row height for rows created by this Presenter. Rows 119 * created before calling this method will not be updated. 120 * 121 * @param rowHeight Row height in pixels, or WRAP_CONTENT, or 0 122 * to use the default height. 123 */ 124 public void setRowHeight(int rowHeight) { 125 mRowHeight = rowHeight; 126 } 127 128 /** 129 * Returns the row height for list rows created by this Presenter. 130 */ 131 public int getRowHeight() { 132 return mRowHeight; 133 } 134 135 /** 136 * Sets the expanded row height for rows created by this Presenter. 137 * If not set, expanded rows have the same height as unexpanded 138 * rows. 139 * 140 * @param rowHeight The row height in to use when the row is expanded, 141 * in pixels, or WRAP_CONTENT, or 0 to use the default. 142 */ 143 public void setExpandedRowHeight(int rowHeight) { 144 mExpandedRowHeight = rowHeight; 145 } 146 147 /** 148 * Returns the expanded row height for rows created by this Presenter. 149 */ 150 public int getExpandedRowHeight() { 151 return mExpandedRowHeight != 0 ? mExpandedRowHeight : mRowHeight; 152 } 153 154 /** 155 * Returns the zoom factor used for focus highlighting. 156 */ 157 public final int getZoomFactor() { 158 return mZoomFactor; 159 } 160 161 private ItemBridgeAdapter.Wrapper mCardWrapper = new ItemBridgeAdapter.Wrapper() { 162 @Override 163 public View createWrapper(View root) { 164 ShadowOverlayContainer wrapper = new ShadowOverlayContainer(root.getContext()); 165 wrapper.setLayoutParams( 166 new LayoutParams(LayoutParams.WRAP_CONTENT, LayoutParams.WRAP_CONTENT)); 167 wrapper.initialize(needsDefaultShadow(), needsDefaultListSelectEffect()); 168 return wrapper; 169 } 170 @Override 171 public void wrap(View wrapper, View wrapped) { 172 ((ShadowOverlayContainer) wrapper).wrap(wrapped); 173 } 174 }; 175 176 @Override 177 protected void initializeRowViewHolder(RowPresenter.ViewHolder holder) { 178 super.initializeRowViewHolder(holder); 179 final ViewHolder rowViewHolder = (ViewHolder) holder; 180 if (needsDefaultListSelectEffect() || needsDefaultShadow()) { 181 rowViewHolder.mItemBridgeAdapter.setWrapper(mCardWrapper); 182 } 183 if (needsDefaultListSelectEffect()) { 184 ShadowOverlayContainer.prepareParentForShadow(rowViewHolder.mGridView); 185 ((ViewGroup) rowViewHolder.view).setClipChildren(false); 186 if (rowViewHolder.mContainerViewHolder != null) { 187 ((ViewGroup) rowViewHolder.mContainerViewHolder.view).setClipChildren(false); 188 } 189 } 190 FocusHighlightHelper.setupBrowseItemFocusHighlight(rowViewHolder.mItemBridgeAdapter, mZoomFactor); 191 rowViewHolder.mGridView.setFocusDrawingOrderEnabled(!isUsingZOrder()); 192 rowViewHolder.mGridView.setOnChildSelectedListener( 193 new OnChildSelectedListener() { 194 @Override 195 public void onChildSelected(ViewGroup parent, View view, int position, long id) { 196 selectChildView(rowViewHolder, view); 197 } 198 }); 199 rowViewHolder.mItemBridgeAdapter.setAdapterListener( 200 new ItemBridgeAdapter.AdapterListener() { 201 @Override 202 public void onCreate(final ItemBridgeAdapter.ViewHolder viewHolder) { 203 // Only when having an OnItemClickListner, we will attach the OnClickListener. 204 if (getOnItemClickedListener() != null || getOnItemViewClickedListener() != null) { 205 viewHolder.mHolder.view.setOnClickListener(new View.OnClickListener() { 206 @Override 207 public void onClick(View v) { 208 ItemBridgeAdapter.ViewHolder ibh = (ItemBridgeAdapter.ViewHolder) 209 rowViewHolder.mGridView 210 .getChildViewHolder(viewHolder.itemView); 211 if (getOnItemClickedListener() != null) { 212 getOnItemClickedListener().onItemClicked(ibh.mItem, 213 (ListRow) rowViewHolder.mRow); 214 } 215 if (getOnItemViewClickedListener() != null) { 216 getOnItemViewClickedListener().onItemClicked(viewHolder.mHolder, 217 ibh.mItem, rowViewHolder, (ListRow) rowViewHolder.mRow); 218 } 219 } 220 }); 221 } 222 } 223 224 @Override 225 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder viewHolder) { 226 if (viewHolder.itemView instanceof ShadowOverlayContainer) { 227 int dimmedColor = rowViewHolder.mColorDimmer.getPaint().getColor(); 228 ((ShadowOverlayContainer) viewHolder.itemView).setOverlayColor(dimmedColor); 229 } 230 viewHolder.itemView.setActivated(rowViewHolder.mExpanded); 231 } 232 233 @Override 234 public void onAddPresenter(Presenter presenter, int type) { 235 rowViewHolder.getGridView().getRecycledViewPool().setMaxRecycledViews(type, 24); 236 } 237 }); 238 } 239 240 final boolean needsDefaultListSelectEffect() { 241 return isUsingDefaultListSelectEffect() && getSelectEffectEnabled(); 242 } 243 244 /** 245 * Set {@link PresenterSelector} used for showing a select object in a hover card. 246 */ 247 public final void setHoverCardPresenterSelector(PresenterSelector selector) { 248 mHoverCardPresenterSelector = selector; 249 } 250 251 /** 252 * Get {@link PresenterSelector} used for showing a select object in a hover card. 253 */ 254 public final PresenterSelector getHoverCardPresenterSelector() { 255 return mHoverCardPresenterSelector; 256 } 257 258 /* 259 * Perform operations when a child of horizontal grid view is selected. 260 */ 261 private void selectChildView(ViewHolder rowViewHolder, View view) { 262 ItemBridgeAdapter.ViewHolder ibh = null; 263 if (view != null) { 264 ibh = (ItemBridgeAdapter.ViewHolder) 265 rowViewHolder.mGridView.getChildViewHolder(view); 266 } 267 if (view == null) { 268 if (mHoverCardPresenterSelector != null) { 269 rowViewHolder.mHoverCardViewSwitcher.unselect(); 270 } 271 if (getOnItemViewSelectedListener() != null) { 272 getOnItemViewSelectedListener().onItemSelected(null, null, 273 rowViewHolder, rowViewHolder.mRow); 274 } 275 if (getOnItemSelectedListener() != null) { 276 getOnItemSelectedListener().onItemSelected(null, rowViewHolder.mRow); 277 } 278 } else if (rowViewHolder.mExpanded && rowViewHolder.mSelected) { 279 if (mHoverCardPresenterSelector != null) { 280 rowViewHolder.mHoverCardViewSwitcher.select(rowViewHolder.mGridView, view, 281 ibh.mItem); 282 } 283 if (getOnItemViewSelectedListener() != null) { 284 getOnItemViewSelectedListener().onItemSelected(ibh.mHolder, ibh.mItem, 285 rowViewHolder, rowViewHolder.mRow); 286 } 287 if (getOnItemSelectedListener() != null) { 288 getOnItemSelectedListener().onItemSelected(ibh.mItem, rowViewHolder.mRow); 289 } 290 } 291 } 292 293 private static void initStatics(Context context) { 294 if (sSelectedRowTopPadding == 0) { 295 sSelectedRowTopPadding = context.getResources().getDimensionPixelSize( 296 R.dimen.lb_browse_selected_row_top_padding); 297 sExpandedSelectedRowTopPadding = context.getResources().getDimensionPixelSize( 298 R.dimen.lb_browse_expanded_selected_row_top_padding); 299 sExpandedRowNoHovercardBottomPadding = context.getResources().getDimensionPixelSize( 300 R.dimen.lb_browse_expanded_row_no_hovercard_bottom_padding); 301 } 302 } 303 304 private int getSpaceUnderBaseline(ListRowPresenter.ViewHolder vh) { 305 RowHeaderPresenter.ViewHolder headerViewHolder = vh.getHeaderViewHolder(); 306 if (headerViewHolder != null) { 307 if (getHeaderPresenter() != null) { 308 return getHeaderPresenter().getSpaceUnderBaseline(headerViewHolder); 309 } 310 return headerViewHolder.view.getPaddingBottom(); 311 } 312 return 0; 313 } 314 315 private void setVerticalPadding(ListRowPresenter.ViewHolder vh) { 316 int paddingTop, paddingBottom; 317 if (vh.isExpanded()) { 318 int headerSpaceUnderBaseline = getSpaceUnderBaseline(vh); 319 if (DEBUG) Log.v(TAG, "headerSpaceUnderBaseline " + headerSpaceUnderBaseline); 320 paddingTop = (vh.isSelected() ? sExpandedSelectedRowTopPadding : vh.mPaddingTop) - 321 headerSpaceUnderBaseline; 322 paddingBottom = mHoverCardPresenterSelector == null ? 323 sExpandedRowNoHovercardBottomPadding : vh.mPaddingBottom; 324 } else if (vh.isSelected()) { 325 paddingTop = sSelectedRowTopPadding; 326 paddingBottom = sSelectedRowTopPadding - vh.mPaddingTop; 327 } else { 328 paddingTop = vh.mPaddingTop; 329 paddingBottom = 0; 330 } 331 vh.getGridView().setPadding(vh.mPaddingLeft, paddingTop, vh.mPaddingRight, 332 paddingBottom); 333 } 334 335 @Override 336 protected RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent) { 337 initStatics(parent.getContext()); 338 ListRowView rowView = new ListRowView(parent.getContext()); 339 setupFadingEffect(rowView); 340 if (mRowHeight != 0) { 341 rowView.getGridView().setRowHeight(mRowHeight); 342 } 343 return new ViewHolder(rowView, rowView.getGridView(), this); 344 } 345 346 @Override 347 protected void onRowViewSelected(RowPresenter.ViewHolder holder, boolean selected) { 348 super.onRowViewSelected(holder, selected); 349 ViewHolder vh = (ViewHolder) holder; 350 setVerticalPadding(vh); 351 updateFooterViewSwitcher(vh); 352 } 353 354 /* 355 * Show or hide hover card when row selection or expanded state is changed. 356 */ 357 private void updateFooterViewSwitcher(ViewHolder vh) { 358 if (vh.mExpanded && vh.mSelected) { 359 if (mHoverCardPresenterSelector != null) { 360 vh.mHoverCardViewSwitcher.init((ViewGroup) vh.view, 361 mHoverCardPresenterSelector); 362 } 363 ItemBridgeAdapter.ViewHolder ibh = (ItemBridgeAdapter.ViewHolder) 364 vh.mGridView.findViewHolderForPosition( 365 vh.mGridView.getSelectedPosition()); 366 selectChildView(vh, ibh == null ? null : ibh.itemView); 367 } else { 368 if (mHoverCardPresenterSelector != null) { 369 vh.mHoverCardViewSwitcher.unselect(); 370 } 371 } 372 } 373 374 private void setupFadingEffect(ListRowView rowView) { 375 // content is completely faded at 1/2 padding of left, fading length is 1/2 of padding. 376 HorizontalGridView gridView = rowView.getGridView(); 377 if (mBrowseRowsFadingEdgeLength < 0) { 378 TypedArray ta = gridView.getContext() 379 .obtainStyledAttributes(R.styleable.LeanbackTheme); 380 mBrowseRowsFadingEdgeLength = (int) ta.getDimension( 381 R.styleable.LeanbackTheme_browseRowsFadingEdgeLength, 0); 382 ta.recycle(); 383 } 384 gridView.setFadingLeftEdgeLength(mBrowseRowsFadingEdgeLength); 385 } 386 387 @Override 388 protected void onRowViewExpanded(RowPresenter.ViewHolder holder, boolean expanded) { 389 super.onRowViewExpanded(holder, expanded); 390 ViewHolder vh = (ViewHolder) holder; 391 if (getRowHeight() != getExpandedRowHeight()) { 392 int newHeight = expanded ? getExpandedRowHeight() : getRowHeight(); 393 vh.getGridView().setRowHeight(newHeight); 394 } 395 setVerticalPadding(vh); 396 vh.getGridView().setFadingLeftEdge(!expanded); 397 updateFooterViewSwitcher(vh); 398 } 399 400 @Override 401 protected void onBindRowViewHolder(RowPresenter.ViewHolder holder, Object item) { 402 super.onBindRowViewHolder(holder, item); 403 ViewHolder vh = (ViewHolder) holder; 404 ListRow rowItem = (ListRow) item; 405 vh.mItemBridgeAdapter.clear(); 406 vh.mItemBridgeAdapter.setAdapter(rowItem.getAdapter()); 407 vh.mGridView.setAdapter(vh.mItemBridgeAdapter); 408 } 409 410 @Override 411 protected void onUnbindRowViewHolder(RowPresenter.ViewHolder holder) { 412 ((ViewHolder) holder).mGridView.setAdapter(null); 413 super.onUnbindRowViewHolder(holder); 414 } 415 416 /** 417 * ListRowPresenter overrides the default select effect of {@link RowPresenter} 418 * and return false. 419 */ 420 @Override 421 public final boolean isUsingDefaultSelectEffect() { 422 return false; 423 } 424 425 /** 426 * Returns true so that default select effect is applied to each individual 427 * child of {@link HorizontalGridView}. Subclass may return false to disable 428 * the default implementation. 429 * @see #onSelectLevelChanged(RowPresenter.ViewHolder) 430 */ 431 public boolean isUsingDefaultListSelectEffect() { 432 return true; 433 } 434 435 /** 436 * Returns true if SDK >= 18, where default shadow 437 * is applied to each individual child of {@link HorizontalGridView}. 438 * Subclass may return false to disable. 439 */ 440 public boolean isUsingDefaultShadow() { 441 return ShadowOverlayContainer.supportsShadow(); 442 } 443 444 /** 445 * Returns true if SDK >= L, where Z shadow is enabled so that Z order is enabled 446 * on each child of horizontal list. If subclass returns false in isUsingDefaultShadow() 447 * and does not use Z-shadow on SDK >= L, it should override isUsingZOrder() return false. 448 */ 449 public boolean isUsingZOrder() { 450 return ShadowHelper.getInstance().usesZShadow(); 451 } 452 453 /** 454 * Enable or disable child shadow. 455 * This is not only for enable/disable default shadow implementation but also subclass must 456 * respect this flag. 457 */ 458 public final void setShadowEnabled(boolean enabled) { 459 mShadowEnabled = enabled; 460 } 461 462 /** 463 * Returns true if child shadow is enabled. 464 * This is not only for enable/disable default shadow implementation but also subclass must 465 * respect this flag. 466 */ 467 public final boolean getShadowEnabled() { 468 return mShadowEnabled; 469 } 470 471 final boolean needsDefaultShadow() { 472 return isUsingDefaultShadow() && getShadowEnabled(); 473 } 474 475 @Override 476 public boolean canDrawOutOfBounds() { 477 return needsDefaultShadow(); 478 } 479 480 /** 481 * Applies select level to header and draw a default color dim over each child 482 * of {@link HorizontalGridView}. 483 * <p> 484 * Subclass may override this method. A subclass 485 * needs to call super.onSelectLevelChanged() for applying header select level 486 * and optionally applying a default select level to each child view of 487 * {@link HorizontalGridView} if {@link #isUsingDefaultListSelectEffect()} 488 * is true. Subclass may override {@link #isUsingDefaultListSelectEffect()} to return 489 * false and deal with the individual item select level by itself. 490 * </p> 491 */ 492 @Override 493 protected void onSelectLevelChanged(RowPresenter.ViewHolder holder) { 494 super.onSelectLevelChanged(holder); 495 if (needsDefaultListSelectEffect()) { 496 ViewHolder vh = (ViewHolder) holder; 497 vh.mColorDimmer.setActiveLevel(holder.mSelectLevel); 498 int dimmedColor = vh.mColorDimmer.getPaint().getColor(); 499 for (int i = 0, count = vh.mGridView.getChildCount(); i < count; i++) { 500 ShadowOverlayContainer wrapper = (ShadowOverlayContainer) vh.mGridView.getChildAt(i); 501 wrapper.setOverlayColor(dimmedColor); 502 } 503 if (vh.mGridView.getFadingLeftEdge()) { 504 vh.mGridView.invalidate(); 505 } 506 } 507 } 508 509} 510