DetailsOverviewRowPresenter.java revision 3a5038bd0fefa5628a31a21422bf2126c53472a9
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.app.Activity; 17import android.content.Context; 18import android.graphics.Bitmap; 19import android.graphics.Color; 20import android.graphics.drawable.Drawable; 21import android.graphics.drawable.BitmapDrawable; 22import android.graphics.drawable.ColorDrawable; 23import android.os.Handler; 24import android.support.v17.leanback.R; 25import android.support.v7.widget.RecyclerView; 26import android.util.Log; 27import android.util.TypedValue; 28import android.view.KeyEvent; 29import android.view.LayoutInflater; 30import android.view.View; 31import android.view.ViewGroup; 32import android.widget.FrameLayout; 33import android.widget.ImageView; 34 35import java.util.Collection; 36 37/** 38 * A DetailsOverviewRowPresenter renders a {@link DetailsOverviewRow} to display an 39 * overview of an item. Typically this row will be the first row in a fragment 40 * such as the {@link android.support.v17.leanback.app.DetailsFragment 41 * DetailsFragment}. View created by DetailsOverviewRowPresenter is made in three parts: 42 * ImageView on the left, action list view on the bottom and a customizable detailed 43 * description view on the right. 44 * 45 * <p>The detailed description is rendered using a {@link Presenter} passed in 46 * {@link #DetailsOverviewRowPresenter(Presenter)}. User can access detailed description 47 * ViewHolder from {@link ViewHolder#mDetailsDescriptionViewHolder}. 48 * </p> 49 * 50 * <p> 51 * To participate in activity transition, call {@link #setSharedElementEnterTransition(Activity, 52 * String)} during Activity's onCreate(). 53 * </p> 54 * 55 * <p> 56 * Because transition support and layout are fully controlled by DetailsOverviewRowPresenter, 57 * developer can not override DetailsOverviewRowPresenter.ViewHolder for adding/replacing views 58 * of DetailsOverviewRowPresenter. If developer wants more customization beyond replacing 59 * detailed description , he/she should write a new presenter class for row object. 60 * </p> 61 */ 62public class DetailsOverviewRowPresenter extends RowPresenter { 63 64 private static final String TAG = "DetailsOverviewRowPresenter"; 65 private static final boolean DEBUG = false; 66 67 private static final int MORE_ACTIONS_FADE_MS = 100; 68 private static final long DEFAULT_TIMEOUT = 5000; 69 70 class ActionsItemBridgeAdapter extends ItemBridgeAdapter { 71 DetailsOverviewRowPresenter.ViewHolder mViewHolder; 72 73 ActionsItemBridgeAdapter(DetailsOverviewRowPresenter.ViewHolder viewHolder) { 74 mViewHolder = viewHolder; 75 } 76 77 @Override 78 public void onBind(final ItemBridgeAdapter.ViewHolder ibvh) { 79 if (mViewHolder.getOnItemViewClickedListener() != null || 80 mActionClickedListener != null) { 81 ibvh.getPresenter().setOnClickListener( 82 ibvh.getViewHolder(), new View.OnClickListener() { 83 @Override 84 public void onClick(View v) { 85 if (mViewHolder.getOnItemViewClickedListener() != null) { 86 mViewHolder.getOnItemViewClickedListener().onItemClicked( 87 ibvh.getViewHolder(), ibvh.getItem(), 88 mViewHolder, mViewHolder.getRow()); 89 } 90 if (mActionClickedListener != null) { 91 mActionClickedListener.onActionClicked((Action) ibvh.getItem()); 92 } 93 } 94 }); 95 } 96 } 97 @Override 98 public void onUnbind(final ItemBridgeAdapter.ViewHolder ibvh) { 99 if (mViewHolder.getOnItemViewClickedListener() != null || 100 mActionClickedListener != null) { 101 ibvh.getPresenter().setOnClickListener(ibvh.getViewHolder(), null); 102 } 103 } 104 @Override 105 public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder viewHolder) { 106 // Remove first to ensure we don't add ourselves more than once. 107 viewHolder.itemView.removeOnLayoutChangeListener(mViewHolder.mLayoutChangeListener); 108 viewHolder.itemView.addOnLayoutChangeListener(mViewHolder.mLayoutChangeListener); 109 } 110 @Override 111 public void onDetachedFromWindow(ItemBridgeAdapter.ViewHolder viewHolder) { 112 viewHolder.itemView.removeOnLayoutChangeListener(mViewHolder.mLayoutChangeListener); 113 mViewHolder.checkFirstAndLastPosition(false); 114 } 115 } 116 117 /** 118 * A ViewHolder for the DetailsOverviewRow. 119 */ 120 public final class ViewHolder extends RowPresenter.ViewHolder { 121 final FrameLayout mOverviewFrame; 122 final ViewGroup mOverviewView; 123 final ImageView mImageView; 124 final ViewGroup mRightPanel; 125 final FrameLayout mDetailsDescriptionFrame; 126 final HorizontalGridView mActionsRow; 127 public final Presenter.ViewHolder mDetailsDescriptionViewHolder; 128 int mNumItems; 129 boolean mShowMoreRight; 130 boolean mShowMoreLeft; 131 ItemBridgeAdapter mActionBridgeAdapter; 132 final Handler mHandler = new Handler(); 133 134 final Runnable mUpdateDrawableCallback = new Runnable() { 135 @Override 136 public void run() { 137 bindImageDrawable(ViewHolder.this); 138 } 139 }; 140 141 final DetailsOverviewRow.Listener mListener = new DetailsOverviewRow.Listener() { 142 @Override 143 public void onImageDrawableChanged(DetailsOverviewRow row) { 144 mHandler.removeCallbacks(mUpdateDrawableCallback); 145 mHandler.post(mUpdateDrawableCallback); 146 } 147 148 @Override 149 public void onItemChanged(DetailsOverviewRow row) { 150 if (mDetailsDescriptionViewHolder != null) { 151 mDetailsPresenter.onUnbindViewHolder(mDetailsDescriptionViewHolder); 152 } 153 mDetailsPresenter.onBindViewHolder(mDetailsDescriptionViewHolder, row.getItem()); 154 } 155 156 @Override 157 public void onActionsAdapterChanged(DetailsOverviewRow row) { 158 bindActions(row.getActionsAdapter()); 159 } 160 }; 161 162 void bindActions(ObjectAdapter adapter) { 163 mActionBridgeAdapter.setAdapter(adapter); 164 mActionsRow.setAdapter(mActionBridgeAdapter); 165 mNumItems = mActionBridgeAdapter.getItemCount(); 166 167 mShowMoreRight = false; 168 mShowMoreLeft = true; 169 showMoreLeft(false); 170 } 171 172 final View.OnLayoutChangeListener mLayoutChangeListener = 173 new View.OnLayoutChangeListener() { 174 175 @Override 176 public void onLayoutChange(View v, int left, int top, int right, 177 int bottom, int oldLeft, int oldTop, int oldRight, int oldBottom) { 178 if (DEBUG) Log.v(TAG, "onLayoutChange " + v); 179 checkFirstAndLastPosition(false); 180 } 181 }; 182 183 final OnChildSelectedListener mChildSelectedListener = new OnChildSelectedListener() { 184 @Override 185 public void onChildSelected(ViewGroup parent, View view, int position, long id) { 186 dispatchItemSelection(view); 187 } 188 }; 189 190 void dispatchItemSelection(View view) { 191 if (!isSelected()) { 192 return; 193 } 194 ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder) (view != null ? 195 mActionsRow.getChildViewHolder(view) : 196 mActionsRow.findViewHolderForPosition(mActionsRow.getSelectedPosition())); 197 if (ibvh == null) { 198 if (getOnItemViewSelectedListener() != null) { 199 getOnItemViewSelectedListener().onItemSelected(null, null, 200 ViewHolder.this, getRow()); 201 } 202 } else { 203 if (getOnItemViewSelectedListener() != null) { 204 getOnItemViewSelectedListener().onItemSelected(ibvh.getViewHolder(), ibvh.getItem(), 205 ViewHolder.this, getRow()); 206 } 207 } 208 }; 209 210 final RecyclerView.OnScrollListener mScrollListener = 211 new RecyclerView.OnScrollListener() { 212 213 @Override 214 public void onScrollStateChanged(RecyclerView recyclerView, int newState) { 215 } 216 @Override 217 public void onScrolled(RecyclerView recyclerView, int dx, int dy) { 218 checkFirstAndLastPosition(true); 219 } 220 }; 221 222 private int getViewCenter(View view) { 223 return (view.getRight() - view.getLeft()) / 2; 224 } 225 226 private void checkFirstAndLastPosition(boolean fromScroll) { 227 RecyclerView.ViewHolder viewHolder; 228 229 viewHolder = mActionsRow.findViewHolderForPosition(mNumItems - 1); 230 boolean showRight = (viewHolder == null || 231 viewHolder.itemView.getRight() > mActionsRow.getWidth()); 232 233 viewHolder = mActionsRow.findViewHolderForPosition(0); 234 boolean showLeft = (viewHolder == null || viewHolder.itemView.getLeft() < 0); 235 236 if (DEBUG) Log.v(TAG, "checkFirstAndLast fromScroll " + fromScroll + 237 " showRight " + showRight + " showLeft " + showLeft); 238 239 showMoreRight(showRight); 240 showMoreLeft(showLeft); 241 } 242 243 private void showMoreLeft(boolean show) { 244 if (show != mShowMoreLeft) { 245 mActionsRow.setFadingLeftEdge(show); 246 mShowMoreLeft = show; 247 } 248 } 249 250 private void showMoreRight(boolean show) { 251 if (show != mShowMoreRight) { 252 mActionsRow.setFadingRightEdge(show); 253 mShowMoreRight = show; 254 } 255 } 256 257 /** 258 * Constructor for the ViewHolder. 259 * 260 * @param rootView The root View that this view holder will be attached 261 * to. 262 */ 263 public ViewHolder(View rootView, Presenter detailsPresenter) { 264 super(rootView); 265 mOverviewFrame = (FrameLayout) rootView.findViewById(R.id.details_frame); 266 mOverviewView = (ViewGroup) rootView.findViewById(R.id.details_overview); 267 mImageView = (ImageView) rootView.findViewById(R.id.details_overview_image); 268 mRightPanel = (ViewGroup) rootView.findViewById(R.id.details_overview_right_panel); 269 mDetailsDescriptionFrame = 270 (FrameLayout) mRightPanel.findViewById(R.id.details_overview_description); 271 mActionsRow = 272 (HorizontalGridView) mRightPanel.findViewById(R.id.details_overview_actions); 273 mActionsRow.setHasOverlappingRendering(false); 274 mActionsRow.setOnScrollListener(mScrollListener); 275 mActionsRow.setAdapter(mActionBridgeAdapter); 276 mActionsRow.setOnChildSelectedListener(mChildSelectedListener); 277 278 final int fadeLength = rootView.getResources().getDimensionPixelSize( 279 R.dimen.lb_details_overview_actions_fade_size); 280 mActionsRow.setFadingRightEdgeLength(fadeLength); 281 mActionsRow.setFadingLeftEdgeLength(fadeLength); 282 mDetailsDescriptionViewHolder = 283 detailsPresenter.onCreateViewHolder(mDetailsDescriptionFrame); 284 mDetailsDescriptionFrame.addView(mDetailsDescriptionViewHolder.view); 285 } 286 } 287 288 private final Presenter mDetailsPresenter; 289 private OnActionClickedListener mActionClickedListener; 290 291 private int mBackgroundColor = Color.TRANSPARENT; 292 private boolean mBackgroundColorSet; 293 private boolean mIsStyleLarge = true; 294 295 private DetailsOverviewSharedElementHelper mSharedElementHelper; 296 297 /** 298 * Constructor for a DetailsOverviewRowPresenter. 299 * 300 * @param detailsPresenter The {@link Presenter} used to render the detailed 301 * description of the row. 302 */ 303 public DetailsOverviewRowPresenter(Presenter detailsPresenter) { 304 setHeaderPresenter(null); 305 setSelectEffectEnabled(false); 306 mDetailsPresenter = detailsPresenter; 307 } 308 309 /** 310 * Sets the listener for Action click events. 311 */ 312 public void setOnActionClickedListener(OnActionClickedListener listener) { 313 mActionClickedListener = listener; 314 } 315 316 /** 317 * Gets the listener for Action click events. 318 */ 319 public OnActionClickedListener getOnActionClickedListener() { 320 return mActionClickedListener; 321 } 322 323 /** 324 * Sets the background color. If not set, a default from the theme will be used. 325 */ 326 public void setBackgroundColor(int color) { 327 mBackgroundColor = color; 328 mBackgroundColorSet = true; 329 } 330 331 /** 332 * Returns the background color. If no background color was set, transparent 333 * is returned. 334 */ 335 public int getBackgroundColor() { 336 return mBackgroundColor; 337 } 338 339 /** 340 * Sets the layout style to be large or small. This affects the height of 341 * the overview, including the text description. The default is large. 342 */ 343 public void setStyleLarge(boolean large) { 344 mIsStyleLarge = large; 345 } 346 347 /** 348 * Returns true if the layout style is large. 349 */ 350 public boolean isStyleLarge() { 351 return mIsStyleLarge; 352 } 353 354 /** 355 * Set enter transition of target activity (typically a DetailActivity) to be 356 * transiting into overview row created by this presenter. The transition will 357 * be cancelled if overview image is not loaded in the timeout period. 358 * <p> 359 * It assumes shared element passed from calling activity is an ImageView; 360 * the shared element transits to overview image on the left of detail 361 * overview row, while bounds of overview row grows and reveals text 362 * and buttons on the right. 363 * <p> 364 * The method must be invoked in target Activity's onCreate(). 365 */ 366 public final void setSharedElementEnterTransition(Activity activity, 367 String sharedElementName, long timeoutMs) { 368 if (mSharedElementHelper == null) { 369 mSharedElementHelper = new DetailsOverviewSharedElementHelper(); 370 } 371 mSharedElementHelper.setSharedElementEnterTransition(activity, sharedElementName, 372 timeoutMs); 373 } 374 375 /** 376 * Set enter transition of target activity (typically a DetailActivity) to be 377 * transiting into overview row created by this presenter. The transition will 378 * be cancelled if overview image is not loaded in a default timeout period. 379 * <p> 380 * It assumes shared element passed from calling activity is an ImageView; 381 * the shared element transits to overview image on the left of detail 382 * overview row, while bounds of overview row grows and reveals text 383 * and buttons on the right. 384 * <p> 385 * The method must be invoked in target Activity's onCreate(). 386 */ 387 public final void setSharedElementEnterTransition(Activity activity, 388 String sharedElementName) { 389 setSharedElementEnterTransition(activity, sharedElementName, DEFAULT_TIMEOUT); 390 } 391 392 private int getDefaultBackgroundColor(Context context) { 393 TypedValue outValue = new TypedValue(); 394 if (context.getTheme().resolveAttribute(R.attr.defaultBrandColor, outValue, true)) { 395 return context.getResources().getColor(outValue.resourceId); 396 } 397 return context.getResources().getColor(R.color.lb_default_brand_color); 398 } 399 400 @Override 401 protected void onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected) { 402 super.onRowViewSelected(vh, selected); 403 if (selected) { 404 ((ViewHolder) vh).dispatchItemSelection(null); 405 } 406 } 407 408 @Override 409 protected RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent) { 410 View v = LayoutInflater.from(parent.getContext()) 411 .inflate(R.layout.lb_details_overview, parent, false); 412 ViewHolder vh = new ViewHolder(v, mDetailsPresenter); 413 414 initDetailsOverview(vh); 415 416 return vh; 417 } 418 419 private int getCardHeight(Context context) { 420 int resId = mIsStyleLarge ? R.dimen.lb_details_overview_height_large : 421 R.dimen.lb_details_overview_height_small; 422 return context.getResources().getDimensionPixelSize(resId); 423 } 424 425 private void initDetailsOverview(final ViewHolder vh) { 426 vh.mActionBridgeAdapter = new ActionsItemBridgeAdapter(vh); 427 final View overview = vh.mOverviewFrame; 428 ViewGroup.LayoutParams lp = overview.getLayoutParams(); 429 lp.height = getCardHeight(overview.getContext()); 430 overview.setLayoutParams(lp); 431 432 if (!getSelectEffectEnabled()) { 433 vh.mOverviewFrame.setForeground(null); 434 } 435 vh.mActionsRow.setOnUnhandledKeyListener(new BaseGridView.OnUnhandledKeyListener() { 436 @Override 437 public boolean onUnhandledKey(KeyEvent event) { 438 if (vh.getOnKeyListener() != null) { 439 if (vh.getOnKeyListener().onKey(vh.view, event.getKeyCode(), event)) { 440 return true; 441 } 442 } 443 return false; 444 } 445 }); 446 } 447 448 private static int getNonNegativeWidth(Drawable drawable) { 449 final int width = (drawable == null) ? 0 : drawable.getIntrinsicWidth(); 450 return (width > 0 ? width : 0); 451 } 452 453 private static int getNonNegativeHeight(Drawable drawable) { 454 final int height = (drawable == null) ? 0 : drawable.getIntrinsicHeight(); 455 return (height > 0 ? height : 0); 456 } 457 458 private void bindImageDrawable(ViewHolder vh) { 459 DetailsOverviewRow row = (DetailsOverviewRow) vh.getRow(); 460 461 ViewGroup.MarginLayoutParams layoutParams = 462 (ViewGroup.MarginLayoutParams) vh.mImageView.getLayoutParams(); 463 final int cardHeight = getCardHeight(vh.mImageView.getContext()); 464 final int verticalMargin = vh.mImageView.getResources().getDimensionPixelSize( 465 R.dimen.lb_details_overview_image_margin_vertical); 466 final int horizontalMargin = vh.mImageView.getResources().getDimensionPixelSize( 467 R.dimen.lb_details_overview_image_margin_horizontal); 468 final int drawableWidth = getNonNegativeWidth(row.getImageDrawable()); 469 final int drawableHeight = getNonNegativeHeight(row.getImageDrawable()); 470 471 boolean scaleImage = row.isImageScaleUpAllowed(); 472 boolean useMargin = false; 473 474 if (row.getImageDrawable() != null) { 475 boolean landscape = false; 476 477 // If large style and landscape image we always use margin. 478 if (drawableWidth > drawableHeight) { 479 landscape = true; 480 if (mIsStyleLarge) { 481 useMargin = true; 482 } 483 } 484 // If long dimension bigger than the card height we scale down. 485 if ((landscape && drawableWidth > cardHeight) || 486 (!landscape && drawableHeight > cardHeight)) { 487 scaleImage = true; 488 } 489 // If we're not scaling to fit the card height then we always use margin. 490 if (!scaleImage) { 491 useMargin = true; 492 } 493 // If using margin than may need to scale down. 494 if (useMargin && !scaleImage) { 495 if (landscape && drawableWidth > cardHeight - horizontalMargin) { 496 scaleImage = true; 497 } else if (!landscape && drawableHeight > cardHeight - 2 * verticalMargin) { 498 scaleImage = true; 499 } 500 } 501 } 502 503 final int bgColor = mBackgroundColorSet ? mBackgroundColor : 504 getDefaultBackgroundColor(vh.mOverviewView.getContext()); 505 506 if (useMargin) { 507 layoutParams.setMarginStart(horizontalMargin); 508 layoutParams.topMargin = layoutParams.bottomMargin = verticalMargin; 509 RoundedRectHelper.getInstance().setRoundedRectBackground(vh.mOverviewFrame, bgColor); 510 vh.mRightPanel.setBackground(null); 511 vh.mImageView.setBackground(null); 512 } else { 513 layoutParams.leftMargin = layoutParams.topMargin = layoutParams.bottomMargin = 0; 514 vh.mRightPanel.setBackgroundColor(bgColor); 515 vh.mImageView.setBackgroundColor(bgColor); 516 RoundedRectHelper.getInstance().setRoundedRectBackground(vh.mOverviewFrame, 517 Color.TRANSPARENT); 518 } 519 if (scaleImage) { 520 vh.mImageView.setScaleType(ImageView.ScaleType.FIT_START); 521 vh.mImageView.setAdjustViewBounds(true); 522 vh.mImageView.setMaxWidth(cardHeight); 523 layoutParams.height = ViewGroup.LayoutParams.MATCH_PARENT; 524 layoutParams.width = ViewGroup.LayoutParams.WRAP_CONTENT; 525 } else { 526 vh.mImageView.setScaleType(ImageView.ScaleType.CENTER); 527 vh.mImageView.setAdjustViewBounds(false); 528 layoutParams.height = ViewGroup.LayoutParams.WRAP_CONTENT; 529 // Limit width to the card height 530 layoutParams.width = Math.min(cardHeight, drawableWidth); 531 } 532 vh.mImageView.setLayoutParams(layoutParams); 533 vh.mImageView.setImageDrawable(row.getImageDrawable()); 534 if (row.getImageDrawable() != null && mSharedElementHelper != null) { 535 mSharedElementHelper.onBindToDrawable(vh); 536 } 537 } 538 539 @Override 540 protected void onBindRowViewHolder(RowPresenter.ViewHolder holder, Object item) { 541 super.onBindRowViewHolder(holder, item); 542 543 DetailsOverviewRow row = (DetailsOverviewRow) item; 544 ViewHolder vh = (ViewHolder) holder; 545 546 bindImageDrawable(vh); 547 mDetailsPresenter.onBindViewHolder(vh.mDetailsDescriptionViewHolder, row.getItem()); 548 vh.bindActions(row.getActionsAdapter()); 549 row.addListener(vh.mListener); 550 } 551 552 @Override 553 protected void onUnbindRowViewHolder(RowPresenter.ViewHolder holder) { 554 ViewHolder vh = (ViewHolder) holder; 555 DetailsOverviewRow dor = (DetailsOverviewRow) vh.getRow(); 556 dor.removeListener(vh.mListener); 557 if (vh.mDetailsDescriptionViewHolder != null) { 558 mDetailsPresenter.onUnbindViewHolder(vh.mDetailsDescriptionViewHolder); 559 } 560 super.onUnbindRowViewHolder(holder); 561 } 562 563 @Override 564 public final boolean isUsingDefaultSelectEffect() { 565 return false; 566 } 567 568 @Override 569 protected void onSelectLevelChanged(RowPresenter.ViewHolder holder) { 570 super.onSelectLevelChanged(holder); 571 if (getSelectEffectEnabled()) { 572 ViewHolder vh = (ViewHolder) holder; 573 int dimmedColor = vh.mColorDimmer.getPaint().getColor(); 574 ((ColorDrawable) vh.mOverviewFrame.getForeground().mutate()).setColor(dimmedColor); 575 } 576 } 577 578 @Override 579 protected void onRowViewAttachedToWindow(RowPresenter.ViewHolder vh) { 580 super.onRowViewAttachedToWindow(vh); 581 if (mDetailsPresenter != null) { 582 mDetailsPresenter.onViewAttachedToWindow( 583 ((ViewHolder) vh).mDetailsDescriptionViewHolder); 584 } 585 } 586 587 @Override 588 protected void onRowViewDetachedFromWindow(RowPresenter.ViewHolder vh) { 589 super.onRowViewDetachedFromWindow(vh); 590 if (mDetailsPresenter != null) { 591 mDetailsPresenter.onViewDetachedFromWindow( 592 ((ViewHolder) vh).mDetailsDescriptionViewHolder); 593 } 594 } 595} 596