RowsFragment.java revision 9e8e482b545c9c7d8db82c05993850d2f9038c5b 
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        final int count = getVerticalGridView().getChildCount();
175        if (DEBUG) Log.v(TAG, "setExpand " + expand + " count " + count);
176        mExpand = expand;
177        for (int i = 0; i < count; i++) {
178            View view = getVerticalGridView().getChildAt(i);
179            ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder) getVerticalGridView().getChildViewHolder(view);
180            setRowViewExpanded(vh, mExpand);
181        }
182    }
183
184    /**
185     * Sets an item selection listener.
186     */
187    public void setOnItemSelectedListener(OnItemSelectedListener listener) {
188        mOnItemSelectedListener = listener;
189        VerticalGridView listView = getVerticalGridView();
190        if (listView != null) {
191            final int count = listView.getChildCount();
192            for (int i = 0; i < count; i++) {
193                View view = listView.getChildAt(i);
194                ItemBridgeAdapter.ViewHolder vh = (ItemBridgeAdapter.ViewHolder)
195                        listView.getChildViewHolder(view);
196                setOnItemSelectedListener(vh, mOnItemSelectedListener);
197            }
198        }
199    }
200
201    @Override
202    protected void onRowSelected(ViewGroup parent, View view, int position, long id) {
203        ItemBridgeAdapter.ViewHolder vh = (view == null) ? null :
204            (ItemBridgeAdapter.ViewHolder) getVerticalGridView().getChildViewHolder(view);
205
206        if (mSelectedViewHolder != vh) {
207            if (DEBUG) Log.v(TAG, "new row selected position " + position + " view " + view);
208
209            if (mSelectedViewHolder != null) {
210                setRowViewSelected(mSelectedViewHolder, false, false);
211            }
212            mSelectedViewHolder = vh;
213            if (mSelectedViewHolder != null) {
214                setRowViewSelected(mSelectedViewHolder, true, false);
215            }
216        }
217    }
218
219    @Override
220    protected int getLayoutResourceId() {
221        return R.layout.lb_rows_fragment;
222    }
223
224    @Override
225    public void onCreate(Bundle savedInstanceState) {
226        super.onCreate(savedInstanceState);
227        mSelectAnimatorDuration = getResources().getInteger(R.integer.lb_browse_rows_anim_duration);
228    }
229
230    @Override
231    public void onViewCreated(View view, Bundle savedInstanceState) {
232        if (DEBUG) Log.v(TAG, "onViewCreated");
233        super.onViewCreated(view, savedInstanceState);
234        getVerticalGridView().setItemAlignmentViewId(R.id.row_content);
235        getVerticalGridView().addItemDecoration(mItemDecoration);
236    }
237
238    private RecyclerView.ItemDecoration mItemDecoration = new RecyclerView.ItemDecoration() {
239        @Override
240        public void onDrawOver(Canvas c, RecyclerView parent) {
241            final int count = parent.getChildCount();
242            for (int i = 0; i < count; i++) {
243                ItemBridgeAdapter.ViewHolder ibvh = (ItemBridgeAdapter.ViewHolder)
244                        parent.getViewHolderForChildAt(i);
245                RowViewHolderExtra extra = (RowViewHolderExtra) ibvh.getExtraObject();
246                extra.drawDimForSelection(c);
247            }
248        }
249    };
250
251    private static void setRowViewExpanded(ItemBridgeAdapter.ViewHolder vh, boolean expanded) {
252        ((RowPresenter) vh.getPresenter()).setRowViewExpanded(
253                (RowPresenter.ViewHolder) vh.getViewHolder(), expanded);
254    }
255
256    private static void setRowViewSelected(ItemBridgeAdapter.ViewHolder vh, boolean selected, boolean immediate) {
257        RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject();
258        extra.animateSelect(selected, immediate);
259        ((RowPresenter) vh.getPresenter()).setRowViewSelected(
260                (RowPresenter.ViewHolder) vh.getViewHolder(), selected);
261    }
262
263    private static void setOnItemSelectedListener(ItemBridgeAdapter.ViewHolder vh,
264            OnItemSelectedListener listener) {
265        ((RowPresenter) vh.getPresenter()).setOnItemSelectedListener(listener);
266    }
267
268    private final ItemBridgeAdapter.AdapterListener mBridgeAdapterListener = new ItemBridgeAdapter.AdapterListener() {
269        @Override
270        public void onAddPresenter(Presenter presenter) {
271            ((RowPresenter) presenter).setOnItemClickedListener(mOnItemClickedListener);
272        }
273        @Override
274        public void onCreate(ItemBridgeAdapter.ViewHolder vh) {
275            mViewsCreated = true;
276            vh.setExtraObject(new RowViewHolderExtra(vh));
277        }
278        @Override
279        public void onAttachedToWindow(ItemBridgeAdapter.ViewHolder vh) {
280            if (DEBUG) Log.v(TAG, "onAttachToWindow");
281            setRowViewExpanded(vh, mExpand);
282            setOnItemSelectedListener(vh, mOnItemSelectedListener);
283        }
284        @Override
285        public void onBind(ItemBridgeAdapter.ViewHolder vh) {
286            setRowViewSelected(vh, false, true);
287        }
288        @Override
289        public void onUnbind(ItemBridgeAdapter.ViewHolder vh) {
290            RowViewHolderExtra extra = (RowViewHolderExtra) vh.getExtraObject();
291            extra.endAnimation();
292        }
293    };
294
295    @Override
296    protected void updateAdapter() {
297        super.updateAdapter();
298        mSelectedViewHolder = null;
299        mViewsCreated = false;
300
301        ItemBridgeAdapter adapter = getBridgeAdapter();
302        if (adapter != null) {
303            adapter.setAdapterListener(mBridgeAdapterListener);
304        }
305    }
306}
307