BrowseFragment.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.app;
15
16import android.support.annotation.ColorInt;
17import android.support.v17.leanback.R;
18import android.support.v17.leanback.transition.LeanbackTransitionHelper;
19import android.support.v17.leanback.transition.TransitionHelper;
20import android.support.v17.leanback.transition.TransitionListener;
21import android.support.v17.leanback.widget.BrowseFrameLayout;
22import android.support.v17.leanback.widget.HorizontalGridView;
23import android.support.v17.leanback.widget.ItemBridgeAdapter;
24import android.support.v17.leanback.widget.OnItemViewClickedListener;
25import android.support.v17.leanback.widget.OnItemViewSelectedListener;
26import android.support.v17.leanback.widget.Presenter;
27import android.support.v17.leanback.widget.PresenterSelector;
28import android.support.v17.leanback.widget.RowHeaderPresenter;
29import android.support.v17.leanback.widget.RowPresenter;
30import android.support.v17.leanback.widget.TitleView;
31import android.support.v17.leanback.widget.VerticalGridView;
32import android.support.v17.leanback.widget.Row;
33import android.support.v17.leanback.widget.ObjectAdapter;
34import android.support.v17.leanback.widget.SearchOrbView;
35import android.support.v4.view.ViewCompat;
36import android.util.Log;
37import android.app.Activity;
38import android.app.Fragment;
39import android.app.FragmentManager;
40import android.app.FragmentManager.BackStackEntry;
41import android.content.Context;
42import android.content.res.TypedArray;
43import android.os.Bundle;
44import android.view.LayoutInflater;
45import android.view.View;
46import android.view.View.OnClickListener;
47import android.view.ViewGroup;
48import android.view.ViewGroup.MarginLayoutParams;
49import android.view.ViewTreeObserver;
50import android.graphics.Color;
51import android.graphics.Rect;
52import android.graphics.drawable.Drawable;
53import static android.support.v7.widget.RecyclerView.NO_POSITION;
54
55/**
56 * A fragment for creating Leanback browse screens. It is composed of a
57 * RowsFragment and a HeadersFragment.
58 * <p>
59 * A BrowseFragment renders the elements of its {@link ObjectAdapter} as a set
60 * of rows in a vertical list. The elements in this adapter must be subclasses
61 * of {@link Row}.
62 * <p>
63 * The HeadersFragment can be set to be either shown or hidden by default, or
64 * may be disabled entirely. See {@link #setHeadersState} for details.
65 * <p>
66 * By default the BrowseFragment includes support for returning to the headers
67 * when the user presses Back. For Activities that customize {@link
68 * android.app.Activity#onBackPressed()}, you must disable this default Back key support by
69 * calling {@link #setHeadersTransitionOnBackEnabled(boolean)} with false and
70 * use {@link BrowseFragment.BrowseTransitionListener} and
71 * {@link #startHeadersTransition(boolean)}.
72 * <p>
73 * The recommended theme to use with a BrowseFragment is
74 * {@link android.support.v17.leanback.R.style#Theme_Leanback_Browse}.
75 * </p>
76 */
77public class BrowseFragment extends BaseFragment {
78
79    // BUNDLE attribute for saving header show/hide status when backstack is used:
80    static final String HEADER_STACK_INDEX = "headerStackIndex";
81    // BUNDLE attribute for saving header show/hide status when backstack is not used:
82    static final String HEADER_SHOW = "headerShow";
83
84
85    final class BackStackListener implements FragmentManager.OnBackStackChangedListener {
86        int mLastEntryCount;
87        int mIndexOfHeadersBackStack;
88
89        BackStackListener() {
90            mLastEntryCount = getFragmentManager().getBackStackEntryCount();
91            mIndexOfHeadersBackStack = -1;
92        }
93
94        void load(Bundle savedInstanceState) {
95            if (savedInstanceState != null) {
96                mIndexOfHeadersBackStack = savedInstanceState.getInt(HEADER_STACK_INDEX, -1);
97                mShowingHeaders = mIndexOfHeadersBackStack == -1;
98            } else {
99                if (!mShowingHeaders) {
100                    getFragmentManager().beginTransaction()
101                            .addToBackStack(mWithHeadersBackStackName).commit();
102                }
103            }
104        }
105
106        void save(Bundle outState) {
107            outState.putInt(HEADER_STACK_INDEX, mIndexOfHeadersBackStack);
108        }
109
110
111        @Override
112        public void onBackStackChanged() {
113            if (getFragmentManager() == null) {
114                Log.w(TAG, "getFragmentManager() is null, stack:", new Exception());
115                return;
116            }
117            int count = getFragmentManager().getBackStackEntryCount();
118            // if backstack is growing and last pushed entry is "headers" backstack,
119            // remember the index of the entry.
120            if (count > mLastEntryCount) {
121                BackStackEntry entry = getFragmentManager().getBackStackEntryAt(count - 1);
122                if (mWithHeadersBackStackName.equals(entry.getName())) {
123                    mIndexOfHeadersBackStack = count - 1;
124                }
125            } else if (count < mLastEntryCount) {
126                // if popped "headers" backstack, initiate the show header transition if needed
127                if (mIndexOfHeadersBackStack >= count) {
128                    mIndexOfHeadersBackStack = -1;
129                    if (!mShowingHeaders) {
130                        startHeadersTransitionInternal(true);
131                    }
132                }
133            }
134            mLastEntryCount = count;
135        }
136    }
137
138    /**
139     * Listener for transitions between browse headers and rows.
140     */
141    public static class BrowseTransitionListener {
142        /**
143         * Callback when headers transition starts.
144         *
145         * @param withHeaders True if the transition will result in headers
146         *        being shown, false otherwise.
147         */
148        public void onHeadersTransitionStart(boolean withHeaders) {
149        }
150        /**
151         * Callback when headers transition stops.
152         *
153         * @param withHeaders True if the transition will result in headers
154         *        being shown, false otherwise.
155         */
156        public void onHeadersTransitionStop(boolean withHeaders) {
157        }
158    }
159
160    private class SetSelectionRunnable implements Runnable {
161        static final int TYPE_INVALID = -1;
162        static final int TYPE_INTERNAL_SYNC = 0;
163        static final int TYPE_USER_REQUEST = 1;
164
165        private int mPosition;
166        private int mType;
167        private boolean mSmooth;
168
169        SetSelectionRunnable() {
170            reset();
171        }
172
173        void post(int position, int type, boolean smooth) {
174            // Posting the set selection, rather than calling it immediately, prevents an issue
175            // with adapter changes.  Example: a row is added before the current selected row;
176            // first the fast lane view updates its selection, then the rows fragment has that
177            // new selection propagated immediately; THEN the rows view processes the same adapter
178            // change and moves the selection again.
179            if (type >= mType) {
180                mPosition = position;
181                mType = type;
182                mSmooth = smooth;
183                mBrowseFrame.removeCallbacks(this);
184                mBrowseFrame.post(this);
185            }
186        }
187
188        @Override
189        public void run() {
190            setSelection(mPosition, mSmooth);
191            reset();
192        }
193
194        private void reset() {
195            mPosition = -1;
196            mType = TYPE_INVALID;
197            mSmooth = false;
198        }
199    }
200
201    private static final String TAG = "BrowseFragment";
202
203    private static final String LB_HEADERS_BACKSTACK = "lbHeadersBackStack_";
204
205    private static boolean DEBUG = false;
206
207    /** The headers fragment is enabled and shown by default. */
208    public static final int HEADERS_ENABLED = 1;
209
210    /** The headers fragment is enabled and hidden by default. */
211    public static final int HEADERS_HIDDEN = 2;
212
213    /** The headers fragment is disabled and will never be shown. */
214    public static final int HEADERS_DISABLED = 3;
215
216    private RowsFragment mRowsFragment;
217    private HeadersFragment mHeadersFragment;
218
219    private ObjectAdapter mAdapter;
220
221    private int mHeadersState = HEADERS_ENABLED;
222    private int mBrandColor = Color.TRANSPARENT;
223    private boolean mBrandColorSet;
224
225    private BrowseFrameLayout mBrowseFrame;
226    private boolean mHeadersBackStackEnabled = true;
227    private String mWithHeadersBackStackName;
228    private boolean mShowingHeaders = true;
229    private boolean mCanShowHeaders = true;
230    private int mContainerListMarginStart;
231    private int mContainerListAlignTop;
232    private boolean mRowScaleEnabled = true;
233    private OnItemViewSelectedListener mExternalOnItemViewSelectedListener;
234    private OnItemViewClickedListener mOnItemViewClickedListener;
235    private int mSelectedPosition = -1;
236
237    private PresenterSelector mHeaderPresenterSelector;
238    private final SetSelectionRunnable mSetSelectionRunnable = new SetSelectionRunnable();
239
240    // transition related:
241    private Object mSceneWithHeaders;
242    private Object mSceneWithoutHeaders;
243    private Object mSceneAfterEntranceTransition;
244    private Object mHeadersTransition;
245    private BackStackListener mBackStackChangedListener;
246    private BrowseTransitionListener mBrowseTransitionListener;
247
248    private static final String ARG_TITLE = BrowseFragment.class.getCanonicalName() + ".title";
249    private static final String ARG_BADGE_URI = BrowseFragment.class.getCanonicalName() + ".badge";
250    private static final String ARG_HEADERS_STATE =
251        BrowseFragment.class.getCanonicalName() + ".headersState";
252
253    /**
254     * Creates arguments for a browse fragment.
255     *
256     * @param args The Bundle to place arguments into, or null if the method
257     *        should return a new Bundle.
258     * @param title The title of the BrowseFragment.
259     * @param headersState The initial state of the headers of the
260     *        BrowseFragment. Must be one of {@link #HEADERS_ENABLED}, {@link
261     *        #HEADERS_HIDDEN}, or {@link #HEADERS_DISABLED}.
262     * @return A Bundle with the given arguments for creating a BrowseFragment.
263     */
264    public static Bundle createArgs(Bundle args, String title, int headersState) {
265        if (args == null) {
266            args = new Bundle();
267        }
268        args.putString(ARG_TITLE, title);
269        args.putInt(ARG_HEADERS_STATE, headersState);
270        return args;
271    }
272
273    /**
274     * Sets the brand color for the browse fragment. The brand color is used as
275     * the primary color for UI elements in the browse fragment. For example,
276     * the background color of the headers fragment uses the brand color.
277     *
278     * @param color The color to use as the brand color of the fragment.
279     */
280    public void setBrandColor(@ColorInt int color) {
281        mBrandColor = color;
282        mBrandColorSet = true;
283
284        if (mHeadersFragment != null) {
285            mHeadersFragment.setBackgroundColor(mBrandColor);
286        }
287    }
288
289    /**
290     * Returns the brand color for the browse fragment.
291     * The default is transparent.
292     */
293    @ColorInt
294    public int getBrandColor() {
295        return mBrandColor;
296    }
297
298    /**
299     * Sets the adapter containing the rows for the fragment.
300     *
301     * <p>The items referenced by the adapter must be be derived from
302     * {@link Row}. These rows will be used by the rows fragment and the headers
303     * fragment (if not disabled) to render the browse rows.
304     *
305     * @param adapter An ObjectAdapter for the browse rows. All items must
306     *        derive from {@link Row}.
307     */
308    public void setAdapter(ObjectAdapter adapter) {
309        mAdapter = adapter;
310        if (mRowsFragment != null) {
311            mRowsFragment.setAdapter(adapter);
312            mHeadersFragment.setAdapter(adapter);
313        }
314    }
315
316    /**
317     * Returns the adapter containing the rows for the fragment.
318     */
319    public ObjectAdapter getAdapter() {
320        return mAdapter;
321    }
322
323    /**
324     * Sets an item selection listener.
325     */
326    public void setOnItemViewSelectedListener(OnItemViewSelectedListener listener) {
327        mExternalOnItemViewSelectedListener = listener;
328    }
329
330    /**
331     * Returns an item selection listener.
332     */
333    public OnItemViewSelectedListener getOnItemViewSelectedListener() {
334        return mExternalOnItemViewSelectedListener;
335    }
336
337    /**
338     * Sets an item clicked listener on the fragment.
339     * OnItemViewClickedListener will override {@link View.OnClickListener} that
340     * item presenter sets during {@link Presenter#onCreateViewHolder(ViewGroup)}.
341     * So in general,  developer should choose one of the listeners but not both.
342     */
343    public void setOnItemViewClickedListener(OnItemViewClickedListener listener) {
344        mOnItemViewClickedListener = listener;
345        if (mRowsFragment != null) {
346            mRowsFragment.setOnItemViewClickedListener(listener);
347        }
348    }
349
350    /**
351     * Returns the item Clicked listener.
352     */
353    public OnItemViewClickedListener getOnItemViewClickedListener() {
354        return mOnItemViewClickedListener;
355    }
356
357    /**
358     * Starts a headers transition.
359     *
360     * <p>This method will begin a transition to either show or hide the
361     * headers, depending on the value of withHeaders. If headers are disabled
362     * for this browse fragment, this method will throw an exception.
363     *
364     * @param withHeaders True if the headers should transition to being shown,
365     *        false if the transition should result in headers being hidden.
366     */
367    public void startHeadersTransition(boolean withHeaders) {
368        if (!mCanShowHeaders) {
369            throw new IllegalStateException("Cannot start headers transition");
370        }
371        if (isInHeadersTransition() || mShowingHeaders == withHeaders) {
372            return;
373        }
374        startHeadersTransitionInternal(withHeaders);
375    }
376
377    /**
378     * Returns true if the headers transition is currently running.
379     */
380    public boolean isInHeadersTransition() {
381        return mHeadersTransition != null;
382    }
383
384    /**
385     * Returns true if headers are shown.
386     */
387    public boolean isShowingHeaders() {
388        return mShowingHeaders;
389    }
390
391    /**
392     * Sets a listener for browse fragment transitions.
393     *
394     * @param listener The listener to call when a browse headers transition
395     *        begins or ends.
396     */
397    public void setBrowseTransitionListener(BrowseTransitionListener listener) {
398        mBrowseTransitionListener = listener;
399    }
400
401    /**
402     * Enables scaling of rows when headers are present.
403     * By default enabled to increase density.
404     *
405     * @param enable true to enable row scaling
406     */
407    public void enableRowScaling(boolean enable) {
408        mRowScaleEnabled = enable;
409        if (mRowsFragment != null) {
410            mRowsFragment.enableRowScaling(mRowScaleEnabled);
411        }
412    }
413
414    private void startHeadersTransitionInternal(final boolean withHeaders) {
415        if (getFragmentManager().isDestroyed()) {
416            return;
417        }
418        mShowingHeaders = withHeaders;
419        mRowsFragment.onExpandTransitionStart(!withHeaders, new Runnable() {
420            @Override
421            public void run() {
422                mHeadersFragment.onTransitionStart();
423                createHeadersTransition();
424                if (mBrowseTransitionListener != null) {
425                    mBrowseTransitionListener.onHeadersTransitionStart(withHeaders);
426                }
427                sTransitionHelper.runTransition(withHeaders ? mSceneWithHeaders : mSceneWithoutHeaders,
428                        mHeadersTransition);
429                if (mHeadersBackStackEnabled) {
430                    if (!withHeaders) {
431                        getFragmentManager().beginTransaction()
432                                .addToBackStack(mWithHeadersBackStackName).commit();
433                    } else {
434                        int index = mBackStackChangedListener.mIndexOfHeadersBackStack;
435                        if (index >= 0) {
436                            BackStackEntry entry = getFragmentManager().getBackStackEntryAt(index);
437                            getFragmentManager().popBackStackImmediate(entry.getId(),
438                                    FragmentManager.POP_BACK_STACK_INCLUSIVE);
439                        }
440                    }
441                }
442            }
443        });
444    }
445
446    private boolean isVerticalScrolling() {
447        // don't run transition
448        return mHeadersFragment.getVerticalGridView().getScrollState()
449                != HorizontalGridView.SCROLL_STATE_IDLE
450                || mRowsFragment.getVerticalGridView().getScrollState()
451                != HorizontalGridView.SCROLL_STATE_IDLE;
452    }
453
454
455    private final BrowseFrameLayout.OnFocusSearchListener mOnFocusSearchListener =
456            new BrowseFrameLayout.OnFocusSearchListener() {
457        @Override
458        public View onFocusSearch(View focused, int direction) {
459            // if headers is running transition,  focus stays
460            if (mCanShowHeaders && isInHeadersTransition()) {
461                return focused;
462            }
463            if (DEBUG) Log.v(TAG, "onFocusSearch focused " + focused + " + direction " + direction);
464
465            if (getTitleView() != null && focused != getTitleView() &&
466                    direction == View.FOCUS_UP) {
467                return getTitleView();
468            }
469            if (getTitleView() != null && getTitleView().hasFocus() &&
470                    direction == View.FOCUS_DOWN) {
471                return mCanShowHeaders && mShowingHeaders ?
472                        mHeadersFragment.getVerticalGridView() :
473                        mRowsFragment.getVerticalGridView();
474            }
475
476            boolean isRtl = ViewCompat.getLayoutDirection(focused) == View.LAYOUT_DIRECTION_RTL;
477            int towardStart = isRtl ? View.FOCUS_RIGHT : View.FOCUS_LEFT;
478            int towardEnd = isRtl ? View.FOCUS_LEFT : View.FOCUS_RIGHT;
479            if (mCanShowHeaders && direction == towardStart) {
480                if (isVerticalScrolling() || mShowingHeaders) {
481                    return focused;
482                }
483                return mHeadersFragment.getVerticalGridView();
484            } else if (direction == towardEnd) {
485                if (isVerticalScrolling()) {
486                    return focused;
487                }
488                return mRowsFragment.getVerticalGridView();
489            } else {
490                return null;
491            }
492        }
493    };
494
495    private final BrowseFrameLayout.OnChildFocusListener mOnChildFocusListener =
496            new BrowseFrameLayout.OnChildFocusListener() {
497
498        @Override
499        public boolean onRequestFocusInDescendants(int direction, Rect previouslyFocusedRect) {
500            if (getChildFragmentManager().isDestroyed()) {
501                return true;
502            }
503            // Make sure not changing focus when requestFocus() is called.
504            if (mCanShowHeaders && mShowingHeaders) {
505                if (mHeadersFragment != null && mHeadersFragment.getView() != null &&
506                        mHeadersFragment.getView().requestFocus(direction, previouslyFocusedRect)) {
507                    return true;
508                }
509            }
510            if (mRowsFragment != null && mRowsFragment.getView() != null &&
511                    mRowsFragment.getView().requestFocus(direction, previouslyFocusedRect)) {
512                return true;
513            }
514            if (getTitleView() != null &&
515                    getTitleView().requestFocus(direction, previouslyFocusedRect)) {
516                return true;
517            }
518            return false;
519        };
520
521        @Override
522        public void onRequestChildFocus(View child, View focused) {
523            if (getChildFragmentManager().isDestroyed()) {
524                return;
525            }
526            if (!mCanShowHeaders || isInHeadersTransition()) return;
527            int childId = child.getId();
528            if (childId == R.id.browse_container_dock && mShowingHeaders) {
529                startHeadersTransitionInternal(false);
530            } else if (childId == R.id.browse_headers_dock && !mShowingHeaders) {
531                startHeadersTransitionInternal(true);
532            }
533        }
534    };
535
536    @Override
537    public void onSaveInstanceState(Bundle outState) {
538        super.onSaveInstanceState(outState);
539        if (mBackStackChangedListener != null) {
540            mBackStackChangedListener.save(outState);
541        } else {
542            outState.putBoolean(HEADER_SHOW, mShowingHeaders);
543        }
544    }
545
546    @Override
547    public void onCreate(Bundle savedInstanceState) {
548        super.onCreate(savedInstanceState);
549        TypedArray ta = getActivity().obtainStyledAttributes(R.styleable.LeanbackTheme);
550        mContainerListMarginStart = (int) ta.getDimension(
551                R.styleable.LeanbackTheme_browseRowsMarginStart, getActivity().getResources()
552                .getDimensionPixelSize(R.dimen.lb_browse_rows_margin_start));
553        mContainerListAlignTop = (int) ta.getDimension(
554                R.styleable.LeanbackTheme_browseRowsMarginTop, getActivity().getResources()
555                .getDimensionPixelSize(R.dimen.lb_browse_rows_margin_top));
556        ta.recycle();
557
558        readArguments(getArguments());
559
560        if (mCanShowHeaders) {
561            if (mHeadersBackStackEnabled) {
562                mWithHeadersBackStackName = LB_HEADERS_BACKSTACK + this;
563                mBackStackChangedListener = new BackStackListener();
564                getFragmentManager().addOnBackStackChangedListener(mBackStackChangedListener);
565                mBackStackChangedListener.load(savedInstanceState);
566            } else {
567                if (savedInstanceState != null) {
568                    mShowingHeaders = savedInstanceState.getBoolean(HEADER_SHOW);
569                }
570            }
571        }
572    }
573
574    @Override
575    public void onDestroy() {
576        if (mBackStackChangedListener != null) {
577            getFragmentManager().removeOnBackStackChangedListener(mBackStackChangedListener);
578        }
579        super.onDestroy();
580    }
581
582    @Override
583    public View onCreateView(LayoutInflater inflater, ViewGroup container,
584            Bundle savedInstanceState) {
585        if (getChildFragmentManager().findFragmentById(R.id.browse_container_dock) == null) {
586            mRowsFragment = new RowsFragment();
587            mHeadersFragment = new HeadersFragment();
588            getChildFragmentManager().beginTransaction()
589                    .replace(R.id.browse_headers_dock, mHeadersFragment)
590                    .replace(R.id.browse_container_dock, mRowsFragment).commit();
591        } else {
592            mHeadersFragment = (HeadersFragment) getChildFragmentManager()
593                    .findFragmentById(R.id.browse_headers_dock);
594            mRowsFragment = (RowsFragment) getChildFragmentManager()
595                    .findFragmentById(R.id.browse_container_dock);
596        }
597
598        mHeadersFragment.setHeadersGone(!mCanShowHeaders);
599
600        mRowsFragment.setAdapter(mAdapter);
601        if (mHeaderPresenterSelector != null) {
602            mHeadersFragment.setPresenterSelector(mHeaderPresenterSelector);
603        }
604        mHeadersFragment.setAdapter(mAdapter);
605
606        mRowsFragment.enableRowScaling(mRowScaleEnabled);
607        mRowsFragment.setOnItemViewSelectedListener(mRowViewSelectedListener);
608        mHeadersFragment.setOnHeaderViewSelectedListener(mHeaderViewSelectedListener);
609        mHeadersFragment.setOnHeaderClickedListener(mHeaderClickedListener);
610        mRowsFragment.setOnItemViewClickedListener(mOnItemViewClickedListener);
611
612        View root = inflater.inflate(R.layout.lb_browse_fragment, container, false);
613
614        setTitleView((TitleView) root.findViewById(R.id.browse_title_group));
615
616        mBrowseFrame = (BrowseFrameLayout) root.findViewById(R.id.browse_frame);
617        mBrowseFrame.setOnChildFocusListener(mOnChildFocusListener);
618        mBrowseFrame.setOnFocusSearchListener(mOnFocusSearchListener);
619
620        if (mBrandColorSet) {
621            mHeadersFragment.setBackgroundColor(mBrandColor);
622        }
623
624        mSceneWithHeaders = sTransitionHelper.createScene(mBrowseFrame, new Runnable() {
625            @Override
626            public void run() {
627                showHeaders(true);
628            }
629        });
630        mSceneWithoutHeaders =  sTransitionHelper.createScene(mBrowseFrame, new Runnable() {
631            @Override
632            public void run() {
633                showHeaders(false);
634            }
635        });
636        mSceneAfterEntranceTransition = sTransitionHelper.createScene(mBrowseFrame, new Runnable() {
637            @Override
638            public void run() {
639                setEntranceTransitionEndState();
640            }
641        });
642        return root;
643    }
644
645    private void createHeadersTransition() {
646        mHeadersTransition = sTransitionHelper.loadTransition(getActivity(),
647                mShowingHeaders ?
648                R.transition.lb_browse_headers_in : R.transition.lb_browse_headers_out);
649
650        sTransitionHelper.setTransitionListener(mHeadersTransition, new TransitionListener() {
651            @Override
652            public void onTransitionStart(Object transition) {
653            }
654            @Override
655            public void onTransitionEnd(Object transition) {
656                mHeadersTransition = null;
657                mRowsFragment.onTransitionEnd();
658                mHeadersFragment.onTransitionEnd();
659                if (mShowingHeaders) {
660                    VerticalGridView headerGridView = mHeadersFragment.getVerticalGridView();
661                    if (headerGridView != null && !headerGridView.hasFocus()) {
662                        headerGridView.requestFocus();
663                    }
664                } else {
665                    VerticalGridView rowsGridView = mRowsFragment.getVerticalGridView();
666                    if (rowsGridView != null && !rowsGridView.hasFocus()) {
667                        rowsGridView.requestFocus();
668                    }
669                }
670                if (mBrowseTransitionListener != null) {
671                    mBrowseTransitionListener.onHeadersTransitionStop(mShowingHeaders);
672                }
673            }
674        });
675    }
676
677    /**
678     * Sets the {@link PresenterSelector} used to render the row headers.
679     *
680     * @param headerPresenterSelector The PresenterSelector that will determine
681     *        the Presenter for each row header.
682     */
683    public void setHeaderPresenterSelector(PresenterSelector headerPresenterSelector) {
684        mHeaderPresenterSelector = headerPresenterSelector;
685        if (mHeadersFragment != null) {
686            mHeadersFragment.setPresenterSelector(mHeaderPresenterSelector);
687        }
688    }
689
690    private void setRowsAlignedLeft(boolean alignLeft) {
691        MarginLayoutParams lp;
692        View containerList;
693        containerList = mRowsFragment.getView();
694        lp = (MarginLayoutParams) containerList.getLayoutParams();
695        lp.setMarginStart(alignLeft ? 0 : mContainerListMarginStart);
696        containerList.setLayoutParams(lp);
697    }
698
699    private void setHeadersOnScreen(boolean onScreen) {
700        MarginLayoutParams lp;
701        View containerList;
702        containerList = mHeadersFragment.getView();
703        lp = (MarginLayoutParams) containerList.getLayoutParams();
704        lp.setMarginStart(onScreen ? 0 : -mContainerListMarginStart);
705        containerList.setLayoutParams(lp);
706    }
707
708    private void showHeaders(boolean show) {
709        if (DEBUG) Log.v(TAG, "showHeaders " + show);
710        mHeadersFragment.setHeadersEnabled(show);
711        setHeadersOnScreen(show);
712        setRowsAlignedLeft(!show);
713        mRowsFragment.setExpand(!show);
714    }
715
716    private HeadersFragment.OnHeaderClickedListener mHeaderClickedListener =
717        new HeadersFragment.OnHeaderClickedListener() {
718            @Override
719            public void onHeaderClicked() {
720                if (!mCanShowHeaders || !mShowingHeaders || isInHeadersTransition()) {
721                    return;
722                }
723                startHeadersTransitionInternal(false);
724                mRowsFragment.getVerticalGridView().requestFocus();
725            }
726        };
727
728    private OnItemViewSelectedListener mRowViewSelectedListener = new OnItemViewSelectedListener() {
729        @Override
730        public void onItemSelected(Presenter.ViewHolder itemViewHolder, Object item,
731                RowPresenter.ViewHolder rowViewHolder, Row row) {
732            int position = mRowsFragment.getVerticalGridView().getSelectedPosition();
733            if (DEBUG) Log.v(TAG, "row selected position " + position);
734            onRowSelected(position);
735            if (mExternalOnItemViewSelectedListener != null) {
736                mExternalOnItemViewSelectedListener.onItemSelected(itemViewHolder, item,
737                        rowViewHolder, row);
738            }
739        }
740    };
741
742    private HeadersFragment.OnHeaderViewSelectedListener mHeaderViewSelectedListener =
743            new HeadersFragment.OnHeaderViewSelectedListener() {
744        @Override
745        public void onHeaderSelected(RowHeaderPresenter.ViewHolder viewHolder, Row row) {
746            int position = mHeadersFragment.getVerticalGridView().getSelectedPosition();
747            if (DEBUG) Log.v(TAG, "header selected position " + position);
748            onRowSelected(position);
749        }
750    };
751
752    private void onRowSelected(int position) {
753        if (position != mSelectedPosition) {
754            mSetSelectionRunnable.post(
755                    position, SetSelectionRunnable.TYPE_INTERNAL_SYNC, true);
756
757            if (getAdapter() == null || getAdapter().size() == 0 || position == 0) {
758                showTitle(true);
759            } else {
760                showTitle(false);
761            }
762        }
763    }
764
765    private void setSelection(int position, boolean smooth) {
766        if (position != NO_POSITION) {
767            mRowsFragment.setSelectedPosition(position, smooth);
768            mHeadersFragment.setSelectedPosition(position, smooth);
769        }
770        mSelectedPosition = position;
771    }
772
773    /**
774     * Sets the selected row position with smooth animation.
775     */
776    public void setSelectedPosition(int position) {
777        setSelectedPosition(position, true);
778    }
779
780    /**
781     * Sets the selected row position.
782     */
783    public void setSelectedPosition(int position, boolean smooth) {
784        mSetSelectionRunnable.post(
785                position, SetSelectionRunnable.TYPE_USER_REQUEST, smooth);
786    }
787
788    @Override
789    public void onStart() {
790        super.onStart();
791        mHeadersFragment.setWindowAlignmentFromTop(mContainerListAlignTop);
792        mHeadersFragment.setItemAlignment();
793        mRowsFragment.setWindowAlignmentFromTop(mContainerListAlignTop);
794        mRowsFragment.setItemAlignment();
795
796        mRowsFragment.setScalePivots(0, mContainerListAlignTop);
797
798        if (mCanShowHeaders && mShowingHeaders && mHeadersFragment.getView() != null) {
799            mHeadersFragment.getView().requestFocus();
800        } else if ((!mCanShowHeaders || !mShowingHeaders)
801                && mRowsFragment.getView() != null) {
802            mRowsFragment.getView().requestFocus();
803        }
804        if (mCanShowHeaders) {
805            showHeaders(mShowingHeaders);
806        }
807        if (isEntranceTransitionEnabled()) {
808            setEntranceTransitionStartState();
809        }
810    }
811
812    /**
813     * Enables/disables headers transition on back key support. This is enabled by
814     * default. The BrowseFragment will add a back stack entry when headers are
815     * showing. Running a headers transition when the back key is pressed only
816     * works when the headers state is {@link #HEADERS_ENABLED} or
817     * {@link #HEADERS_HIDDEN}.
818     * <p>
819     * NOTE: If an Activity has its own onBackPressed() handling, you must
820     * disable this feature. You may use {@link #startHeadersTransition(boolean)}
821     * and {@link BrowseTransitionListener} in your own back stack handling.
822     */
823    public final void setHeadersTransitionOnBackEnabled(boolean headersBackStackEnabled) {
824        mHeadersBackStackEnabled = headersBackStackEnabled;
825    }
826
827    /**
828     * Returns true if headers transition on back key support is enabled.
829     */
830    public final boolean isHeadersTransitionOnBackEnabled() {
831        return mHeadersBackStackEnabled;
832    }
833
834    private void readArguments(Bundle args) {
835        if (args == null) {
836            return;
837        }
838        if (args.containsKey(ARG_TITLE)) {
839            setTitle(args.getString(ARG_TITLE));
840        }
841        if (args.containsKey(ARG_HEADERS_STATE)) {
842            setHeadersState(args.getInt(ARG_HEADERS_STATE));
843        }
844    }
845
846    /**
847     * Sets the state for the headers column in the browse fragment. Must be one
848     * of {@link #HEADERS_ENABLED}, {@link #HEADERS_HIDDEN}, or
849     * {@link #HEADERS_DISABLED}.
850     *
851     * @param headersState The state of the headers for the browse fragment.
852     */
853    public void setHeadersState(int headersState) {
854        if (headersState < HEADERS_ENABLED || headersState > HEADERS_DISABLED) {
855            throw new IllegalArgumentException("Invalid headers state: " + headersState);
856        }
857        if (DEBUG) Log.v(TAG, "setHeadersState " + headersState);
858
859        if (headersState != mHeadersState) {
860            mHeadersState = headersState;
861            switch (headersState) {
862                case HEADERS_ENABLED:
863                    mCanShowHeaders = true;
864                    mShowingHeaders = true;
865                    break;
866                case HEADERS_HIDDEN:
867                    mCanShowHeaders = true;
868                    mShowingHeaders = false;
869                    break;
870                case HEADERS_DISABLED:
871                    mCanShowHeaders = false;
872                    mShowingHeaders = false;
873                    break;
874                default:
875                    Log.w(TAG, "Unknown headers state: " + headersState);
876                    break;
877            }
878            if (mHeadersFragment != null) {
879                mHeadersFragment.setHeadersGone(!mCanShowHeaders);
880            }
881        }
882    }
883
884    /**
885     * Returns the state of the headers column in the browse fragment.
886     */
887    public int getHeadersState() {
888        return mHeadersState;
889    }
890
891    @Override
892    protected Object createEntranceTransition() {
893        return sTransitionHelper.loadTransition(getActivity(),
894                R.transition.lb_browse_entrance_transition);
895    }
896
897    @Override
898    protected void runEntranceTransition(Object entranceTransition) {
899        sTransitionHelper.runTransition(mSceneAfterEntranceTransition,
900                entranceTransition);
901    }
902
903    @Override
904    protected void onEntranceTransitionStart() {
905        mHeadersFragment.onTransitionStart();
906        mRowsFragment.onTransitionStart();
907    }
908
909    @Override
910    protected void onEntranceTransitionEnd() {
911        mRowsFragment.onTransitionEnd();
912        mHeadersFragment.onTransitionEnd();
913    }
914
915    void setSearchOrbViewOnScreen(boolean onScreen) {
916        View searchOrbView = getTitleView().getSearchAffordanceView();
917        MarginLayoutParams lp = (MarginLayoutParams) searchOrbView.getLayoutParams();
918        lp.setMarginStart(onScreen ? 0 : -mContainerListMarginStart);
919        searchOrbView.setLayoutParams(lp);
920    }
921
922    void setEntranceTransitionStartState() {
923        setHeadersOnScreen(false);
924        setSearchOrbViewOnScreen(false);
925        mRowsFragment.setEntranceTransitionState(false);
926    }
927
928    void setEntranceTransitionEndState() {
929        setHeadersOnScreen(mShowingHeaders);
930        setSearchOrbViewOnScreen(true);
931        mRowsFragment.setEntranceTransitionState(true);
932    }
933
934}
935
936