RowsFragment.java revision 0946602a3f3815a5f7d46dfc571b3c60483f1ea4 
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.app;
15
16import android.animation.TimeAnimator;
17import android.animation.TimeAnimator.TimeListener;
18import android.graphics.Canvas;
19import android.os.Bundle;
20import android.support.v17.leanback.R;
21import android.support.v17.leanback.graphics.ColorOverlayDimmer;
22import android.support.v17.leanback.widget.ItemBridgeAdapter;
23import android.support.v17.leanback.widget.VerticalGridView;
24import android.support.v17.leanback.widget.OnItemSelectedListener;
25import android.support.v17.leanback.widget.OnItemClickedListener;
26import android.support.v17.leanback.widget.RowPresenter;
27import android.support.v17.leanback.widget.Presenter;
28import android.support.v17.leanback.widget.RowPresenter.ViewHolder;
29import android.support.v7.widget.RecyclerView;
30import android.util.Log;
31import android.view.View;
32import android.view.ViewGroup;
33import android.view.animation.DecelerateInterpolator;
34import android.view.animation.Interpolator;
35
36/**
37 * An ordered set of rows of leanback widgets.
38 */
39public class RowsFragment extends BaseRowFragment {
40
41    /**
42     * Internal helper class that manages row select animation and apply a default
43     * dim to each row.
44     */
45    final class RowViewHolderExtra implements TimeListener {
46        final RowPresenter mRowPresenter;
47        final RowPresenter.ViewHolder mRowViewHolder;
48
49        final TimeAnimator mSelectAnimator = new TimeAnimator();
50        final ColorOverlayDimmer mColorDimmer;
51        int mSelectAnimatorDurationInUse;
52        Interpolator mSelectAnimatorInterpolatorInUse;
53        float mSelectLevelAnimStart;
54        float mSelectLevelAnimDelta;
55
56        RowViewHolderExtra(ItemBridgeAdapter.ViewHolder ibvh) {
57            mRowPresenter = (RowPresenter) ibvh.getPresenter();
58            mRowViewHolder = (ViewHolder) ibvh.getViewHolder();
59            mSelectAnimator.setTimeListener(this);
60            if (mRowPresenter.getSelectEffectEnabled()
61                    && mRowPresenter.isUsingDefaultSelectEffect()) {
62                mColorDimmer = ColorOverlayDimmer.createDefault(ibvh.itemView.getContext());
63            } else {
64                mColorDimmer = null;
65            }
66        }
67
68        @Override
69        public void onTimeUpdate(TimeAnimator animation, long totalTime, long deltaTime) {
70            float fraction;
71            if (totalTime >= mSelectAnimatorDurationInUse) {
72                fraction = 1;
73                mSelectAnimator.end();
74            } else {
75                fraction = (float) (totalTime / (double) mSelectAnimatorDurationInUse);
76            }
77            if (mSelectAnimatorInterpolatorInUse != null) {
78                fraction = mSelectAnimatorInterpolatorInUse.getInterpolation(fraction);
79            }
80            float level =  mSelectLevelAnimStart + fraction * mSelectLevelAnimDelta;
81            if (mColorDimmer != null) {
82                mColorDimmer.setActiveLevel(level);
83            }
84            mRowPresenter.setSelectLevel(mRowViewHolder, level);
85        }
86
87        void animateSelect(boolean select, boolean immediate) {
88            endAnimation();
89            final float end = select ? 1 : 0;
90            if (immediate) {
91                mRowPresenter.setSelectLevel(mRowViewHolder, end);
92                if (mColorDimmer != null) {
93                    mColorDimmer.setActiveLevel(end);
94                }
95            } else if (mRowPresenter.getSelectLevel(mRowViewHolder) != end) {
96                mSelectAnimatorDurationInUse = mSelectAnimatorDuration;
97                mSelectAnimatorInterpolatorInUse = mSelectAnimatorInterpolator;
98                mSelectLevelAnimStart = mRowPresenter.getSelectLevel(mRowViewHolder);
99                mSelectLevelAnimDelta = end - mSelectLevelAnimStart;
100                mSelectAnimator.start();
101            }
102        }
103
104        void endAnimation() {
105            mSelectAnimator.end();
106        }
107
108        void drawDimForSelection(Canvas c) {
109            if (mColorDimmer != null) {
110                mColorDimmer.drawColorOverlay(c, mRowViewHolder.view, false);
111            }
112        }
113    }
114
115    private static final String TAG = "RowsFragment";
116    private static final boolean DEBUG = false;
117
118    private BackgroundParams mBackgroundParams;
119    private ItemBridgeAdapter.ViewHolder mSelectedViewHolder;
120    private boolean mExpand = true;
121    private boolean mViewsCreated;
122
123    private OnItemSelectedListener mOnItemSelectedListener;
124    private OnItemClickedListener mOnItemClickedListener;
125
126    // Select animation and interpolator are not intended to exposed at this moment.
127    // They might be synced with vertical scroll animation later.
128    int mSelectAnimatorDuration;
129    Interpolator mSelectAnimatorInterpolator = new DecelerateInterpolator(2);
130
131    /**
132     * Set background parameters.
133     * @deprecated Use BackgroundManager instead
134     */
135    @Deprecated
136    public void setBackgroundParams(BackgroundParams params) {
137        mBackgroundParams = params;
138    }
139
140    /**
141     * Returns the background parameters.
142     * @deprecated Use BackgroundManager instead
143     */
144    @Deprecated
145    public BackgroundParams getBackgroundParams() {
146        return mBackgroundParams;
147    }
148
149    /**
150     * Sets an item clicked listener on the fragment.
151     * OnItemClickedListener will override {@link View.OnClickListener} that
152     * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}.
153     * So in general,  developer should choose one of the listeners but not both.
154     */
155    public void setOnItemClickedListener(OnItemClickedListener listener) {
156        mOnItemClickedListener = listener;
157        if (mViewsCreated) {
158            throw new IllegalStateException(
159                    "Item clicked listener must be set before views are created");
160        }
161    }
162
163    /**
164     * Returns the item clicked listener.
165     */
166    public OnItemClickedListener getOnItemClickedListener() {
167        return mOnItemClickedListener;
168    }
169
170    /**
171     * Set the visibility of titles/hovercard of browse rows.
172     */
173    public void setExpand(boolean expand) {
174        mExpand = expand;
175        VerticalGridView listView = getVerticalGridView();
176        if (listView != null) {
177            final int count = listView.getChildCount();
178            if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count);
179            for (int i = 0; i < count; i++) {
180                View view = listView.getChildAt(i);
181                ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) listView.getChildViewHolder(view);
182                setRowViewExpanded(vh, mExpand);
183            }
184        }
185    }
186
187    /**
188     * Sets an item selection listener.
189     */
190    public void setOnItemSelectedListener(OnItemSelectedListener listener) {
191        mOnItemSelectedListener = listener;
192        VerticalGridView listView = getVerticalGridView();
193        if (listView != null) {
194            final int count = listView.getChildCount();
195            for (int i = 0; i < count; i++) {
196                View view = listView.getChildAt(i);
197                ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder)
198                        listView.getChildViewHolder(view);
199                setOnItemSelectedListener(vh, mOnItemSelectedListener);
200            }
201        }
202    }
203
204    @Override
205    protected void onRowSelected(ViewGroup parent, View view, int position, long id) {
206        ItemBridgeAdapter.ViewHolder vh = (view == null) ? null :
207            (ItemBridgeAdapter.ViewHolder) getVerticalGridView().getChildViewHolder(view);
208
209        if (mSelectedViewHolder != vh) {
210            if (DEBUG) Log.v(TAG, "new row selected position " + position + " view " + view);
211
212            if (mSelectedViewHolder != null) {
213                setRowViewSelected(mSelectedViewHolder, false, false);
214            }
215            mSelectedViewHolder = vh;
216            if (mSelectedViewHolder != null) {
217                setRowViewSelected(mSelectedViewHolder, true, false);
218            }
219        }
220    }
221
222    @Override
223    protected int getLayoutResourceId() {
224        return R.layout.lb_rows_fragment;
225    }
226
227    @Override
228    public void onCreate(Bundle savedInstanceState) {
229        super.onCreate(savedInstanceState);
230        mSelectAnimatorDuration = getResources().getInteger(R.integer.lb_browse_rows_anim_duration);
231    }
232
233    @Override
234    public void onViewCreated(View view, Bundle savedInstanceState) {
235        if (DEBUG) Log.v(TAG, "onViewCreated");
236        super.onViewCreated(view, savedInstanceState);
237        getVerticalGridView().setItemAlignmentViewId(R.id.row_content);
238        getVerticalGridView().addItemDecoration(mItemDecoration);
239    }
240
241    private RecyclerView.ItemDecoration mItemDecoration = new RecyclerView.ItemDecoration() {
242        @Override
243        public void onDrawOver(Canvas c, RecyclerView parent) {
244            final int count = parent.getChildCount();
245            for (int i = 0; i < count; i++) {
246                ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder)
247                        parent.getViewHolderForChildAt(i);
248                RowViewHolderExtra extra = (RowViewHolderExtra) ibvh.getExtraObject();
249                extra.drawDimForSelection(c);
250            }
251        }
252    };
253
254    private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) {
255        ((RowPresenter) vh.getPresenter()).setRowViewExpanded(
256                (RowPresenter.ViewHolder) vh.getViewHolder(), expanded);
257    }
258
259    private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected,
260            boolean immediate) {
261        RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject();
262        extra.animateSelect(selected, immediate);
263        ((RowPresenter) vh.getPresenter()).setRowViewSelected(
264                (RowPresenter.ViewHolder) vh.getViewHolder(), selected);
265    }
266
267    private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh,
268            OnItemSelectedListener listener) {
269        ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener);
270    }
271
272    private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener =
273            new ItemBridgeAdapter.AdapterListener() {
274        @Override
275        public void onAddPresenter(Presenter presenter) {
276            ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener);
277        }
278        @Override
279        public void onCreate(ItemBridgeAdapter.ViewHolder vh) {
280            Presenter rowPresenter = vh.getPresenter();
281            if (((RowPresenter) vh.getPresenter()).canDrawOutOfBounds()) {
282                getVerticalGridView().setClipChildren(false);
283            }
284            mViewsCreated = true;
285            vh.setExtraObject(new RowViewHolderExtra(vh));
286            // selected state is initialized to false, then driven by grid view onChildSelected
287            // events.  When there is rebind, grid view fires onChildSelected event properly.
288            // So we don't need do anything special later in onBind or onAttachedToWindow.
289            setRowViewSelected(vh, false, true);
290        }
291        @Override
292        public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) {
293            if (DEBUG) Log.v(TAG, "onAttachToWindow");
294            // All views share the same mExpand value.  When we attach a view to grid view,
295            // we should make sure it pick up the latest mExpand value we set early on other
296            // attached views.  For no-structure-change update,  the view is rebound to new data,
297            // but again it should use the unchanged mExpand value,  so we don't need do any
298            // thing in onBind.
299            setRowViewExpanded(vh, mExpand);
300            setOnItemSelectedListener(vh, mOnItemSelectedListener);
301        }
302        @Override
303        public void onUnbind(ItemBridgeAdapter.ViewHolder vh) {
304            RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject();
305            extra.endAnimation();
306        }
307    };
308
309    @Override
310    protected void updateAdapter() {
311        super.updateAdapter();
312        mSelectedViewHolder = null;
313        mViewsCreated = false;
314
315        ItemBridgeAdapter adapter = getBridgeAdapter();
316        if (adapter != null) {
317            adapter.setAdapterListener(mBridgeAdapterListener);
318        }
319    }
320}