RowPresenter.java revision 961a8f12d1fbeeb86ea066f9f2c693abb2ce50f2
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.support.v17.leanback.app.HeadersFragment; 17import android.view.View; 18import android.view.ViewGroup; 19 20/** 21 * An abstract {@link Presenter} that renders a {@link Row}. 22 * 23 * <h3>Customize UI widgets</h3> 24 * When a subclass of RowPresenter adds UI widgets, it should subclass 25 * {@link RowPresenter.ViewHolder} and override {@link #createRowViewHolder(ViewGroup)} 26 * and {@link #initializeRowViewHolder(ViewHolder)}. The subclass must use layout id 27 * "row_content" for the widget that will be aligned to the title of any {@link HeadersFragment} 28 * that may exist in the parent fragment. RowPresenter contains an optional and 29 * replaceable {@link RowHeaderPresenter} that renders the header. You can disable 30 * the default rendering or replace the Presenter with a new header presenter 31 * by calling {@link #setHeaderPresenter(RowHeaderPresenter)}. 32 * 33 * <h3>UI events from fragments</h3> 34 * RowPresenter receives calls from its parent (typically a Fragment) when: 35 * <ul> 36 * <li> 37 * A Row is selected via {@link #setRowViewSelected(Presenter.ViewHolder, boolean)}. The event 38 * is triggered immediately when there is a row selection change before the selection 39 * animation is started. 40 * Subclasses of RowPresenter may override {@link #onRowViewSelected(ViewHolder, boolean)}. 41 * </li> 42 * <li> 43 * A Row is expanded to full width via {@link #setRowViewExpanded(Presenter.ViewHolder, boolean)}. 44 * The event is triggered immediately before the expand animation is started. 45 * Subclasses of RowPresenter may override {@link #onRowViewExpanded(ViewHolder, boolean)}. 46 * </li> 47 * </ul> 48 * 49 * <h3>User events</h3> 50 * RowPresenter provides {@link OnItemSelectedListener} and {@link OnItemClickedListener}. 51 * If a subclass wants to add its own {@link View.OnFocusChangeListener} or 52 * {@link View.OnClickListener}, it must do that in {@link #createRowViewHolder(ViewGroup)} 53 * to be properly chained by the library. Adding View listeners after 54 * {@link #createRowViewHolder(ViewGroup)} is undefined and may result in 55 * incorrect behavior by the library's listeners. 56 * 57 * <h3>Selection animation</h3> 58 * <p> 59 * When a user scrolls through rows, a fragment will initiate animation and call 60 * {@link #setSelectLevel(Presenter.ViewHolder, float)} with float value between 61 * 0 and 1. By default, the RowPresenter draws a dim overlay on top of the row 62 * view for views that are not selected. Subclasses may override this default effect 63 * by having {@link #isUsingDefaultSelectEffect()} return false and overriding 64 * {@link #onSelectLevelChanged(ViewHolder)} to apply a different selection effect. 65 * </p> 66 * <p> 67 * Call {@link #setSelectEffectEnabled(boolean)} to enable/disable the select effect, 68 * This will not only enable/disable the default dim effect but also subclasses must 69 * respect this flag as well. 70 * </p> 71 */ 72public abstract class RowPresenter extends Presenter { 73 74 static class ContainerViewHolder extends Presenter.ViewHolder { 75 /** 76 * wrapped row view holder 77 */ 78 final ViewHolder mRowViewHolder; 79 80 public ContainerViewHolder(RowContainerView containerView, ViewHolder rowViewHolder) { 81 super(containerView); 82 containerView.addRowView(rowViewHolder.view); 83 if (rowViewHolder.mHeaderViewHolder != null) { 84 containerView.addHeaderView(rowViewHolder.mHeaderViewHolder.view); 85 } 86 mRowViewHolder = rowViewHolder; 87 mRowViewHolder.mContainerViewHolder = this; 88 } 89 } 90 91 /** 92 * A view holder for a {@link Row}. 93 */ 94 public static class ViewHolder extends Presenter.ViewHolder { 95 ContainerViewHolder mContainerViewHolder; 96 RowHeaderPresenter.ViewHolder mHeaderViewHolder; 97 Row mRow; 98 boolean mSelected; 99 boolean mExpanded; 100 boolean mInitialzed; 101 float mSelectLevel = 0f; // initially unselected 102 103 /** 104 * Constructor for ViewHolder. 105 * 106 * @param view The View bound to the Row. 107 */ 108 public ViewHolder(View view) { 109 super(view); 110 } 111 112 /** 113 * Returns the Row bound to the View in this ViewHolder. 114 */ 115 public final Row getRow() { 116 return mRow; 117 } 118 119 /** 120 * Returns whether the Row is in its expanded state. 121 * 122 * @return true if the Row is expanded, false otherwise. 123 */ 124 public final boolean isExpanded() { 125 return mExpanded; 126 } 127 128 /** 129 * Returns whether the Row is selected. 130 * 131 * @return true if the Row is selected, false otherwise. 132 */ 133 public final boolean isSelected() { 134 return mSelected; 135 } 136 137 /** 138 * Returns the current selection level of the Row. 139 */ 140 public final float getSelectLevel() { 141 return mSelectLevel; 142 } 143 144 /** 145 * Returns the view holder for the Row header for this Row. 146 */ 147 public final RowHeaderPresenter.ViewHolder getHeaderViewHolder() { 148 return mHeaderViewHolder; 149 } 150 } 151 152 private RowHeaderPresenter mHeaderPresenter = new RowHeaderPresenter(); 153 private OnItemSelectedListener mOnItemSelectedListener; 154 private OnItemClickedListener mOnItemClickedListener; 155 156 boolean mSelectEffectEnabled = true; 157 158 @Override 159 public final Presenter.ViewHolder onCreateViewHolder(ViewGroup parent) { 160 ViewHolder vh = createRowViewHolder(parent); 161 vh.mInitialzed = false; 162 Presenter.ViewHolder result; 163 if (needsRowContainerView()) { 164 RowContainerView containerView = new RowContainerView(parent.getContext()); 165 if (mHeaderPresenter != null) { 166 vh.mHeaderViewHolder = (RowHeaderPresenter.ViewHolder) 167 mHeaderPresenter.onCreateViewHolder((ViewGroup) vh.view); 168 } 169 result = new ContainerViewHolder(containerView, vh); 170 } else { 171 result = vh; 172 } 173 initializeRowViewHolder(vh); 174 if (!vh.mInitialzed) { 175 throw new RuntimeException("super.initializeRowViewHolder() must be called"); 176 } 177 return result; 178 } 179 180 /** 181 * Called to create a ViewHolder object for a Row. Subclasses will override 182 * this method to return a different concrete ViewHolder object. 183 * 184 * @param parent The parent View for the Row's view holder. 185 * @return A ViewHolder for the Row's View. 186 */ 187 protected abstract ViewHolder createRowViewHolder(ViewGroup parent); 188 189 /** 190 * Called after a {@link RowPresenter.ViewHolder} is created for a Row. 191 * Subclasses may override this method and start by calling 192 * super.initializeRowViewHolder(ViewHolder). 193 * 194 * @param vh The ViewHolder to initialize for the Row. 195 */ 196 protected void initializeRowViewHolder(ViewHolder vh) { 197 vh.mInitialzed = true; 198 } 199 200 /** 201 * Set the Presenter used for rendering the header. Can be null to disable 202 * header rendering. The method must be called before creating any Row Views. 203 */ 204 public final void setHeaderPresenter(RowHeaderPresenter headerPresenter) { 205 mHeaderPresenter = headerPresenter; 206 } 207 208 /** 209 * Get the Presenter used for rendering the header, or null if none has been 210 * set. 211 */ 212 public final RowHeaderPresenter getHeaderPresenter() { 213 return mHeaderPresenter; 214 } 215 216 /** 217 * Get the {@link RowPresenter.ViewHolder} from the given Presenter 218 * ViewHolder. 219 */ 220 public final ViewHolder getRowViewHolder(Presenter.ViewHolder holder) { 221 if (holder instanceof ContainerViewHolder) { 222 return ((ContainerViewHolder) holder).mRowViewHolder; 223 } else { 224 return (ViewHolder) holder; 225 } 226 } 227 228 /** 229 * Set the expanded state of a Row view. 230 * 231 * @param holder The Row ViewHolder to set expanded state on. 232 * @param expanded True if the Row is expanded, false otherwise. 233 */ 234 public final void setRowViewExpanded(Presenter.ViewHolder holder, boolean expanded) { 235 ViewHolder rowViewHolder = getRowViewHolder(holder); 236 rowViewHolder.mExpanded = expanded; 237 onRowViewExpanded(rowViewHolder, expanded); 238 } 239 240 /** 241 * Set the selected state of a Row view. 242 * 243 * @param holder The Row ViewHolder to set expanded state on. 244 * @param selected True if the Row is expanded, false otherwise. 245 */ 246 public final void setRowViewSelected(Presenter.ViewHolder holder, boolean selected) { 247 ViewHolder rowViewHolder = getRowViewHolder(holder); 248 rowViewHolder.mSelected = selected; 249 onRowViewSelected(rowViewHolder, selected); 250 } 251 252 /** 253 * Subclass may override this to respond to expanded state changes of a Row. 254 * The default implementation will hide/show the header view. Subclasses may 255 * make visual changes to the Row View but must not create animation on the 256 * Row view. 257 */ 258 protected void onRowViewExpanded(ViewHolder vh, boolean expanded) { 259 updateHeaderViewVisibility(vh); 260 vh.view.setActivated(expanded); 261 } 262 263 /** 264 * Subclass may override this to respond to selected state changes of a Row. 265 * Subclass may make visual changes to Row view but must not create 266 * animation on the Row view. 267 */ 268 protected void onRowViewSelected(ViewHolder vh, boolean selected) { 269 if (selected && mOnItemSelectedListener != null) { 270 mOnItemSelectedListener.onItemSelected(null, vh.getRow()); 271 } 272 updateHeaderViewVisibility(vh); 273 } 274 275 private void updateHeaderViewVisibility(ViewHolder vh) { 276 if (mHeaderPresenter != null && vh.mHeaderViewHolder != null) { 277 RowContainerView containerView = ((RowContainerView) vh.mContainerViewHolder.view); 278 containerView.showHeader(vh.isExpanded()); 279 } 280 } 281 282 /** 283 * Set the current select level to a value between 0 (unselected) and 1 (selected). 284 * Subclasses may override {@link #onSelectLevelChanged(ViewHolder)} to 285 * respond to changes in the selected level. 286 */ 287 public final void setSelectLevel(Presenter.ViewHolder vh, float level) { 288 ViewHolder rowViewHolder = getRowViewHolder(vh); 289 rowViewHolder.mSelectLevel = level; 290 onSelectLevelChanged(rowViewHolder); 291 } 292 293 /** 294 * Get the current select level. The value will be between 0 (unselected) 295 * and 1 (selected). 296 */ 297 public final float getSelectLevel(Presenter.ViewHolder vh) { 298 return getRowViewHolder(vh).mSelectLevel; 299 } 300 301 /** 302 * Callback when select level is changed. The default implementation applies 303 * the select level to {@link RowHeaderPresenter#setSelectLevel(RowHeaderPresenter.ViewHolder, float)} 304 * when {@link #getSelectEffectEnabled()} is true. Subclasses may override 305 * this function and implement a different select effect. In this case, you 306 * should also override {@link #isUsingDefaultSelectEffect()} to disable 307 * the default dimming effect applied by the library. 308 */ 309 protected void onSelectLevelChanged(ViewHolder vh) { 310 if (getSelectEffectEnabled() && vh.mHeaderViewHolder != null) { 311 mHeaderPresenter.setSelectLevel(vh.mHeaderViewHolder, vh.mSelectLevel); 312 } 313 } 314 315 /** 316 * Enables or disables the row selection effect. 317 * This will not only affect the default dim effect, but subclasses must 318 * respect this flag as well. 319 */ 320 public final void setSelectEffectEnabled(boolean applyDimOnSelect) { 321 mSelectEffectEnabled = applyDimOnSelect; 322 } 323 324 /** 325 * Returns true if the row selection effect is enabled. 326 * This value not only determines whether the default dim implementation is 327 * used, but subclasses must also respect this flag. 328 */ 329 public final boolean getSelectEffectEnabled() { 330 return mSelectEffectEnabled; 331 } 332 333 /** 334 * Return whether this RowPresenter is using the default dimming effect 335 * provided by the library. Subclasses may(most likely) return false and 336 * override {@link #onSelectLevelChanged(ViewHolder)}. 337 */ 338 public boolean isUsingDefaultSelectEffect() { 339 return true; 340 } 341 342 final boolean needsDefaultSelectEffect() { 343 return isUsingDefaultSelectEffect() && getSelectEffectEnabled(); 344 } 345 346 final boolean needsRowContainerView() { 347 return mHeaderPresenter != null; 348 } 349 350 /** 351 * Return true if the Row view can draw outside its bounds. 352 */ 353 public boolean canDrawOutOfBounds() { 354 return false; 355 } 356 357 @Override 358 public final void onBindViewHolder(Presenter.ViewHolder viewHolder, Object item) { 359 onBindRowViewHolder(getRowViewHolder(viewHolder), item); 360 } 361 362 protected void onBindRowViewHolder(ViewHolder vh, Object item) { 363 vh.mRow = (Row) item; 364 if (vh.mHeaderViewHolder != null) { 365 mHeaderPresenter.onBindViewHolder(vh.mHeaderViewHolder, item); 366 } 367 } 368 369 @Override 370 public final void onUnbindViewHolder(Presenter.ViewHolder viewHolder) { 371 onUnbindRowViewHolder(getRowViewHolder(viewHolder)); 372 } 373 374 protected void onUnbindRowViewHolder(ViewHolder vh) { 375 if (vh.mHeaderViewHolder != null) { 376 mHeaderPresenter.onUnbindViewHolder(vh.mHeaderViewHolder); 377 } 378 vh.mRow = null; 379 } 380 381 @Override 382 public final void onViewAttachedToWindow(Presenter.ViewHolder holder) { 383 onRowViewAttachedToWindow(getRowViewHolder(holder)); 384 } 385 386 protected void onRowViewAttachedToWindow(ViewHolder vh) { 387 if (vh.mHeaderViewHolder != null) { 388 mHeaderPresenter.onViewAttachedToWindow(vh.mHeaderViewHolder); 389 } 390 } 391 392 @Override 393 public final void onViewDetachedFromWindow(Presenter.ViewHolder holder) { 394 onRowViewDetachedFromWindow(getRowViewHolder(holder)); 395 } 396 397 protected void onRowViewDetachedFromWindow(ViewHolder vh) { 398 if (vh.mHeaderViewHolder != null) { 399 mHeaderPresenter.onViewDetachedFromWindow(vh.mHeaderViewHolder); 400 } 401 } 402 403 /** 404 * Set the listener for item or row selection. A RowPresenter fires a row 405 * selection event with a null item. Subclasses (e.g. {@link ListRowPresenter}) 406 * can fire a selection event with the selected item. 407 */ 408 public final void setOnItemSelectedListener(OnItemSelectedListener listener) { 409 mOnItemSelectedListener = listener; 410 } 411 412 /** 413 * Get the listener for item or row selection. 414 */ 415 public final OnItemSelectedListener getOnItemSelectedListener() { 416 return mOnItemSelectedListener; 417 } 418 419 /** 420 * Set the listener for item click events. A RowPresenter does not use this 421 * listener, but a subclass may fire an item click event if it has the concept 422 * of an item. The {@link OnItemClickedListener} will override any 423 * {@link View.OnClickListener} that an item's Presenter sets during 424 * {@link Presenter#onCreateViewHolder(ViewGroup)}. So in general, you 425 * should choose to use an OnItemClickedListener or a {@link 426 * View.OnClickListener}, but not both. 427 */ 428 public final void setOnItemClickedListener(OnItemClickedListener listener) { 429 mOnItemClickedListener = listener; 430 } 431 432 /** 433 * Get the listener for item click events. 434 */ 435 public final OnItemClickedListener getOnItemClickedListener() { 436 return mOnItemClickedListener; 437 } 438} 439