ListRowPresenter.java revision 76c3b90228d8c4afc6d24c683e9c95f41ae619c9
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.setOnChildSelectedListener( 192 new OnChildSelectedListener() { 193 @Override 194 public void onChildSelected(ViewGroup parent, View view, int position, long id) { 195 selectChildView(rowViewHolder, view); 196 } 197 }); 198 rowViewHolder.mItemBridgeAdapter.setAdapterListener( 199 new ItemBridgeAdapter.AdapterListener() { 200 @Override 201 public void onCreate(final ItemBridgeAdapter.ViewHolder viewHolder) { 202 // Only when having an OnItemClickListner, we will attach the OnClickListener. 203 if (getOnItemClickedListener() != null) { 204 viewHolder.mHolder.view.setOnClickListener(new View.OnClickListener() { 205 @Override 206 public void onClick(View v) { 207 ItemBridgeAdapter.ViewHolder ibh = (ItemBridgeAdapter.ViewHolder) 208 rowViewHolder.mGridView.getChildViewHolder(viewHolder.itemView); 209 if (getOnItemClickedListener() != null) { 210 getOnItemClickedListener().onItemClicked(ibh.mItem, 211 (ListRow) rowViewHolder.mRow); 212 } 213 } 214 }); 215 } 216 } 217 218 @Override 219 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder viewHolder) { 220 if (viewHolder.itemView instanceof ShadowOverlayContainer) { 221 int dimmedColor = rowViewHolder.mColorDimmer.getPaint().getColor(); 222 ((ShadowOverlayContainer) viewHolder.itemView).setOverlayColor(dimmedColor); 223 } 224 viewHolder.itemView.setActivated(rowViewHolder.mExpanded); 225 } 226 227 @Override 228 public void onAddPresenter(Presenter presenter, int type) { 229 rowViewHolder.getGridView().getRecycledViewPool().setMaxRecycledViews(type, 24); 230 } 231 }); 232 } 233 234 final boolean needsDefaultListSelectEffect() { 235 return isUsingDefaultListSelectEffect() && getSelectEffectEnabled(); 236 } 237 238 /** 239 * Set {@link PresenterSelector} used for showing a select object in a hover card. 240 */ 241 public final void setHoverCardPresenterSelector(PresenterSelector selector) { 242 mHoverCardPresenterSelector = selector; 243 } 244 245 /** 246 * Get {@link PresenterSelector} used for showing a select object in a hover card. 247 */ 248 public final PresenterSelector getHoverCardPresenterSelector() { 249 return mHoverCardPresenterSelector; 250 } 251 252 /* 253 * Perform operations when a child of horizontal grid view is selected. 254 */ 255 private void selectChildView(ViewHolder rowViewHolder, View view) { 256 ItemBridgeAdapter.ViewHolder ibh = null; 257 if (view != null) { 258 ibh = (ItemBridgeAdapter.ViewHolder) 259 rowViewHolder.mGridView.getChildViewHolder(view); 260 } 261 if (view == null) { 262 if (mHoverCardPresenterSelector != null) { 263 rowViewHolder.mHoverCardViewSwitcher.unselect(); 264 } 265 if (getOnItemSelectedListener() != null) { 266 getOnItemSelectedListener().onItemSelected(null, rowViewHolder.mRow); 267 } 268 } else if (rowViewHolder.mExpanded && rowViewHolder.mSelected) { 269 if (mHoverCardPresenterSelector != null) { 270 rowViewHolder.mHoverCardViewSwitcher.select(rowViewHolder.mGridView, view, 271 ibh.mItem); 272 } 273 if (getOnItemSelectedListener() != null) { 274 getOnItemSelectedListener().onItemSelected(ibh.mItem, rowViewHolder.mRow); 275 } 276 } 277 } 278 279 private static void initStatics(Context context) { 280 if (sSelectedRowTopPadding == 0) { 281 sSelectedRowTopPadding = context.getResources().getDimensionPixelSize( 282 R.dimen.lb_browse_selected_row_top_padding); 283 sExpandedSelectedRowTopPadding = context.getResources().getDimensionPixelSize( 284 R.dimen.lb_browse_expanded_selected_row_top_padding); 285 sExpandedRowNoHovercardBottomPadding = context.getResources().getDimensionPixelSize( 286 R.dimen.lb_browse_expanded_row_no_hovercard_bottom_padding); 287 } 288 } 289 290 private int getSpaceUnderBaseline(ListRowPresenter.ViewHolder vh) { 291 RowHeaderPresenter.ViewHolder headerViewHolder = vh.getHeaderViewHolder(); 292 if (headerViewHolder != null) { 293 if (getHeaderPresenter() != null) { 294 return getHeaderPresenter().getSpaceUnderBaseline(headerViewHolder); 295 } 296 return headerViewHolder.view.getPaddingBottom(); 297 } 298 return 0; 299 } 300 301 private void setVerticalPadding(ListRowPresenter.ViewHolder vh) { 302 int paddingTop, paddingBottom; 303 if (vh.isExpanded()) { 304 int headerSpaceUnderBaseline = getSpaceUnderBaseline(vh); 305 if (DEBUG) Log.v(TAG, "headerSpaceUnderBaseline " + headerSpaceUnderBaseline); 306 paddingTop = (vh.isSelected() ? sExpandedSelectedRowTopPadding : vh.mPaddingTop) - 307 headerSpaceUnderBaseline; 308 paddingBottom = mHoverCardPresenterSelector == null ? 309 sExpandedRowNoHovercardBottomPadding : vh.mPaddingBottom; 310 } else if (vh.isSelected()) { 311 paddingTop = sSelectedRowTopPadding; 312 paddingBottom = sSelectedRowTopPadding - vh.mPaddingTop; 313 } else { 314 paddingTop = vh.mPaddingTop; 315 paddingBottom = 0; 316 } 317 vh.getGridView().setPadding(vh.mPaddingLeft, paddingTop, vh.mPaddingRight, 318 paddingBottom); 319 } 320 321 @Override 322 protected RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent) { 323 initStatics(parent.getContext()); 324 ListRowView rowView = new ListRowView(parent.getContext()); 325 setupFadingEffect(rowView); 326 if (mRowHeight != 0) { 327 rowView.getGridView().setRowHeight(mRowHeight); 328 } 329 return new ViewHolder(rowView, rowView.getGridView(), this); 330 } 331 332 @Override 333 protected void onRowViewSelected(RowPresenter.ViewHolder holder, boolean selected) { 334 super.onRowViewSelected(holder, selected); 335 ViewHolder vh = (ViewHolder) holder; 336 setVerticalPadding(vh); 337 updateFooterViewSwitcher(vh); 338 } 339 340 /* 341 * Show or hide hover card when row selection or expanded state is changed. 342 */ 343 private void updateFooterViewSwitcher(ViewHolder vh) { 344 if (vh.mExpanded && vh.mSelected) { 345 if (mHoverCardPresenterSelector != null) { 346 vh.mHoverCardViewSwitcher.init((ViewGroup) vh.view, 347 mHoverCardPresenterSelector); 348 } 349 ItemBridgeAdapter.ViewHolder ibh = (ItemBridgeAdapter.ViewHolder) 350 vh.mGridView.findViewHolderForPosition( 351 vh.mGridView.getSelectedPosition()); 352 selectChildView(vh, ibh == null ? null : ibh.itemView); 353 } else { 354 if (mHoverCardPresenterSelector != null) { 355 vh.mHoverCardViewSwitcher.unselect(); 356 } 357 } 358 } 359 360 private void setupFadingEffect(ListRowView rowView) { 361 // content is completely faded at 1/2 padding of left, fading length is 1/2 of padding. 362 HorizontalGridView gridView = rowView.getGridView(); 363 if (mBrowseRowsFadingEdgeLength < 0) { 364 TypedArray ta = gridView.getContext() 365 .obtainStyledAttributes(R.styleable.LeanbackTheme); 366 mBrowseRowsFadingEdgeLength = (int) ta.getDimension( 367 R.styleable.LeanbackTheme_browseRowsFadingEdgeLength, 0); 368 ta.recycle(); 369 } 370 gridView.setFadingLeftEdgeLength(mBrowseRowsFadingEdgeLength); 371 } 372 373 @Override 374 protected void onRowViewExpanded(RowPresenter.ViewHolder holder, boolean expanded) { 375 super.onRowViewExpanded(holder, expanded); 376 ViewHolder vh = (ViewHolder) holder; 377 if (getRowHeight() != getExpandedRowHeight()) { 378 int newHeight = expanded ? getExpandedRowHeight() : getRowHeight(); 379 vh.getGridView().setRowHeight(newHeight); 380 } 381 setVerticalPadding(vh); 382 vh.getGridView().setFadingLeftEdge(!expanded); 383 updateFooterViewSwitcher(vh); 384 } 385 386 @Override 387 protected void onBindRowViewHolder(RowPresenter.ViewHolder holder, Object item) { 388 super.onBindRowViewHolder(holder, item); 389 ViewHolder vh = (ViewHolder) holder; 390 ListRow rowItem = (ListRow) item; 391 vh.mItemBridgeAdapter.clear(); 392 vh.mItemBridgeAdapter.setAdapter(rowItem.getAdapter()); 393 vh.mGridView.setAdapter(vh.mItemBridgeAdapter); 394 } 395 396 @Override 397 protected void onUnbindRowViewHolder(RowPresenter.ViewHolder holder) { 398 ((ViewHolder) holder).mGridView.setAdapter(null); 399 super.onUnbindRowViewHolder(holder); 400 } 401 402 /** 403 * ListRowPresenter overrides the default select effect of {@link RowPresenter} 404 * and return false. 405 */ 406 @Override 407 public final boolean isUsingDefaultSelectEffect() { 408 return false; 409 } 410 411 /** 412 * Returns true so that default select effect is applied to each individual 413 * child of {@link HorizontalGridView}. Subclass may return false to disable 414 * the default implementation. 415 * @see #onSelectLevelChanged(RowPresenter.ViewHolder) 416 */ 417 public boolean isUsingDefaultListSelectEffect() { 418 return true; 419 } 420 421 /** 422 * Returns true if SDK >= 18, where default shadow 423 * is applied to each individual child of {@link HorizontalGridView}. 424 * Subclass may return false to disable. 425 */ 426 public boolean isUsingDefaultShadow() { 427 return ShadowOverlayContainer.supportsShadow(); 428 } 429 430 /** 431 * Enable or disable child shadow. 432 * This is not only for enable/disable default shadow implementation but also subclass must 433 * respect this flag. 434 */ 435 public final void setShadowEnabled(boolean enabled) { 436 mShadowEnabled = enabled; 437 } 438 439 /** 440 * Returns true if child shadow is enabled. 441 * This is not only for enable/disable default shadow implementation but also subclass must 442 * respect this flag. 443 */ 444 public final boolean getShadowEnabled() { 445 return mShadowEnabled; 446 } 447 448 final boolean needsDefaultShadow() { 449 return isUsingDefaultShadow() && getShadowEnabled(); 450 } 451 452 @Override 453 public boolean canDrawOutOfBounds() { 454 return needsDefaultShadow(); 455 } 456 457 /** 458 * Applies select level to header and draw a default color dim over each child 459 * of {@link HorizontalGridView}. 460 * <p> 461 * Subclass may override this method. A subclass 462 * needs to call super.onSelectLevelChanged() for applying header select level 463 * and optionally applying a default select level to each child view of 464 * {@link HorizontalGridView} if {@link #isUsingDefaultListSelectEffect()} 465 * is true. Subclass may override {@link #isUsingDefaultListSelectEffect()} to return 466 * false and deal with the individual item select level by itself. 467 * </p> 468 */ 469 @Override 470 protected void onSelectLevelChanged(RowPresenter.ViewHolder holder) { 471 super.onSelectLevelChanged(holder); 472 if (needsDefaultListSelectEffect()) { 473 ViewHolder vh = (ViewHolder) holder; 474 vh.mColorDimmer.setActiveLevel(holder.mSelectLevel); 475 int dimmedColor = vh.mColorDimmer.getPaint().getColor(); 476 for (int i = 0, count = vh.mGridView.getChildCount(); i < count; i++) { 477 ShadowOverlayContainer wrapper = (ShadowOverlayContainer) vh.mGridView.getChildAt(i); 478 wrapper.setOverlayColor(dimmedColor); 479 } 480 if (vh.mGridView.getFadingLeftEdge()) { 481 vh.mGridView.invalidate(); 482 } 483 } 484 } 485 486} 487