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