PlaybackControlsRowPresenter.java revision a00bada00bff4a58436a39472ab14ccb7a8f619d 
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.graphics.drawable.Drawable;
17import android.support.v17.leanback.R;
18import android.support.v17.leanback.widget.ControlBarPresenter.OnControlClickedListener;
19import android.support.v17.leanback.widget.ControlBarPresenter.OnControlSelectedListener;
20import android.content.Context;
21import android.graphics.Color;
22import android.util.TypedValue;
23import android.view.KeyEvent;
24import android.view.LayoutInflater;
25import android.view.View;
26import android.view.ViewGroup;
27import android.view.ViewGroup.LayoutParams;
28import android.view.ViewGroup.MarginLayoutParams;
29import android.widget.ImageView;
30import android.widget.LinearLayout;
31
32/**
33 * A PlaybackControlsRowPresenter renders a {@link PlaybackControlsRow} to display a
34 * series of playback control buttons. Typically this row will be the first row in a fragment
35 * such as the {@link android.support.v17.leanback.app.PlaybackOverlayFragment}.
36 *
37 * <p>The detailed description is rendered using a {@link Presenter} passed in
38 * {@link #PlaybackControlsRowPresenter(Presenter)}.  Typically this will be an instance of
39 * {@link AbstractDetailsDescriptionPresenter}.  The application can access the
40 * detailed description ViewHolder from {@link ViewHolder#mDescriptionViewHolder}.
41 * </p>
42 */
43public class PlaybackControlsRowPresenter extends RowPresenter {
44
45    static class BoundData extends PlaybackControlsPresenter.BoundData {
46        ViewHolder mRowViewHolder;
47    }
48
49    /**
50     * A ViewHolder for the PlaybackControlsRow.
51     */
52    public class ViewHolder extends RowPresenter.ViewHolder {
53        public final Presenter.ViewHolder mDescriptionViewHolder;
54        final ViewGroup mCard;
55        final ViewGroup mCardRightPanel;
56        final ImageView mImageView;
57        final ViewGroup mDescriptionDock;
58        final ViewGroup mControlsDock;
59        final ViewGroup mSecondaryControlsDock;
60        final View mSpacer;
61        final View mBottomSpacer;
62        View mBgView;
63        int mControlsDockMarginStart;
64        int mControlsDockMarginEnd;
65        PlaybackControlsPresenter.ViewHolder mControlsVh;
66        Presenter.ViewHolder mSecondaryControlsVh;
67        BoundData mControlsBoundData = new BoundData();
68        BoundData mSecondaryBoundData = new BoundData();
69        Presenter.ViewHolder mSelectedViewHolder;
70        Object mSelectedItem;
71        final PlaybackControlsRow.OnPlaybackStateChangedListener mListener =
72                new PlaybackControlsRow.OnPlaybackStateChangedListener() {
73            @Override
74            public void onCurrentTimeChanged(int ms) {
75                mPlaybackControlsPresenter.setCurrentTime(mControlsVh, ms);
76            }
77            @Override
78            public void onBufferedProgressChanged(int ms) {
79                mPlaybackControlsPresenter.setSecondaryProgress(mControlsVh, ms);
80            }
81        };
82
83        ViewHolder(View rootView, Presenter descriptionPresenter) {
84            super(rootView);
85            mCard = (ViewGroup) rootView.findViewById(R.id.controls_card);
86            mCardRightPanel = (ViewGroup) rootView.findViewById(R.id.controls_card_right_panel);
87            mImageView = (ImageView) rootView.findViewById(R.id.image);
88            mDescriptionDock = (ViewGroup) rootView.findViewById(R.id.description_dock);
89            mControlsDock = (ViewGroup) rootView.findViewById(R.id.controls_dock);
90            mSecondaryControlsDock =
91                    (ViewGroup) rootView.findViewById(R.id.secondary_controls_dock);
92            mSpacer = rootView.findViewById(R.id.spacer);
93            mBottomSpacer = rootView.findViewById(R.id.bottom_spacer);
94            mDescriptionViewHolder = descriptionPresenter == null ? null :
95                    descriptionPresenter.onCreateViewHolder(mDescriptionDock);
96            if (mDescriptionViewHolder != null) {
97                mDescriptionDock.addView(mDescriptionViewHolder.view);
98            }
99        }
100
101        void dispatchItemSelection() {
102            if (!isSelected()) {
103                return;
104            }
105            if (mSelectedViewHolder == null) {
106                if (getOnItemViewSelectedListener() != null) {
107                    getOnItemViewSelectedListener().onItemSelected(null, null,
108                            ViewHolder.this, getRow());
109                }
110            } else {
111                if (getOnItemViewSelectedListener() != null) {
112                    getOnItemViewSelectedListener().onItemSelected(mSelectedViewHolder, mSelectedItem,
113                            ViewHolder.this, getRow());
114                }
115            }
116        };
117
118        Presenter getPresenter(boolean primary) {
119            ObjectAdapter adapter = primary ?
120                    ((PlaybackControlsRow) getRow()).getPrimaryActionsAdapter() :
121                            ((PlaybackControlsRow) getRow()).getSecondaryActionsAdapter();
122            if (adapter == null) {
123                return null;
124            }
125            if (adapter.getPresenterSelector() instanceof ControlButtonPresenterSelector) {
126                ControlButtonPresenterSelector selector =
127                        (ControlButtonPresenterSelector) adapter.getPresenterSelector();
128                return primary ? selector.getPrimaryPresenter() :
129                    selector.getSecondaryPresenter();
130            }
131            return adapter.getPresenter(adapter.size() > 0 ? adapter.get(0) : null);
132        }
133
134        void setBackground(View view) {
135            if (mBgView != null) {
136                RoundedRectHelper.getInstance().clearBackground(mBgView);
137                ShadowHelper.getInstance().setZ(mBgView, 0);
138            }
139            mBgView = view;
140            RoundedRectHelper.getInstance().setRoundedRectBackground(view, mBackgroundColorSet ?
141                    mBackgroundColor : getDefaultBackgroundColor(view.getContext()));
142
143            if (sShadowZ == 0) {
144                sShadowZ = view.getResources().getDimensionPixelSize(
145                        R.dimen.lb_playback_controls_z);
146            }
147            ShadowHelper.getInstance().setZ(view, sShadowZ);
148        }
149    }
150
151    private int mBackgroundColor = Color.TRANSPARENT;
152    private boolean mBackgroundColorSet;
153    private int mProgressColor = Color.TRANSPARENT;
154    private boolean mProgressColorSet;
155    private boolean mSecondaryActionsHidden;
156    private Presenter mDescriptionPresenter;
157    private PlaybackControlsPresenter mPlaybackControlsPresenter;
158    private ControlBarPresenter mSecondaryControlsPresenter;
159    private OnActionClickedListener mOnActionClickedListener;
160    private static float sShadowZ;
161
162    private final OnControlSelectedListener mOnControlSelectedListener =
163            new OnControlSelectedListener() {
164        @Override
165        public void onControlSelected(Presenter.ViewHolder itemViewHolder, Object item,
166                ControlBarPresenter.BoundData data) {
167            ViewHolder vh = ((BoundData) data).mRowViewHolder;
168            if (vh.mSelectedViewHolder != itemViewHolder || vh.mSelectedItem != item) {
169                vh.mSelectedViewHolder = itemViewHolder;
170                vh.mSelectedItem = item;
171                vh.dispatchItemSelection();
172            }
173        }
174    };
175
176    private final OnControlClickedListener mOnControlClickedListener =
177            new OnControlClickedListener() {
178        @Override
179        public void onControlClicked(Presenter.ViewHolder itemViewHolder, Object item,
180                ControlBarPresenter.BoundData data) {
181            ViewHolder vh = ((BoundData) data).mRowViewHolder;
182            if (vh.getOnItemViewClickedListener() != null) {
183                vh.getOnItemViewClickedListener().onItemClicked(itemViewHolder, item,
184                        vh, vh.getRow());
185            }
186            if (mOnActionClickedListener != null && item instanceof Action) {
187                mOnActionClickedListener.onActionClicked((Action) item);
188            }
189        }
190    };
191
192    /**
193     * Constructor for a PlaybackControlsRowPresenter.
194     *
195     * @param descriptionPresenter Presenter for displaying item details.
196     */
197    public PlaybackControlsRowPresenter(Presenter descriptionPresenter) {
198        setHeaderPresenter(null);
199        setSelectEffectEnabled(false);
200
201        mDescriptionPresenter = descriptionPresenter;
202        mPlaybackControlsPresenter = new PlaybackControlsPresenter(R.layout.lb_playback_controls);
203        mSecondaryControlsPresenter = new ControlBarPresenter(R.layout.lb_control_bar);
204
205        mPlaybackControlsPresenter.setOnControlSelectedListener(mOnControlSelectedListener);
206        mSecondaryControlsPresenter.setOnControlSelectedListener(mOnControlSelectedListener);
207        mPlaybackControlsPresenter.setOnControlClickedListener(mOnControlClickedListener);
208        mSecondaryControlsPresenter.setOnControlClickedListener(mOnControlClickedListener);
209    }
210
211    /**
212     * Constructor for a PlaybackControlsRowPresenter.
213     */
214    public PlaybackControlsRowPresenter() {
215        this(null);
216    }
217
218    /**
219     * Sets the listener for {@link Action} click events.
220     */
221    public void setOnActionClickedListener(OnActionClickedListener listener) {
222        mOnActionClickedListener = listener;
223    }
224
225    /**
226     * Returns the listener for {@link Action} click events.
227     */
228    public OnActionClickedListener getOnActionClickedListener() {
229        return mOnActionClickedListener;
230    }
231
232    /**
233     * Sets the background color.  If not set, a default from the theme will be used.
234     */
235    public void setBackgroundColor(int color) {
236        mBackgroundColor = color;
237        mBackgroundColorSet = true;
238    }
239
240    /**
241     * Returns the background color.  If no background color was set, transparent
242     * is returned.
243     */
244    public int getBackgroundColor() {
245        return mBackgroundColor;
246    }
247
248    /**
249     * Sets the primary color for the progress bar.  If not set, a default from
250     * the theme will be used.
251     */
252    public void setProgressColor(int color) {
253        mProgressColor = color;
254        mProgressColorSet = true;
255    }
256
257    /**
258     * Returns the primary color for the progress bar.  If no color was set, transparent
259     * is returned.
260     */
261    public int getProgressColor() {
262        return mProgressColor;
263    }
264
265    /**
266     * Sets the secondary actions to be hidden behind a "more actions" button.
267     * When "more actions" is selected, the primary actions are replaced with
268     * the secondary actions.
269     */
270    public void setSecondaryActionsHidden(boolean hidden) {
271        mSecondaryActionsHidden = hidden;
272    }
273
274    /**
275     * Returns true if secondary actions are hidden.
276     */
277    public boolean areSecondaryActionsHidden() {
278        return mSecondaryActionsHidden;
279    }
280
281    /**
282     * Shows or hides space at the bottom of the playback controls row.
283     * This allows the row to hug the bottom of the display when no
284     * other rows are present.
285     */
286    public void showBottomSpace(ViewHolder vh, boolean show) {
287        vh.mBottomSpacer.setVisibility(show ? View.VISIBLE : View.GONE);
288    }
289
290    /**
291     * Displays the primary actions.  This will override the user having selected "more actions"
292     * to display the secondary actions; see {@link #setSecondaryActionsHidden(boolean)}.
293     */
294    public void showPrimaryActions(ViewHolder vh) {
295        mPlaybackControlsPresenter.showPrimaryActions(vh.mControlsVh);
296    }
297
298    private int getDefaultBackgroundColor(Context context) {
299        TypedValue outValue = new TypedValue();
300        if (context.getTheme().resolveAttribute(R.attr.defaultBrandColor, outValue, true)) {
301            return context.getResources().getColor(outValue.resourceId);
302        }
303        return context.getResources().getColor(R.color.lb_default_brand_color);
304    }
305
306    private int getDefaultProgressColor(Context context) {
307        TypedValue outValue = new TypedValue();
308        if (context.getTheme()
309                .resolveAttribute(R.attr.playbackProgressPrimaryColor, outValue, true)) {
310            return context.getResources().getColor(outValue.resourceId);
311        }
312        return context.getResources().getColor(R.color.lb_playback_progress_color_no_theme);
313    }
314
315    @Override
316    protected RowPresenter.ViewHolder createRowViewHolder(ViewGroup parent) {
317        View v = LayoutInflater.from(parent.getContext())
318            .inflate(R.layout.lb_playback_controls_row, parent, false);
319        ViewHolder vh = new ViewHolder(v, mDescriptionPresenter);
320        initRow(vh);
321        return vh;
322    }
323
324    private void initRow(final ViewHolder vh) {
325        MarginLayoutParams lp = (MarginLayoutParams) vh.mControlsDock.getLayoutParams();
326        vh.mControlsDockMarginStart = lp.getMarginStart();
327        vh.mControlsDockMarginEnd = lp.getMarginEnd();
328
329        vh.mControlsVh = (PlaybackControlsPresenter.ViewHolder)
330                mPlaybackControlsPresenter.onCreateViewHolder(vh.mControlsDock);
331        mPlaybackControlsPresenter.setProgressColor(vh.mControlsVh,
332                mProgressColorSet ? mProgressColor :
333                        getDefaultProgressColor(vh.mControlsDock.getContext()));
334        vh.mControlsDock.addView(vh.mControlsVh.view);
335
336        vh.mSecondaryControlsVh =
337                mSecondaryControlsPresenter.onCreateViewHolder(vh.mSecondaryControlsDock);
338        if (!mSecondaryActionsHidden) {
339            vh.mSecondaryControlsDock.addView(vh.mSecondaryControlsVh.view);
340        }
341        ((PlaybackControlsRowView) vh.view).setOnUnhandledKeyListener(
342                new PlaybackControlsRowView.OnUnhandledKeyListener() {
343            @Override
344            public boolean onUnhandledKey(KeyEvent event) {
345                if (vh.getOnKeyListener() != null) {
346                    if (vh.getOnKeyListener().onKey(vh.view, event.getKeyCode(), event)) {
347                        return true;
348                    }
349                }
350                return false;
351            }
352        });
353    }
354
355    @Override
356    protected void onBindRowViewHolder(RowPresenter.ViewHolder holder, Object item) {
357        super.onBindRowViewHolder(holder, item);
358
359        ViewHolder vh = (ViewHolder) holder;
360        PlaybackControlsRow row = (PlaybackControlsRow) vh.getRow();
361
362        mPlaybackControlsPresenter.enableSecondaryActions(mSecondaryActionsHidden);
363
364        if (row.getItem() == null) {
365            vh.mDescriptionDock.setVisibility(View.GONE);
366            vh.mSpacer.setVisibility(View.GONE);
367        } else {
368            vh.mDescriptionDock.setVisibility(View.VISIBLE);
369            if (vh.mDescriptionViewHolder != null) {
370                mDescriptionPresenter.onBindViewHolder(vh.mDescriptionViewHolder, row.getItem());
371            }
372            vh.mSpacer.setVisibility(View.VISIBLE);
373        }
374
375        if (row.getImageDrawable() == null || row.getItem() == null) {
376            vh.mImageView.setImageDrawable(null);
377            updateCardLayout(vh, LayoutParams.WRAP_CONTENT);
378        } else {
379            vh.mImageView.setImageDrawable(row.getImageDrawable());
380            updateCardLayout(vh, vh.mImageView.getLayoutParams().height);
381        }
382
383        vh.mControlsBoundData.adapter = row.getPrimaryActionsAdapter();
384        vh.mControlsBoundData.secondaryActionsAdapter = row.getSecondaryActionsAdapter();
385        vh.mControlsBoundData.presenter = vh.getPresenter(true);
386        vh.mControlsBoundData.mRowViewHolder = vh;
387        mPlaybackControlsPresenter.onBindViewHolder(vh.mControlsVh, vh.mControlsBoundData);
388
389        vh.mSecondaryBoundData.adapter = row.getSecondaryActionsAdapter();
390        vh.mSecondaryBoundData.presenter = vh.getPresenter(false);
391        vh.mSecondaryBoundData.mRowViewHolder = vh;
392        mSecondaryControlsPresenter.onBindViewHolder(vh.mSecondaryControlsVh,
393                vh.mSecondaryBoundData);
394
395        mPlaybackControlsPresenter.setTotalTime(vh.mControlsVh, row.getTotalTime());
396        mPlaybackControlsPresenter.setCurrentTime(vh.mControlsVh, row.getCurrentTime());
397        mPlaybackControlsPresenter.setSecondaryProgress(vh.mControlsVh, row.getBufferedProgress());
398        row.setOnPlaybackStateChangedListener(vh.mListener);
399    }
400
401    private void updateCardLayout(ViewHolder vh, int height) {
402        LayoutParams lp = vh.mCardRightPanel.getLayoutParams();
403        lp.height = height;
404        vh.mCardRightPanel.setLayoutParams(lp);
405
406        MarginLayoutParams mlp = (MarginLayoutParams) vh.mControlsDock.getLayoutParams();
407        LinearLayout.LayoutParams llp =
408                (LinearLayout.LayoutParams) vh.mDescriptionDock.getLayoutParams();
409
410        if (height == LayoutParams.WRAP_CONTENT) {
411            llp.height = LayoutParams.WRAP_CONTENT;
412            mlp.setMarginStart(0);
413            mlp.setMarginEnd(0);
414            vh.setBackground(vh.mControlsDock);
415            mPlaybackControlsPresenter.enableTimeMargins(vh.mControlsVh, true);
416        } else {
417            llp.height = 0;
418            llp.weight = 1;
419            mlp.setMarginStart(vh.mControlsDockMarginStart);
420            mlp.setMarginEnd(vh.mControlsDockMarginEnd);
421            vh.setBackground(vh.mCard);
422            mPlaybackControlsPresenter.enableTimeMargins(vh.mControlsVh, false);
423        }
424        vh.mDescriptionDock.setLayoutParams(llp);
425        vh.mControlsDock.setLayoutParams(mlp);
426    }
427
428    @Override
429    protected void onUnbindRowViewHolder(RowPresenter.ViewHolder holder) {
430        ViewHolder vh = (ViewHolder) holder;
431        PlaybackControlsRow row = (PlaybackControlsRow) vh.getRow();
432
433        if (vh.mDescriptionViewHolder != null) {
434            mDescriptionPresenter.onUnbindViewHolder(vh.mDescriptionViewHolder);
435        }
436        mPlaybackControlsPresenter.onUnbindViewHolder(vh.mControlsVh);
437        mSecondaryControlsPresenter.onUnbindViewHolder(vh.mSecondaryControlsVh);
438        row.setOnPlaybackStateChangedListener(null);
439
440        super.onUnbindRowViewHolder(holder);
441    }
442
443    @Override
444    protected void onRowViewSelected(RowPresenter.ViewHolder vh, boolean selected) {
445        super.onRowViewSelected(vh, selected);
446        if (selected) {
447            ((ViewHolder) vh).dispatchItemSelection();
448        }
449    }
450
451    @Override
452    protected void onRowViewAttachedToWindow(RowPresenter.ViewHolder vh) {
453        super.onRowViewAttachedToWindow(vh);
454        if (mDescriptionPresenter != null) {
455            mDescriptionPresenter.onViewAttachedToWindow(
456                    ((ViewHolder) vh).mDescriptionViewHolder);
457        }
458    }
459
460    @Override
461    protected void onRowViewDetachedFromWindow(RowPresenter.ViewHolder vh) {
462        super.onRowViewDetachedFromWindow(vh);
463        if (mDescriptionPresenter != null) {
464            mDescriptionPresenter.onViewDetachedFromWindow(
465                    ((ViewHolder) vh).mDescriptionViewHolder);
466        }
467    }
468}
469