ListView.java revision b45f124a041adf81b3ac8b8dec6b396e751e92d7
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.widget;
18
19import android.content.Context;
20import android.content.res.TypedArray;
21import android.graphics.Canvas;
22import android.graphics.Rect;
23import android.graphics.drawable.Drawable;
24import android.graphics.drawable.ColorDrawable;
25import android.os.Parcel;
26import android.os.Parcelable;
27import android.util.AttributeSet;
28import android.util.SparseBooleanArray;
29import android.view.FocusFinder;
30import android.view.KeyEvent;
31import android.view.MotionEvent;
32import android.view.View;
33import android.view.ViewDebug;
34import android.view.ViewGroup;
35import android.view.ViewParent;
36import android.view.SoundEffectConstants;
37
38import com.google.android.collect.Lists;
39import com.android.internal.R;
40
41import java.util.ArrayList;
42
43/*
44 * Implementation Notes:
45 *
46 * Some terminology:
47 *
48 *     index    - index of the items that are currently visible
49 *     position - index of the items in the cursor
50 */
51
52
53/**
54 * A view that shows items in a vertically scrolling list. The items
55 * come from the {@link ListAdapter} associated with this view.
56 *
57 * @attr ref android.R.styleable#ListView_entries
58 * @attr ref android.R.styleable#ListView_divider
59 * @attr ref android.R.styleable#ListView_dividerHeight
60 * @attr ref android.R.styleable#ListView_choiceMode
61 * @attr ref android.R.styleable#ListView_headerDividersEnabled
62 * @attr ref android.R.styleable#ListView_footerDividersEnabled
63 */
64public class ListView extends AbsListView {
65    /**
66     * Used to indicate a no preference for a position type.
67     */
68    static final int NO_POSITION = -1;
69
70    /**
71     * Normal list that does not indicate choices
72     */
73    public static final int CHOICE_MODE_NONE = 0;
74
75    /**
76     * The list allows up to one choice
77     */
78    public static final int CHOICE_MODE_SINGLE = 1;
79
80    /**
81     * The list allows multiple choices
82     */
83    public static final int CHOICE_MODE_MULTIPLE = 2;
84
85    /**
86     * When arrow scrolling, ListView will never scroll more than this factor
87     * times the height of the list.
88     */
89    private static final float MAX_SCROLL_FACTOR = 0.33f;
90
91    /**
92     * When arrow scrolling, need a certain amount of pixels to preview next
93     * items.  This is usually the fading edge, but if that is small enough,
94     * we want to make sure we preview at least this many pixels.
95     */
96    private static final int MIN_SCROLL_PREVIEW_PIXELS = 2;
97
98    /**
99     * A class that represents a fixed view in a list, for example a header at the top
100     * or a footer at the bottom.
101     */
102    public class FixedViewInfo {
103        /** The view to add to the list */
104        public View view;
105        /** The data backing the view. This is returned from {@link ListAdapter#getItem(int)}. */
106        public Object data;
107        /** <code>true</code> if the fixed view should be selectable in the list */
108        public boolean isSelectable;
109    }
110
111    private ArrayList<FixedViewInfo> mHeaderViewInfos = Lists.newArrayList();
112    private ArrayList<FixedViewInfo> mFooterViewInfos = Lists.newArrayList();
113
114    Drawable mDivider;
115    int mDividerHeight;
116    private boolean mClipDivider;
117    private boolean mHeaderDividersEnabled;
118    private boolean mFooterDividersEnabled;
119
120    private boolean mAreAllItemsSelectable = true;
121
122    private boolean mItemsCanFocus = false;
123
124    private int mChoiceMode = CHOICE_MODE_NONE;
125
126    private SparseBooleanArray mCheckStates;
127
128    // used for temporary calculations.
129    private final Rect mTempRect = new Rect();
130
131    // the single allocated result per list view; kinda cheesey but avoids
132    // allocating these thingies too often.
133    private ArrowScrollFocusResult mArrowScrollFocusResult = new ArrowScrollFocusResult();
134
135    public ListView(Context context) {
136        this(context, null);
137    }
138
139    public ListView(Context context, AttributeSet attrs) {
140        this(context, attrs, com.android.internal.R.attr.listViewStyle);
141    }
142
143    public ListView(Context context, AttributeSet attrs, int defStyle) {
144        super(context, attrs, defStyle);
145
146        TypedArray a = context.obtainStyledAttributes(attrs,
147                com.android.internal.R.styleable.ListView, defStyle, 0);
148
149        CharSequence[] entries = a.getTextArray(
150                com.android.internal.R.styleable.ListView_entries);
151        if (entries != null) {
152            setAdapter(new ArrayAdapter<CharSequence>(context,
153                    com.android.internal.R.layout.simple_list_item_1, entries));
154        }
155
156        final Drawable d = a.getDrawable(com.android.internal.R.styleable.ListView_divider);
157        if (d != null) {
158            // If a divider is specified use its intrinsic height for divider height
159            setDivider(d);
160        }
161
162        // Use the height specified, zero being the default
163        final int dividerHeight = a.getDimensionPixelSize(
164                com.android.internal.R.styleable.ListView_dividerHeight, 0);
165        if (dividerHeight != 0) {
166            setDividerHeight(dividerHeight);
167        }
168
169        mHeaderDividersEnabled = a.getBoolean(R.styleable.ListView_headerDividersEnabled, true);
170        mFooterDividersEnabled = a.getBoolean(R.styleable.ListView_footerDividersEnabled, true);
171
172        a.recycle();
173    }
174
175    /**
176     * @return The maximum amount a list view will scroll in response to
177     *   an arrow event.
178     */
179    public int getMaxScrollAmount() {
180        return (int) (MAX_SCROLL_FACTOR * (mBottom - mTop));
181    }
182
183    /**
184     * Make sure views are touching the top or bottom edge, as appropriate for
185     * our gravity
186     */
187    private void adjustViewsUpOrDown() {
188        final int childCount = getChildCount();
189        int delta;
190
191        if (childCount > 0) {
192            View child;
193
194            if (!mStackFromBottom) {
195                // Uh-oh -- we came up short. Slide all views up to make them
196                // align with the top
197                child = getChildAt(0);
198                delta = child.getTop() - mListPadding.top;
199                if (mFirstPosition != 0) {
200                    // It's OK to have some space above the first item if it is
201                    // part of the vertical spacing
202                    delta -= mDividerHeight;
203                }
204                if (delta < 0) {
205                    // We only are looking to see if we are too low, not too high
206                    delta = 0;
207                }
208            } else {
209                // we are too high, slide all views down to align with bottom
210                child = getChildAt(childCount - 1);
211                delta = child.getBottom() - (getHeight() - mListPadding.bottom);
212
213                if (mFirstPosition + childCount < mItemCount) {
214                    // It's OK to have some space below the last item if it is
215                    // part of the vertical spacing
216                    delta += mDividerHeight;
217                }
218
219                if (delta > 0) {
220                    delta = 0;
221                }
222            }
223
224            if (delta != 0) {
225                offsetChildrenTopAndBottom(-delta);
226            }
227        }
228    }
229
230    /**
231     * Add a fixed view to appear at the top of the list. If addHeaderView is
232     * called more than once, the views will appear in the order they were
233     * added. Views added using this call can take focus if they want.
234     * <p>
235     * NOTE: Call this before calling setAdapter. This is so ListView can wrap
236     * the supplied cursor with one that that will also account for header
237     * views.
238     *
239     * @param v The view to add.
240     * @param data Data to associate with this view
241     * @param isSelectable whether the item is selectable
242     */
243    public void addHeaderView(View v, Object data, boolean isSelectable) {
244
245        if (mAdapter != null) {
246            throw new IllegalStateException(
247                    "Cannot add header view to list -- setAdapter has already been called.");
248        }
249
250        FixedViewInfo info = new FixedViewInfo();
251        info.view = v;
252        info.data = data;
253        info.isSelectable = isSelectable;
254        mHeaderViewInfos.add(info);
255    }
256
257    /**
258     * Add a fixed view to appear at the top of the list. If addHeaderView is
259     * called more than once, the views will appear in the order they were
260     * added. Views added using this call can take focus if they want.
261     * <p>
262     * NOTE: Call this before calling setAdapter. This is so ListView can wrap
263     * the supplied cursor with one that that will also account for header
264     * views.
265     *
266     * @param v The view to add.
267     */
268    public void addHeaderView(View v) {
269        addHeaderView(v, null, true);
270    }
271
272    @Override
273    public int getHeaderViewsCount() {
274        return mHeaderViewInfos.size();
275    }
276
277    /**
278     * Removes a previously-added header view.
279     *
280     * @param v The view to remove
281     * @return true if the view was removed, false if the view was not a header
282     *         view
283     */
284    public boolean removeHeaderView(View v) {
285        if (mHeaderViewInfos.size() > 0) {
286            boolean result = false;
287            if (((HeaderViewListAdapter) mAdapter).removeHeader(v)) {
288                mDataSetObserver.onChanged();
289                result = true;
290            }
291            removeFixedViewInfo(v, mHeaderViewInfos);
292            return result;
293        }
294        return false;
295    }
296
297    private void removeFixedViewInfo(View v, ArrayList<FixedViewInfo> where) {
298        int len = where.size();
299        for (int i = 0; i < len; ++i) {
300            FixedViewInfo info = where.get(i);
301            if (info.view == v) {
302                where.remove(i);
303                break;
304            }
305        }
306    }
307
308    /**
309     * Add a fixed view to appear at the bottom of the list. If addFooterView is
310     * called more than once, the views will appear in the order they were
311     * added. Views added using this call can take focus if they want.
312     * <p>
313     * NOTE: Call this before calling setAdapter. This is so ListView can wrap
314     * the supplied cursor with one that that will also account for header
315     * views.
316     *
317     * @param v The view to add.
318     * @param data Data to associate with this view
319     * @param isSelectable true if the footer view can be selected
320     */
321    public void addFooterView(View v, Object data, boolean isSelectable) {
322        FixedViewInfo info = new FixedViewInfo();
323        info.view = v;
324        info.data = data;
325        info.isSelectable = isSelectable;
326        mFooterViewInfos.add(info);
327
328        // in the case of re-adding a footer view, or adding one later on,
329        // we need to notify the observer
330        if (mDataSetObserver != null) {
331            mDataSetObserver.onChanged();
332        }
333    }
334
335    /**
336     * Add a fixed view to appear at the bottom of the list. If addFooterView is called more
337     * than once, the views will appear in the order they were added. Views added using
338     * this call can take focus if they want.
339     * <p>NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied
340     * cursor with one that that will also account for header views.
341     *
342     *
343     * @param v The view to add.
344     */
345    public void addFooterView(View v) {
346        addFooterView(v, null, true);
347    }
348
349    @Override
350    public int getFooterViewsCount() {
351        return mFooterViewInfos.size();
352    }
353
354    /**
355     * Removes a previously-added footer view.
356     *
357     * @param v The view to remove
358     * @return
359     * true if the view was removed, false if the view was not a footer view
360     */
361    public boolean removeFooterView(View v) {
362        if (mFooterViewInfos.size() > 0) {
363            boolean result = false;
364            if (((HeaderViewListAdapter) mAdapter).removeFooter(v)) {
365                mDataSetObserver.onChanged();
366                result = true;
367            }
368            removeFixedViewInfo(v, mFooterViewInfos);
369            return result;
370        }
371        return false;
372    }
373
374    /**
375     * Returns the adapter currently in use in this ListView. The returned adapter
376     * might not be the same adapter passed to {@link #setAdapter(ListAdapter)} but
377     * might be a {@link WrapperListAdapter}.
378     *
379     * @return The adapter currently used to display data in this ListView.
380     *
381     * @see #setAdapter(ListAdapter)
382     */
383    @Override
384    public ListAdapter getAdapter() {
385        return mAdapter;
386    }
387
388    /**
389     * Sets the data behind this ListView.
390     *
391     * The adapter passed to this method may be wrapped by a {@link WrapperListAdapter},
392     * depending on the ListView features currently in use. For instance, adding
393     * headers and/or footers will cause the adapter to be wrapped.
394     *
395     * @param adapter The ListAdapter which is responsible for maintaining the
396     *        data backing this list and for producing a view to represent an
397     *        item in that data set.
398     *
399     * @see #getAdapter()
400     */
401    @Override
402    public void setAdapter(ListAdapter adapter) {
403        if (null != mAdapter) {
404            mAdapter.unregisterDataSetObserver(mDataSetObserver);
405        }
406
407        resetList();
408        mRecycler.clear();
409
410        if (mHeaderViewInfos.size() > 0|| mFooterViewInfos.size() > 0) {
411            mAdapter = new HeaderViewListAdapter(mHeaderViewInfos, mFooterViewInfos, adapter);
412        } else {
413            mAdapter = adapter;
414        }
415
416        mOldSelectedPosition = INVALID_POSITION;
417        mOldSelectedRowId = INVALID_ROW_ID;
418        if (mAdapter != null) {
419            mAreAllItemsSelectable = mAdapter.areAllItemsEnabled();
420            mOldItemCount = mItemCount;
421            mItemCount = mAdapter.getCount();
422            checkFocus();
423
424            mDataSetObserver = new AdapterDataSetObserver();
425            mAdapter.registerDataSetObserver(mDataSetObserver);
426
427            mRecycler.setViewTypeCount(mAdapter.getViewTypeCount());
428
429            int position;
430            if (mStackFromBottom) {
431                position = lookForSelectablePosition(mItemCount - 1, false);
432            } else {
433                position = lookForSelectablePosition(0, true);
434            }
435            setSelectedPositionInt(position);
436            setNextSelectedPositionInt(position);
437
438            if (mItemCount == 0) {
439                // Nothing selected
440                checkSelectionChanged();
441            }
442
443        } else {
444            mAreAllItemsSelectable = true;
445            checkFocus();
446            // Nothing selected
447            checkSelectionChanged();
448        }
449
450        if (mCheckStates != null) {
451            mCheckStates.clear();
452        }
453
454        requestLayout();
455    }
456
457
458    /**
459     * The list is empty. Clear everything out.
460     */
461    @Override
462    void resetList() {
463        super.resetList();
464        mLayoutMode = LAYOUT_NORMAL;
465    }
466
467    /**
468     * @return Whether the list needs to show the top fading edge
469     */
470    private boolean showingTopFadingEdge() {
471        final int listTop = mScrollY + mListPadding.top;
472        return (mFirstPosition > 0) || (getChildAt(0).getTop() > listTop);
473    }
474
475    /**
476     * @return Whether the list needs to show the bottom fading edge
477     */
478    private boolean showingBottomFadingEdge() {
479        final int childCount = getChildCount();
480        final int bottomOfBottomChild = getChildAt(childCount - 1).getBottom();
481        final int lastVisiblePosition = mFirstPosition + childCount - 1;
482
483        final int listBottom = mScrollY + getHeight() - mListPadding.bottom;
484
485        return (lastVisiblePosition < mItemCount - 1)
486                         || (bottomOfBottomChild < listBottom);
487    }
488
489
490    @Override
491    public boolean requestChildRectangleOnScreen(View child, Rect rect, boolean immediate) {
492
493        int rectTopWithinChild = rect.top;
494
495        // offset so rect is in coordinates of the this view
496        rect.offset(child.getLeft(), child.getTop());
497        rect.offset(-child.getScrollX(), -child.getScrollY());
498
499        final int height = getHeight();
500        int listUnfadedTop = getScrollY();
501        int listUnfadedBottom = listUnfadedTop + height;
502        final int fadingEdge = getVerticalFadingEdgeLength();
503
504        if (showingTopFadingEdge()) {
505            // leave room for top fading edge as long as rect isn't at very top
506            if ((mSelectedPosition > 0) || (rectTopWithinChild > fadingEdge)) {
507                listUnfadedTop += fadingEdge;
508            }
509        }
510
511        int childCount = getChildCount();
512        int bottomOfBottomChild = getChildAt(childCount - 1).getBottom();
513
514        if (showingBottomFadingEdge()) {
515            // leave room for bottom fading edge as long as rect isn't at very bottom
516            if ((mSelectedPosition < mItemCount - 1)
517                    || (rect.bottom < (bottomOfBottomChild - fadingEdge))) {
518                listUnfadedBottom -= fadingEdge;
519            }
520        }
521
522        int scrollYDelta = 0;
523
524        if (rect.bottom > listUnfadedBottom && rect.top > listUnfadedTop) {
525            // need to MOVE DOWN to get it in view: move down just enough so
526            // that the entire rectangle is in view (or at least the first
527            // screen size chunk).
528
529            if (rect.height() > height) {
530                // just enough to get screen size chunk on
531                scrollYDelta += (rect.top - listUnfadedTop);
532            } else {
533                // get entire rect at bottom of screen
534                scrollYDelta += (rect.bottom - listUnfadedBottom);
535            }
536
537            // make sure we aren't scrolling beyond the end of our children
538            int distanceToBottom = bottomOfBottomChild - listUnfadedBottom;
539            scrollYDelta = Math.min(scrollYDelta, distanceToBottom);
540        } else if (rect.top < listUnfadedTop && rect.bottom < listUnfadedBottom) {
541            // need to MOVE UP to get it in view: move up just enough so that
542            // entire rectangle is in view (or at least the first screen
543            // size chunk of it).
544
545            if (rect.height() > height) {
546                // screen size chunk
547                scrollYDelta -= (listUnfadedBottom - rect.bottom);
548            } else {
549                // entire rect at top
550                scrollYDelta -= (listUnfadedTop - rect.top);
551            }
552
553            // make sure we aren't scrolling any further than the top our children
554            int top = getChildAt(0).getTop();
555            int deltaToTop = top - listUnfadedTop;
556            scrollYDelta = Math.max(scrollYDelta, deltaToTop);
557        }
558
559        final boolean scroll = scrollYDelta != 0;
560        if (scroll) {
561            scrollListItemsBy(-scrollYDelta);
562            positionSelector(child);
563            mSelectedTop = child.getTop();
564            invalidate();
565        }
566        return scroll;
567    }
568
569    /**
570     * {@inheritDoc}
571     */
572    @Override
573    void fillGap(boolean down) {
574        final int count = getChildCount();
575        if (down) {
576            final int startOffset = count > 0 ? getChildAt(count - 1).getBottom() + mDividerHeight :
577                    getListPaddingTop();
578            fillDown(mFirstPosition + count, startOffset);
579            correctTooHigh(getChildCount());
580        } else {
581            final int startOffset = count > 0 ? getChildAt(0).getTop() - mDividerHeight :
582                    getHeight() - getListPaddingBottom();
583            fillUp(mFirstPosition - 1, startOffset);
584            correctTooLow(getChildCount());
585        }
586    }
587
588    /**
589     * Fills the list from pos down to the end of the list view.
590     *
591     * @param pos The first position to put in the list
592     *
593     * @param nextTop The location where the top of the item associated with pos
594     *        should be drawn
595     *
596     * @return The view that is currently selected, if it happens to be in the
597     *         range that we draw.
598     */
599    private View fillDown(int pos, int nextTop) {
600        View selectedView = null;
601
602        int end = (mBottom - mTop) - mListPadding.bottom;
603
604        while (nextTop < end && pos < mItemCount) {
605            // is this the selected item?
606            boolean selected = pos == mSelectedPosition;
607            View child = makeAndAddView(pos, nextTop, true, mListPadding.left, selected);
608
609            nextTop = child.getBottom() + mDividerHeight;
610            if (selected) {
611                selectedView = child;
612            }
613            pos++;
614        }
615
616        return selectedView;
617    }
618
619    /**
620     * Fills the list from pos up to the top of the list view.
621     *
622     * @param pos The first position to put in the list
623     *
624     * @param nextBottom The location where the bottom of the item associated
625     *        with pos should be drawn
626     *
627     * @return The view that is currently selected
628     */
629    private View fillUp(int pos, int nextBottom) {
630        View selectedView = null;
631
632        int end = mListPadding.top;
633
634        while (nextBottom > end && pos >= 0) {
635            // is this the selected item?
636            boolean selected = pos == mSelectedPosition;
637            View child = makeAndAddView(pos, nextBottom, false, mListPadding.left, selected);
638            nextBottom = child.getTop() - mDividerHeight;
639            if (selected) {
640                selectedView = child;
641            }
642            pos--;
643        }
644
645        mFirstPosition = pos + 1;
646
647        return selectedView;
648    }
649
650    /**
651     * Fills the list from top to bottom, starting with mFirstPosition
652     *
653     * @param nextTop The location where the top of the first item should be
654     *        drawn
655     *
656     * @return The view that is currently selected
657     */
658    private View fillFromTop(int nextTop) {
659        mFirstPosition = Math.min(mFirstPosition, mSelectedPosition);
660        mFirstPosition = Math.min(mFirstPosition, mItemCount - 1);
661        if (mFirstPosition < 0) {
662            mFirstPosition = 0;
663        }
664        return fillDown(mFirstPosition, nextTop);
665    }
666
667
668    /**
669     * Put mSelectedPosition in the middle of the screen and then build up and
670     * down from there. This method forces mSelectedPosition to the center.
671     *
672     * @param childrenTop Top of the area in which children can be drawn, as
673     *        measured in pixels
674     * @param childrenBottom Bottom of the area in which children can be drawn,
675     *        as measured in pixels
676     * @return Currently selected view
677     */
678    private View fillFromMiddle(int childrenTop, int childrenBottom) {
679        int height = childrenBottom - childrenTop;
680
681        int position = reconcileSelectedPosition();
682
683        View sel = makeAndAddView(position, childrenTop, true,
684                mListPadding.left, true);
685        mFirstPosition = position;
686
687        int selHeight = sel.getMeasuredHeight();
688        if (selHeight <= height) {
689            sel.offsetTopAndBottom((height - selHeight) / 2);
690        }
691
692        fillAboveAndBelow(sel, position);
693
694        if (!mStackFromBottom) {
695            correctTooHigh(getChildCount());
696        } else {
697            correctTooLow(getChildCount());
698        }
699
700        return sel;
701    }
702
703    /**
704     * Once the selected view as been placed, fill up the visible area above and
705     * below it.
706     *
707     * @param sel The selected view
708     * @param position The position corresponding to sel
709     */
710    private void fillAboveAndBelow(View sel, int position) {
711        final int dividerHeight = mDividerHeight;
712        if (!mStackFromBottom) {
713            fillUp(position - 1, sel.getTop() - dividerHeight);
714            adjustViewsUpOrDown();
715            fillDown(position + 1, sel.getBottom() + dividerHeight);
716        } else {
717            fillDown(position + 1, sel.getBottom() + dividerHeight);
718            adjustViewsUpOrDown();
719            fillUp(position - 1, sel.getTop() - dividerHeight);
720        }
721    }
722
723
724    /**
725     * Fills the grid based on positioning the new selection at a specific
726     * location. The selection may be moved so that it does not intersect the
727     * faded edges. The grid is then filled upwards and downwards from there.
728     *
729     * @param selectedTop Where the selected item should be
730     * @param childrenTop Where to start drawing children
731     * @param childrenBottom Last pixel where children can be drawn
732     * @return The view that currently has selection
733     */
734    private View fillFromSelection(int selectedTop, int childrenTop, int childrenBottom) {
735        int fadingEdgeLength = getVerticalFadingEdgeLength();
736        final int selectedPosition = mSelectedPosition;
737
738        View sel;
739
740        final int topSelectionPixel = getTopSelectionPixel(childrenTop, fadingEdgeLength,
741                selectedPosition);
742        final int bottomSelectionPixel = getBottomSelectionPixel(childrenBottom, fadingEdgeLength,
743                selectedPosition);
744
745        sel = makeAndAddView(selectedPosition, selectedTop, true, mListPadding.left, true);
746
747
748        // Some of the newly selected item extends below the bottom of the list
749        if (sel.getBottom() > bottomSelectionPixel) {
750            // Find space available above the selection into which we can scroll
751            // upwards
752            final int spaceAbove = sel.getTop() - topSelectionPixel;
753
754            // Find space required to bring the bottom of the selected item
755            // fully into view
756            final int spaceBelow = sel.getBottom() - bottomSelectionPixel;
757            final int offset = Math.min(spaceAbove, spaceBelow);
758
759            // Now offset the selected item to get it into view
760            sel.offsetTopAndBottom(-offset);
761        } else if (sel.getTop() < topSelectionPixel) {
762            // Find space required to bring the top of the selected item fully
763            // into view
764            final int spaceAbove = topSelectionPixel - sel.getTop();
765
766            // Find space available below the selection into which we can scroll
767            // downwards
768            final int spaceBelow = bottomSelectionPixel - sel.getBottom();
769            final int offset = Math.min(spaceAbove, spaceBelow);
770
771            // Offset the selected item to get it into view
772            sel.offsetTopAndBottom(offset);
773        }
774
775        // Fill in views above and below
776        fillAboveAndBelow(sel, selectedPosition);
777
778        if (!mStackFromBottom) {
779            correctTooHigh(getChildCount());
780        } else {
781            correctTooLow(getChildCount());
782        }
783
784        return sel;
785    }
786
787    /**
788     * Calculate the bottom-most pixel we can draw the selection into
789     *
790     * @param childrenBottom Bottom pixel were children can be drawn
791     * @param fadingEdgeLength Length of the fading edge in pixels, if present
792     * @param selectedPosition The position that will be selected
793     * @return The bottom-most pixel we can draw the selection into
794     */
795    private int getBottomSelectionPixel(int childrenBottom, int fadingEdgeLength,
796            int selectedPosition) {
797        int bottomSelectionPixel = childrenBottom;
798        if (selectedPosition != mItemCount - 1) {
799            bottomSelectionPixel -= fadingEdgeLength;
800        }
801        return bottomSelectionPixel;
802    }
803
804    /**
805     * Calculate the top-most pixel we can draw the selection into
806     *
807     * @param childrenTop Top pixel were children can be drawn
808     * @param fadingEdgeLength Length of the fading edge in pixels, if present
809     * @param selectedPosition The position that will be selected
810     * @return The top-most pixel we can draw the selection into
811     */
812    private int getTopSelectionPixel(int childrenTop, int fadingEdgeLength, int selectedPosition) {
813        // first pixel we can draw the selection into
814        int topSelectionPixel = childrenTop;
815        if (selectedPosition > 0) {
816            topSelectionPixel += fadingEdgeLength;
817        }
818        return topSelectionPixel;
819    }
820
821
822    /**
823     * Fills the list based on positioning the new selection relative to the old
824     * selection. The new selection will be placed at, above, or below the
825     * location of the new selection depending on how the selection is moving.
826     * The selection will then be pinned to the visible part of the screen,
827     * excluding the edges that are faded. The list is then filled upwards and
828     * downwards from there.
829     *
830     * @param oldSel The old selected view. Useful for trying to put the new
831     *        selection in the same place
832     * @param newSel The view that is to become selected. Useful for trying to
833     *        put the new selection in the same place
834     * @param delta Which way we are moving
835     * @param childrenTop Where to start drawing children
836     * @param childrenBottom Last pixel where children can be drawn
837     * @return The view that currently has selection
838     */
839    private View moveSelection(View oldSel, View newSel, int delta, int childrenTop,
840            int childrenBottom) {
841        int fadingEdgeLength = getVerticalFadingEdgeLength();
842        final int selectedPosition = mSelectedPosition;
843
844        View sel;
845
846        final int topSelectionPixel = getTopSelectionPixel(childrenTop, fadingEdgeLength,
847                selectedPosition);
848        final int bottomSelectionPixel = getBottomSelectionPixel(childrenTop, fadingEdgeLength,
849                selectedPosition);
850
851        if (delta > 0) {
852            /*
853             * Case 1: Scrolling down.
854             */
855
856            /*
857             *     Before           After
858             *    |       |        |       |
859             *    +-------+        +-------+
860             *    |   A   |        |   A   |
861             *    |   1   |   =>   +-------+
862             *    +-------+        |   B   |
863             *    |   B   |        |   2   |
864             *    +-------+        +-------+
865             *    |       |        |       |
866             *
867             *    Try to keep the top of the previously selected item where it was.
868             *    oldSel = A
869             *    sel = B
870             */
871
872            // Put oldSel (A) where it belongs
873            oldSel = makeAndAddView(selectedPosition - 1, oldSel.getTop(), true,
874                    mListPadding.left, false);
875
876            final int dividerHeight = mDividerHeight;
877
878            // Now put the new selection (B) below that
879            sel = makeAndAddView(selectedPosition, oldSel.getBottom() + dividerHeight, true,
880                    mListPadding.left, true);
881
882            // Some of the newly selected item extends below the bottom of the list
883            if (sel.getBottom() > bottomSelectionPixel) {
884
885                // Find space available above the selection into which we can scroll upwards
886                int spaceAbove = sel.getTop() - topSelectionPixel;
887
888                // Find space required to bring the bottom of the selected item fully into view
889                int spaceBelow = sel.getBottom() - bottomSelectionPixel;
890
891                // Don't scroll more than half the height of the list
892                int halfVerticalSpace = (childrenBottom - childrenTop) / 2;
893                int offset = Math.min(spaceAbove, spaceBelow);
894                offset = Math.min(offset, halfVerticalSpace);
895
896                // We placed oldSel, so offset that item
897                oldSel.offsetTopAndBottom(-offset);
898                // Now offset the selected item to get it into view
899                sel.offsetTopAndBottom(-offset);
900            }
901
902            // Fill in views above and below
903            if (!mStackFromBottom) {
904                fillUp(mSelectedPosition - 2, sel.getTop() - dividerHeight);
905                adjustViewsUpOrDown();
906                fillDown(mSelectedPosition + 1, sel.getBottom() + dividerHeight);
907            } else {
908                fillDown(mSelectedPosition + 1, sel.getBottom() + dividerHeight);
909                adjustViewsUpOrDown();
910                fillUp(mSelectedPosition - 2, sel.getTop() - dividerHeight);
911            }
912        } else if (delta < 0) {
913            /*
914             * Case 2: Scrolling up.
915             */
916
917            /*
918             *     Before           After
919             *    |       |        |       |
920             *    +-------+        +-------+
921             *    |   A   |        |   A   |
922             *    +-------+   =>   |   1   |
923             *    |   B   |        +-------+
924             *    |   2   |        |   B   |
925             *    +-------+        +-------+
926             *    |       |        |       |
927             *
928             *    Try to keep the top of the item about to become selected where it was.
929             *    newSel = A
930             *    olSel = B
931             */
932
933            if (newSel != null) {
934                // Try to position the top of newSel (A) where it was before it was selected
935                sel = makeAndAddView(selectedPosition, newSel.getTop(), true, mListPadding.left,
936                        true);
937            } else {
938                // If (A) was not on screen and so did not have a view, position
939                // it above the oldSel (B)
940                sel = makeAndAddView(selectedPosition, oldSel.getTop(), false, mListPadding.left,
941                        true);
942            }
943
944            // Some of the newly selected item extends above the top of the list
945            if (sel.getTop() < topSelectionPixel) {
946                // Find space required to bring the top of the selected item fully into view
947                int spaceAbove = topSelectionPixel - sel.getTop();
948
949               // Find space available below the selection into which we can scroll downwards
950                int spaceBelow = bottomSelectionPixel - sel.getBottom();
951
952                // Don't scroll more than half the height of the list
953                int halfVerticalSpace = (childrenBottom - childrenTop) / 2;
954                int offset = Math.min(spaceAbove, spaceBelow);
955                offset = Math.min(offset, halfVerticalSpace);
956
957                // Offset the selected item to get it into view
958                sel.offsetTopAndBottom(offset);
959            }
960
961            // Fill in views above and below
962            fillAboveAndBelow(sel, selectedPosition);
963        } else {
964
965            int oldTop = oldSel.getTop();
966
967            /*
968             * Case 3: Staying still
969             */
970            sel = makeAndAddView(selectedPosition, oldTop, true, mListPadding.left, true);
971
972            // We're staying still...
973            if (oldTop < childrenTop) {
974                // ... but the top of the old selection was off screen.
975                // (This can happen if the data changes size out from under us)
976                int newBottom = sel.getBottom();
977                if (newBottom < childrenTop + 20) {
978                    // Not enough visible -- bring it onscreen
979                    sel.offsetTopAndBottom(childrenTop - sel.getTop());
980                }
981            }
982
983            // Fill in views above and below
984            fillAboveAndBelow(sel, selectedPosition);
985        }
986
987        return sel;
988    }
989
990    @Override
991    protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
992        // Sets up mListPadding
993        super.onMeasure(widthMeasureSpec, heightMeasureSpec);
994
995        int widthMode = MeasureSpec.getMode(widthMeasureSpec);
996        int heightMode = MeasureSpec.getMode(heightMeasureSpec);
997        int widthSize = MeasureSpec.getSize(widthMeasureSpec);
998        int heightSize = MeasureSpec.getSize(heightMeasureSpec);
999
1000        int childWidth = 0;
1001        int childHeight = 0;
1002
1003        mItemCount = mAdapter == null ? 0 : mAdapter.getCount();
1004        if (mItemCount > 0 && (widthMode == MeasureSpec.UNSPECIFIED ||
1005                heightMode == MeasureSpec.UNSPECIFIED)) {
1006            final View child = obtainView(0);
1007
1008            measureScrapChild(child, 0, widthMeasureSpec);
1009
1010            childWidth = child.getMeasuredWidth();
1011            childHeight = child.getMeasuredHeight();
1012
1013            if (recycleOnMeasure()) {
1014                mRecycler.addScrapView(child);
1015            }
1016        }
1017
1018        if (widthMode == MeasureSpec.UNSPECIFIED) {
1019            widthSize = mListPadding.left + mListPadding.right + childWidth +
1020                    getVerticalScrollbarWidth();
1021        }
1022
1023        if (heightMode == MeasureSpec.UNSPECIFIED) {
1024            heightSize = mListPadding.top + mListPadding.bottom + childHeight +
1025                    getVerticalFadingEdgeLength() * 2;
1026        }
1027
1028        if (heightMode == MeasureSpec.AT_MOST) {
1029            // TODO: after first layout we should maybe start at the first visible position, not 0
1030            heightSize = measureHeightOfChildren(widthMeasureSpec, 0, NO_POSITION, heightSize, -1);
1031        }
1032
1033        setMeasuredDimension(widthSize, heightSize);
1034        mWidthMeasureSpec = widthMeasureSpec;
1035    }
1036
1037    private void measureScrapChild(View child, int position, int widthMeasureSpec) {
1038        LayoutParams p = (LayoutParams) child.getLayoutParams();
1039        if (p == null) {
1040            p = new LayoutParams(ViewGroup.LayoutParams.FILL_PARENT,
1041                    ViewGroup.LayoutParams.WRAP_CONTENT, 0);
1042            child.setLayoutParams(p);
1043        }
1044        p.viewType = mAdapter.getItemViewType(position);
1045
1046        int childWidthSpec = ViewGroup.getChildMeasureSpec(widthMeasureSpec,
1047                mListPadding.left + mListPadding.right, p.width);
1048        int lpHeight = p.height;
1049        int childHeightSpec;
1050        if (lpHeight > 0) {
1051            childHeightSpec = MeasureSpec.makeMeasureSpec(lpHeight, MeasureSpec.EXACTLY);
1052        } else {
1053            childHeightSpec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED);
1054        }
1055        child.measure(childWidthSpec, childHeightSpec);
1056    }
1057
1058    /**
1059     * @return True to recycle the views used to measure this ListView in
1060     *         UNSPECIFIED/AT_MOST modes, false otherwise.
1061     * @hide
1062     */
1063    protected boolean recycleOnMeasure() {
1064        return true;
1065    }
1066
1067    /**
1068     * Measures the height of the given range of children (inclusive) and
1069     * returns the height with this ListView's padding and divider heights
1070     * included. If maxHeight is provided, the measuring will stop when the
1071     * current height reaches maxHeight.
1072     *
1073     * @param widthMeasureSpec The width measure spec to be given to a child's
1074     *            {@link View#measure(int, int)}.
1075     * @param startPosition The position of the first child to be shown.
1076     * @param endPosition The (inclusive) position of the last child to be
1077     *            shown. Specify {@link #NO_POSITION} if the last child should be
1078     *            the last available child from the adapter.
1079     * @param maxHeight The maximum height that will be returned (if all the
1080     *            children don't fit in this value, this value will be
1081     *            returned).
1082     * @param disallowPartialChildPosition In general, whether the returned
1083     *            height should only contain entire children. This is more
1084     *            powerful--it is the first inclusive position at which partial
1085     *            children will not be allowed. Example: it looks nice to have
1086     *            at least 3 completely visible children, and in portrait this
1087     *            will most likely fit; but in landscape there could be times
1088     *            when even 2 children can not be completely shown, so a value
1089     *            of 2 (remember, inclusive) would be good (assuming
1090     *            startPosition is 0).
1091     * @return The height of this ListView with the given children.
1092     */
1093    final int measureHeightOfChildren(int widthMeasureSpec, int startPosition, int endPosition,
1094            final int maxHeight, int disallowPartialChildPosition) {
1095
1096        final ListAdapter adapter = mAdapter;
1097        if (adapter == null) {
1098            return mListPadding.top + mListPadding.bottom;
1099        }
1100
1101        // Include the padding of the list
1102        int returnedHeight = mListPadding.top + mListPadding.bottom;
1103        final int dividerHeight = ((mDividerHeight > 0) && mDivider != null) ? mDividerHeight : 0;
1104        // The previous height value that was less than maxHeight and contained
1105        // no partial children
1106        int prevHeightWithoutPartialChild = 0;
1107        int i;
1108        View child;
1109
1110        // mItemCount - 1 since endPosition parameter is inclusive
1111        endPosition = (endPosition == NO_POSITION) ? adapter.getCount() - 1 : endPosition;
1112        final AbsListView.RecycleBin recycleBin = mRecycler;
1113        final boolean recyle = recycleOnMeasure();
1114
1115        for (i = startPosition; i <= endPosition; ++i) {
1116            child = obtainView(i);
1117
1118            measureScrapChild(child, i, widthMeasureSpec);
1119
1120            if (i > 0) {
1121                // Count the divider for all but one child
1122                returnedHeight += dividerHeight;
1123            }
1124
1125            // Recycle the view before we possibly return from the method
1126            if (recyle) {
1127                recycleBin.addScrapView(child);
1128            }
1129
1130            returnedHeight += child.getMeasuredHeight();
1131
1132            if (returnedHeight >= maxHeight) {
1133                // We went over, figure out which height to return.  If returnedHeight > maxHeight,
1134                // then the i'th position did not fit completely.
1135                return (disallowPartialChildPosition >= 0) // Disallowing is enabled (> -1)
1136                            && (i > disallowPartialChildPosition) // We've past the min pos
1137                            && (prevHeightWithoutPartialChild > 0) // We have a prev height
1138                            && (returnedHeight != maxHeight) // i'th child did not fit completely
1139                        ? prevHeightWithoutPartialChild
1140                        : maxHeight;
1141            }
1142
1143            if ((disallowPartialChildPosition >= 0) && (i >= disallowPartialChildPosition)) {
1144                prevHeightWithoutPartialChild = returnedHeight;
1145            }
1146        }
1147
1148        // At this point, we went through the range of children, and they each
1149        // completely fit, so return the returnedHeight
1150        return returnedHeight;
1151    }
1152
1153    @Override
1154    int findMotionRow(int y) {
1155        int childCount = getChildCount();
1156        if (childCount > 0) {
1157            for (int i = 0; i < childCount; i++) {
1158                View v = getChildAt(i);
1159                if (y <= v.getBottom()) {
1160                    return mFirstPosition + i;
1161                }
1162            }
1163            return mFirstPosition + childCount - 1;
1164        }
1165        return INVALID_POSITION;
1166    }
1167
1168    /**
1169     * Put a specific item at a specific location on the screen and then build
1170     * up and down from there.
1171     *
1172     * @param position The reference view to use as the starting point
1173     * @param top Pixel offset from the top of this view to the top of the
1174     *        reference view.
1175     *
1176     * @return The selected view, or null if the selected view is outside the
1177     *         visible area.
1178     */
1179    private View fillSpecific(int position, int top) {
1180        boolean tempIsSelected = position == mSelectedPosition;
1181        View temp = makeAndAddView(position, top, true, mListPadding.left, tempIsSelected);
1182        // Possibly changed again in fillUp if we add rows above this one.
1183        mFirstPosition = position;
1184
1185        View above;
1186        View below;
1187
1188        final int dividerHeight = mDividerHeight;
1189        if (!mStackFromBottom) {
1190            above = fillUp(position - 1, temp.getTop() - dividerHeight);
1191            // This will correct for the top of the first view not touching the top of the list
1192            adjustViewsUpOrDown();
1193            below = fillDown(position + 1, temp.getBottom() + dividerHeight);
1194            int childCount = getChildCount();
1195            if (childCount > 0) {
1196                correctTooHigh(childCount);
1197            }
1198        } else {
1199            below = fillDown(position + 1, temp.getBottom() + dividerHeight);
1200            // This will correct for the bottom of the last view not touching the bottom of the list
1201            adjustViewsUpOrDown();
1202            above = fillUp(position - 1, temp.getTop() - dividerHeight);
1203            int childCount = getChildCount();
1204            if (childCount > 0) {
1205                 correctTooLow(childCount);
1206            }
1207        }
1208
1209        if (tempIsSelected) {
1210            return temp;
1211        } else if (above != null) {
1212            return above;
1213        } else {
1214            return below;
1215        }
1216    }
1217
1218    /**
1219     * Check if we have dragged the bottom of the list too high (we have pushed the
1220     * top element off the top of the screen when we did not need to). Correct by sliding
1221     * everything back down.
1222     *
1223     * @param childCount Number of children
1224     */
1225    private void correctTooHigh(int childCount) {
1226        // First see if the last item is visible. If it is not, it is OK for the
1227        // top of the list to be pushed up.
1228        int lastPosition = mFirstPosition + childCount - 1;
1229        if (lastPosition == mItemCount - 1 && childCount > 0) {
1230
1231            // Get the last child ...
1232            final View lastChild = getChildAt(childCount - 1);
1233
1234            // ... and its bottom edge
1235            final int lastBottom = lastChild.getBottom();
1236
1237            // This is bottom of our drawable area
1238            final int end = (mBottom - mTop) - mListPadding.bottom;
1239
1240            // This is how far the bottom edge of the last view is from the bottom of the
1241            // drawable area
1242            int bottomOffset = end - lastBottom;
1243            View firstChild = getChildAt(0);
1244            final int firstTop = firstChild.getTop();
1245
1246            // Make sure we are 1) Too high, and 2) Either there are more rows above the
1247            // first row or the first row is scrolled off the top of the drawable area
1248            if (bottomOffset > 0 && (mFirstPosition > 0 || firstTop < mListPadding.top))  {
1249                if (mFirstPosition == 0) {
1250                    // Don't pull the top too far down
1251                    bottomOffset = Math.min(bottomOffset, mListPadding.top - firstTop);
1252                }
1253                // Move everything down
1254                offsetChildrenTopAndBottom(bottomOffset);
1255                if (mFirstPosition > 0) {
1256                    // Fill the gap that was opened above mFirstPosition with more rows, if
1257                    // possible
1258                    fillUp(mFirstPosition - 1, firstChild.getTop() - mDividerHeight);
1259                    // Close up the remaining gap
1260                    adjustViewsUpOrDown();
1261                }
1262
1263            }
1264        }
1265    }
1266
1267    /**
1268     * Check if we have dragged the bottom of the list too low (we have pushed the
1269     * bottom element off the bottom of the screen when we did not need to). Correct by sliding
1270     * everything back up.
1271     *
1272     * @param childCount Number of children
1273     */
1274    private void correctTooLow(int childCount) {
1275        // First see if the first item is visible. If it is not, it is OK for the
1276        // bottom of the list to be pushed down.
1277        if (mFirstPosition == 0 && childCount > 0) {
1278
1279            // Get the first child ...
1280            final View firstChild = getChildAt(0);
1281
1282            // ... and its top edge
1283            final int firstTop = firstChild.getTop();
1284
1285            // This is top of our drawable area
1286            final int start = mListPadding.top;
1287
1288            // This is bottom of our drawable area
1289            final int end = (mBottom - mTop) - mListPadding.bottom;
1290
1291            // This is how far the top edge of the first view is from the top of the
1292            // drawable area
1293            int topOffset = firstTop - start;
1294            View lastChild = getChildAt(childCount - 1);
1295            final int lastBottom = lastChild.getBottom();
1296            int lastPosition = mFirstPosition + childCount - 1;
1297
1298            // Make sure we are 1) Too low, and 2) Either there are more rows below the
1299            // last row or the last row is scrolled off the bottom of the drawable area
1300            if (topOffset > 0 && (lastPosition < mItemCount - 1 || lastBottom > end))  {
1301                if (lastPosition == mItemCount - 1 ) {
1302                    // Don't pull the bottom too far up
1303                    topOffset = Math.min(topOffset, lastBottom - end);
1304                }
1305                // Move everything up
1306                offsetChildrenTopAndBottom(-topOffset);
1307                if (lastPosition < mItemCount - 1) {
1308                    // Fill the gap that was opened below the last position with more rows, if
1309                    // possible
1310                    fillDown(lastPosition + 1, lastChild.getBottom() + mDividerHeight);
1311                    // Close up the remaining gap
1312                    adjustViewsUpOrDown();
1313                }
1314            }
1315        }
1316    }
1317
1318    @Override
1319    protected void layoutChildren() {
1320        final boolean blockLayoutRequests = mBlockLayoutRequests;
1321        if (!blockLayoutRequests) {
1322            mBlockLayoutRequests = true;
1323        } else {
1324            return;
1325        }
1326
1327        try {
1328            super.layoutChildren();
1329
1330            invalidate();
1331
1332            if (mAdapter == null) {
1333                resetList();
1334                invokeOnItemScrollListener();
1335                return;
1336            }
1337
1338            int childrenTop = mListPadding.top;
1339            int childrenBottom = mBottom - mTop - mListPadding.bottom;
1340
1341            int childCount = getChildCount();
1342            int index;
1343            int delta = 0;
1344
1345            View sel;
1346            View oldSel = null;
1347            View oldFirst = null;
1348            View newSel = null;
1349
1350            View focusLayoutRestoreView = null;
1351
1352            // Remember stuff we will need down below
1353            switch (mLayoutMode) {
1354            case LAYOUT_SET_SELECTION:
1355                index = mNextSelectedPosition - mFirstPosition;
1356                if (index >= 0 && index < childCount) {
1357                    newSel = getChildAt(index);
1358                }
1359                break;
1360            case LAYOUT_FORCE_TOP:
1361            case LAYOUT_FORCE_BOTTOM:
1362            case LAYOUT_SPECIFIC:
1363            case LAYOUT_SYNC:
1364                break;
1365            case LAYOUT_MOVE_SELECTION:
1366            default:
1367                // Remember the previously selected view
1368                index = mSelectedPosition - mFirstPosition;
1369                if (index >= 0 && index < childCount) {
1370                    oldSel = getChildAt(index);
1371                }
1372
1373                // Remember the previous first child
1374                oldFirst = getChildAt(0);
1375
1376                if (mNextSelectedPosition >= 0) {
1377                    delta = mNextSelectedPosition - mSelectedPosition;
1378                }
1379
1380                // Caution: newSel might be null
1381                newSel = getChildAt(index + delta);
1382            }
1383
1384
1385            boolean dataChanged = mDataChanged;
1386            if (dataChanged) {
1387                handleDataChanged();
1388            }
1389
1390            // Handle the empty set by removing all views that are visible
1391            // and calling it a day
1392            if (mItemCount == 0) {
1393                resetList();
1394                invokeOnItemScrollListener();
1395                return;
1396            } else if (mItemCount != mAdapter.getCount()) {
1397                throw new IllegalStateException("The content of the adapter has changed but "
1398                        + "ListView did not receive a notification. Make sure the content of "
1399                        + "your adapter is not modified from a background thread, but only "
1400                        + "from the UI thread.");
1401            }
1402
1403            setSelectedPositionInt(mNextSelectedPosition);
1404
1405            // Pull all children into the RecycleBin.
1406            // These views will be reused if possible
1407            final int firstPosition = mFirstPosition;
1408            final RecycleBin recycleBin = mRecycler;
1409
1410            // reset the focus restoration
1411            View focusLayoutRestoreDirectChild = null;
1412
1413
1414            // Don't put header or footer views into the Recycler. Those are
1415            // already cached in mHeaderViews;
1416            if (dataChanged) {
1417                for (int i = 0; i < childCount; i++) {
1418                    recycleBin.addScrapView(getChildAt(i));
1419                    if (ViewDebug.TRACE_RECYCLER) {
1420                        ViewDebug.trace(getChildAt(i),
1421                                ViewDebug.RecyclerTraceType.MOVE_TO_SCRAP_HEAP, index, i);
1422                    }
1423                }
1424            } else {
1425                recycleBin.fillActiveViews(childCount, firstPosition);
1426            }
1427
1428            // take focus back to us temporarily to avoid the eventual
1429            // call to clear focus when removing the focused child below
1430            // from messing things up when ViewRoot assigns focus back
1431            // to someone else
1432            final View focusedChild = getFocusedChild();
1433            if (focusedChild != null) {
1434                // TODO: in some cases focusedChild.getParent() == null
1435
1436                // we can remember the focused view to restore after relayout if the
1437                // data hasn't changed, or if the focused position is a header or footer
1438                if (!dataChanged || isDirectChildHeaderOrFooter(focusedChild)) {
1439                    focusLayoutRestoreDirectChild = focusedChild;
1440                    // remember the specific view that had focus
1441                    focusLayoutRestoreView = findFocus();
1442                    if (focusLayoutRestoreView != null) {
1443                        // tell it we are going to mess with it
1444                        focusLayoutRestoreView.onStartTemporaryDetach();
1445                    }
1446                }
1447                requestFocus();
1448            }
1449
1450            // Clear out old views
1451            //removeAllViewsInLayout();
1452            detachAllViewsFromParent();
1453
1454            switch (mLayoutMode) {
1455            case LAYOUT_SET_SELECTION:
1456                if (newSel != null) {
1457                    sel = fillFromSelection(newSel.getTop(), childrenTop, childrenBottom);
1458                } else {
1459                    sel = fillFromMiddle(childrenTop, childrenBottom);
1460                }
1461                break;
1462            case LAYOUT_SYNC:
1463                sel = fillSpecific(mSyncPosition, mSpecificTop);
1464                break;
1465            case LAYOUT_FORCE_BOTTOM:
1466                sel = fillUp(mItemCount - 1, childrenBottom);
1467                adjustViewsUpOrDown();
1468                break;
1469            case LAYOUT_FORCE_TOP:
1470                mFirstPosition = 0;
1471                sel = fillFromTop(childrenTop);
1472                adjustViewsUpOrDown();
1473                break;
1474            case LAYOUT_SPECIFIC:
1475                sel = fillSpecific(reconcileSelectedPosition(), mSpecificTop);
1476                break;
1477            case LAYOUT_MOVE_SELECTION:
1478                sel = moveSelection(oldSel, newSel, delta, childrenTop, childrenBottom);
1479                break;
1480            default:
1481                if (childCount == 0) {
1482                    if (!mStackFromBottom) {
1483                        final int position = lookForSelectablePosition(0, true);
1484                        setSelectedPositionInt(position);
1485                        sel = fillFromTop(childrenTop);
1486                    } else {
1487                        final int position = lookForSelectablePosition(mItemCount - 1, false);
1488                        setSelectedPositionInt(position);
1489                        sel = fillUp(mItemCount - 1, childrenBottom);
1490                    }
1491                } else {
1492                    if (mSelectedPosition >= 0 && mSelectedPosition < mItemCount) {
1493                        sel = fillSpecific(mSelectedPosition,
1494                                oldSel == null ? childrenTop : oldSel.getTop());
1495                    } else if (mFirstPosition < mItemCount) {
1496                        sel = fillSpecific(mFirstPosition,
1497                                oldFirst == null ? childrenTop : oldFirst.getTop());
1498                    } else {
1499                        sel = fillSpecific(0, childrenTop);
1500                    }
1501                }
1502                break;
1503            }
1504
1505            // Flush any cached views that did not get reused above
1506            recycleBin.scrapActiveViews();
1507
1508            if (sel != null) {
1509               // the current selected item should get focus if items
1510               // are focusable
1511               if (mItemsCanFocus && hasFocus() && !sel.hasFocus()) {
1512                   final boolean focusWasTaken = (sel == focusLayoutRestoreDirectChild &&
1513                           focusLayoutRestoreView.requestFocus()) || sel.requestFocus();
1514                   if (!focusWasTaken) {
1515                       // selected item didn't take focus, fine, but still want
1516                       // to make sure something else outside of the selected view
1517                       // has focus
1518                       final View focused = getFocusedChild();
1519                       if (focused != null) {
1520                           focused.clearFocus();
1521                       }
1522                       positionSelector(sel);
1523                   } else {
1524                       sel.setSelected(false);
1525                       mSelectorRect.setEmpty();
1526                   }
1527               } else {
1528                   positionSelector(sel);
1529               }
1530               mSelectedTop = sel.getTop();
1531            } else {
1532               mSelectedTop = 0;
1533               mSelectorRect.setEmpty();
1534
1535               // even if there is not selected position, we may need to restore
1536               // focus (i.e. something focusable in touch mode)
1537               if (hasFocus() && focusLayoutRestoreView != null) {
1538                   focusLayoutRestoreView.requestFocus();
1539               }
1540            }
1541
1542            // tell focus view we are done mucking with it, if it is still in
1543            // our view hierarchy.
1544            if (focusLayoutRestoreView != null
1545                    && focusLayoutRestoreView.getWindowToken() != null) {
1546                focusLayoutRestoreView.onFinishTemporaryDetach();
1547            }
1548
1549            mLayoutMode = LAYOUT_NORMAL;
1550            mDataChanged = false;
1551            mNeedSync = false;
1552            setNextSelectedPositionInt(mSelectedPosition);
1553
1554            updateScrollIndicators();
1555
1556            if (mItemCount > 0) {
1557                checkSelectionChanged();
1558            }
1559
1560            invokeOnItemScrollListener();
1561        } finally {
1562            if (!blockLayoutRequests) {
1563                mBlockLayoutRequests = false;
1564            }
1565        }
1566    }
1567
1568    /**
1569     * @param child a direct child of this list.
1570     * @return Whether child is a header or footer view.
1571     */
1572    private boolean isDirectChildHeaderOrFooter(View child) {
1573
1574        final ArrayList<FixedViewInfo> headers = mHeaderViewInfos;
1575        final int numHeaders = headers.size();
1576        for (int i = 0; i < numHeaders; i++) {
1577            if (child == headers.get(i).view) {
1578                return true;
1579            }
1580        }
1581        final ArrayList<FixedViewInfo> footers = mFooterViewInfos;
1582        final int numFooters = footers.size();
1583        for (int i = 0; i < numFooters; i++) {
1584            if (child == footers.get(i).view) {
1585                return true;
1586            }
1587        }
1588        return false;
1589    }
1590
1591    /**
1592     * Obtain the view and add it to our list of children. The view can be made
1593     * fresh, converted from an unused view, or used as is if it was in the
1594     * recycle bin.
1595     *
1596     * @param position Logical position in the list
1597     * @param y Top or bottom edge of the view to add
1598     * @param flow If flow is true, align top edge to y. If false, align bottom
1599     *        edge to y.
1600     * @param childrenLeft Left edge where children should be positioned
1601     * @param selected Is this position selected?
1602     * @return View that was added
1603     */
1604    private View makeAndAddView(int position, int y, boolean flow, int childrenLeft,
1605            boolean selected) {
1606        View child;
1607
1608
1609        if (!mDataChanged) {
1610            // Try to use an exsiting view for this position
1611            child = mRecycler.getActiveView(position);
1612            if (child != null) {
1613                if (ViewDebug.TRACE_RECYCLER) {
1614                    ViewDebug.trace(child, ViewDebug.RecyclerTraceType.RECYCLE_FROM_ACTIVE_HEAP,
1615                            position, getChildCount());
1616                }
1617
1618                // Found it -- we're using an existing child
1619                // This just needs to be positioned
1620                setupChild(child, position, y, flow, childrenLeft, selected, true);
1621
1622                return child;
1623            }
1624        }
1625
1626        // Make a new view for this position, or convert an unused view if possible
1627        child = obtainView(position);
1628
1629        // This needs to be positioned and measured
1630        setupChild(child, position, y, flow, childrenLeft, selected, false);
1631
1632        return child;
1633    }
1634
1635    /**
1636     * Add a view as a child and make sure it is measured (if necessary) and
1637     * positioned properly.
1638     *
1639     * @param child The view to add
1640     * @param position The position of this child
1641     * @param y The y position relative to which this view will be positioned
1642     * @param flowDown If true, align top edge to y. If false, align bottom
1643     *        edge to y.
1644     * @param childrenLeft Left edge where children should be positioned
1645     * @param selected Is this position selected?
1646     * @param recycled Has this view been pulled from the recycle bin? If so it
1647     *        does not need to be remeasured.
1648     */
1649    private void setupChild(View child, int position, int y, boolean flowDown, int childrenLeft,
1650            boolean selected, boolean recycled) {
1651        final boolean isSelected = selected && shouldShowSelector();
1652        final boolean updateChildSelected = isSelected != child.isSelected();
1653        final boolean needToMeasure = !recycled || updateChildSelected || child.isLayoutRequested();
1654
1655        // Respect layout params that are already in the view. Otherwise make some up...
1656        // noinspection unchecked
1657        AbsListView.LayoutParams p = (AbsListView.LayoutParams) child.getLayoutParams();
1658        if (p == null) {
1659            p = new AbsListView.LayoutParams(ViewGroup.LayoutParams.FILL_PARENT,
1660                    ViewGroup.LayoutParams.WRAP_CONTENT, 0);
1661        }
1662        p.viewType = mAdapter.getItemViewType(position);
1663
1664        if (recycled || (p.recycledHeaderFooter &&
1665                p.viewType == AdapterView.ITEM_VIEW_TYPE_HEADER_OR_FOOTER)) {
1666            attachViewToParent(child, flowDown ? -1 : 0, p);
1667        } else {
1668            if (p.viewType == AdapterView.ITEM_VIEW_TYPE_HEADER_OR_FOOTER) {
1669                p.recycledHeaderFooter = true;
1670            }
1671            addViewInLayout(child, flowDown ? -1 : 0, p, true);
1672        }
1673
1674        if (updateChildSelected) {
1675            child.setSelected(isSelected);
1676        }
1677
1678        if (mChoiceMode != CHOICE_MODE_NONE && mCheckStates != null) {
1679            if (child instanceof Checkable) {
1680                ((Checkable) child).setChecked(mCheckStates.get(position));
1681            }
1682        }
1683
1684        if (needToMeasure) {
1685            int childWidthSpec = ViewGroup.getChildMeasureSpec(mWidthMeasureSpec,
1686                    mListPadding.left + mListPadding.right, p.width);
1687            int lpHeight = p.height;
1688            int childHeightSpec;
1689            if (lpHeight > 0) {
1690                childHeightSpec = MeasureSpec.makeMeasureSpec(lpHeight, MeasureSpec.EXACTLY);
1691            } else {
1692                childHeightSpec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED);
1693            }
1694            child.measure(childWidthSpec, childHeightSpec);
1695        } else {
1696            cleanupLayoutState(child);
1697        }
1698
1699        final int w = child.getMeasuredWidth();
1700        final int h = child.getMeasuredHeight();
1701        final int childTop = flowDown ? y : y - h;
1702
1703        if (needToMeasure) {
1704            final int childRight = childrenLeft + w;
1705            final int childBottom = childTop + h;
1706            child.layout(childrenLeft, childTop, childRight, childBottom);
1707        } else {
1708            child.offsetLeftAndRight(childrenLeft - child.getLeft());
1709            child.offsetTopAndBottom(childTop - child.getTop());
1710        }
1711
1712        if (mCachingStarted && !child.isDrawingCacheEnabled()) {
1713            child.setDrawingCacheEnabled(true);
1714        }
1715    }
1716
1717    @Override
1718    protected boolean canAnimate() {
1719        return super.canAnimate() && mItemCount > 0;
1720    }
1721
1722    /**
1723     * Sets the currently selected item. If in touch mode, the item will not be selected
1724     * but it will still be positioned appropriately. If the specified selection position
1725     * is less than 0, then the item at position 0 will be selected.
1726     *
1727     * @param position Index (starting at 0) of the data item to be selected.
1728     */
1729    @Override
1730    public void setSelection(int position) {
1731        setSelectionFromTop(position, 0);
1732    }
1733
1734    /**
1735     * Sets the selected item and positions the selection y pixels from the top edge
1736     * of the ListView. (If in touch mode, the item will not be selected but it will
1737     * still be positioned appropriately.)
1738     *
1739     * @param position Index (starting at 0) of the data item to be selected.
1740     * @param y The distance from the top edge of the ListView (plus padding) that the
1741     *        item will be positioned.
1742     */
1743    public void setSelectionFromTop(int position, int y) {
1744        if (mAdapter == null) {
1745            return;
1746        }
1747
1748        if (!isInTouchMode()) {
1749            position = lookForSelectablePosition(position, true);
1750            if (position >= 0) {
1751                setNextSelectedPositionInt(position);
1752            }
1753        } else {
1754            mResurrectToPosition = position;
1755        }
1756
1757        if (position >= 0) {
1758            mLayoutMode = LAYOUT_SPECIFIC;
1759            mSpecificTop = mListPadding.top + y;
1760
1761            if (mNeedSync) {
1762                mSyncPosition = position;
1763                mSyncRowId = mAdapter.getItemId(position);
1764            }
1765
1766            requestLayout();
1767        }
1768    }
1769
1770    /**
1771     * Makes the item at the supplied position selected.
1772     *
1773     * @param position the position of the item to select
1774     */
1775    @Override
1776    void setSelectionInt(int position) {
1777        setNextSelectedPositionInt(position);
1778        layoutChildren();
1779    }
1780
1781    /**
1782     * Find a position that can be selected (i.e., is not a separator).
1783     *
1784     * @param position The starting position to look at.
1785     * @param lookDown Whether to look down for other positions.
1786     * @return The next selectable position starting at position and then searching either up or
1787     *         down. Returns {@link #INVALID_POSITION} if nothing can be found.
1788     */
1789    @Override
1790    int lookForSelectablePosition(int position, boolean lookDown) {
1791        final ListAdapter adapter = mAdapter;
1792        if (adapter == null || isInTouchMode()) {
1793            return INVALID_POSITION;
1794        }
1795
1796        final int count = adapter.getCount();
1797        if (!mAreAllItemsSelectable) {
1798            if (lookDown) {
1799                position = Math.max(0, position);
1800                while (position < count && !adapter.isEnabled(position)) {
1801                    position++;
1802                }
1803            } else {
1804                position = Math.min(position, count - 1);
1805                while (position >= 0 && !adapter.isEnabled(position)) {
1806                    position--;
1807                }
1808            }
1809
1810            if (position < 0 || position >= count) {
1811                return INVALID_POSITION;
1812            }
1813            return position;
1814        } else {
1815            if (position < 0 || position >= count) {
1816                return INVALID_POSITION;
1817            }
1818            return position;
1819        }
1820    }
1821
1822    /**
1823     * setSelectionAfterHeaderView set the selection to be the first list item
1824     * after the header views.
1825     */
1826    public void setSelectionAfterHeaderView() {
1827        final int count = mHeaderViewInfos.size();
1828        if (count > 0) {
1829            mNextSelectedPosition = 0;
1830            return;
1831        }
1832
1833        if (mAdapter != null) {
1834            setSelection(count);
1835        } else {
1836            mNextSelectedPosition = count;
1837            mLayoutMode = LAYOUT_SET_SELECTION;
1838        }
1839
1840    }
1841
1842    @Override
1843    public boolean dispatchKeyEvent(KeyEvent event) {
1844        // Dispatch in the normal way
1845        boolean handled = super.dispatchKeyEvent(event);
1846        if (!handled) {
1847            // If we didn't handle it...
1848            View focused = getFocusedChild();
1849            if (focused != null && event.getAction() == KeyEvent.ACTION_DOWN) {
1850                // ... and our focused child didn't handle it
1851                // ... give it to ourselves so we can scroll if necessary
1852                handled = onKeyDown(event.getKeyCode(), event);
1853            }
1854        }
1855        return handled;
1856    }
1857
1858    @Override
1859    public boolean onKeyDown(int keyCode, KeyEvent event) {
1860        return commonKey(keyCode, 1, event);
1861    }
1862
1863    @Override
1864    public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
1865        return commonKey(keyCode, repeatCount, event);
1866    }
1867
1868    @Override
1869    public boolean onKeyUp(int keyCode, KeyEvent event) {
1870        return commonKey(keyCode, 1, event);
1871    }
1872
1873    private boolean commonKey(int keyCode, int count, KeyEvent event) {
1874        if (mAdapter == null) {
1875            return false;
1876        }
1877
1878        if (mDataChanged) {
1879            layoutChildren();
1880        }
1881
1882        boolean handled = false;
1883        int action = event.getAction();
1884
1885        if (action != KeyEvent.ACTION_UP) {
1886            if (mSelectedPosition < 0) {
1887                switch (keyCode) {
1888                case KeyEvent.KEYCODE_DPAD_UP:
1889                case KeyEvent.KEYCODE_DPAD_DOWN:
1890                case KeyEvent.KEYCODE_DPAD_CENTER:
1891                case KeyEvent.KEYCODE_ENTER:
1892                case KeyEvent.KEYCODE_SPACE:
1893                    if (resurrectSelection()) {
1894                        return true;
1895                    }
1896                }
1897            }
1898            switch (keyCode) {
1899            case KeyEvent.KEYCODE_DPAD_UP:
1900                if (!event.isAltPressed()) {
1901                    while (count > 0) {
1902                        handled = arrowScroll(FOCUS_UP);
1903                        count--;
1904                    }
1905                } else {
1906                    handled = fullScroll(FOCUS_UP);
1907                }
1908                break;
1909
1910            case KeyEvent.KEYCODE_DPAD_DOWN:
1911                if (!event.isAltPressed()) {
1912                    while (count > 0) {
1913                        handled = arrowScroll(FOCUS_DOWN);
1914                        count--;
1915                    }
1916                } else {
1917                    handled = fullScroll(FOCUS_DOWN);
1918                }
1919                break;
1920
1921            case KeyEvent.KEYCODE_DPAD_LEFT:
1922                handled = handleHorizontalFocusWithinListItem(View.FOCUS_LEFT);
1923                break;
1924            case KeyEvent.KEYCODE_DPAD_RIGHT:
1925                handled = handleHorizontalFocusWithinListItem(View.FOCUS_RIGHT);
1926                break;
1927
1928            case KeyEvent.KEYCODE_DPAD_CENTER:
1929            case KeyEvent.KEYCODE_ENTER:
1930                if (mItemCount > 0 && event.getRepeatCount() == 0) {
1931                    keyPressed();
1932                }
1933                handled = true;
1934                break;
1935
1936            case KeyEvent.KEYCODE_SPACE:
1937                if (mPopup == null || !mPopup.isShowing()) {
1938                    if (!event.isShiftPressed()) {
1939                        pageScroll(FOCUS_DOWN);
1940                    } else {
1941                        pageScroll(FOCUS_UP);
1942                    }
1943                    handled = true;
1944                }
1945                break;
1946            }
1947        }
1948
1949        if (!handled) {
1950            handled = sendToTextFilter(keyCode, count, event);
1951        }
1952
1953        if (handled) {
1954            return true;
1955        } else {
1956            switch (action) {
1957                case KeyEvent.ACTION_DOWN:
1958                    return super.onKeyDown(keyCode, event);
1959
1960                case KeyEvent.ACTION_UP:
1961                    return super.onKeyUp(keyCode, event);
1962
1963                case KeyEvent.ACTION_MULTIPLE:
1964                    return super.onKeyMultiple(keyCode, count, event);
1965
1966                default: // shouldn't happen
1967                    return false;
1968            }
1969        }
1970    }
1971
1972    /**
1973     * Scrolls up or down by the number of items currently present on screen.
1974     *
1975     * @param direction either {@link View#FOCUS_UP} or {@link View#FOCUS_DOWN}
1976     * @return whether selection was moved
1977     */
1978    boolean pageScroll(int direction) {
1979        int nextPage = -1;
1980        boolean down = false;
1981
1982        if (direction == FOCUS_UP) {
1983            nextPage = Math.max(0, mSelectedPosition - getChildCount() - 1);
1984        } else if (direction == FOCUS_DOWN) {
1985            nextPage = Math.min(mItemCount - 1, mSelectedPosition + getChildCount() - 1);
1986            down = true;
1987        }
1988
1989        if (nextPage >= 0) {
1990            int position = lookForSelectablePosition(nextPage, down);
1991            if (position >= 0) {
1992                mLayoutMode = LAYOUT_SPECIFIC;
1993                mSpecificTop = mPaddingTop + getVerticalFadingEdgeLength();
1994
1995                if (down && position > mItemCount - getChildCount()) {
1996                    mLayoutMode = LAYOUT_FORCE_BOTTOM;
1997                }
1998
1999                if (!down && position < getChildCount()) {
2000                    mLayoutMode = LAYOUT_FORCE_TOP;
2001                }
2002
2003                setSelectionInt(position);
2004                invokeOnItemScrollListener();
2005                invalidate();
2006
2007                return true;
2008            }
2009        }
2010
2011        return false;
2012    }
2013
2014    /**
2015     * Go to the last or first item if possible (not worrying about panning across or navigating
2016     * within the internal focus of the currently selected item.)
2017     *
2018     * @param direction either {@link View#FOCUS_UP} or {@link View#FOCUS_DOWN}
2019     *
2020     * @return whether selection was moved
2021     */
2022    boolean fullScroll(int direction) {
2023        boolean moved = false;
2024        if (direction == FOCUS_UP) {
2025            if (mSelectedPosition != 0) {
2026                int position = lookForSelectablePosition(0, true);
2027                if (position >= 0) {
2028                    mLayoutMode = LAYOUT_FORCE_TOP;
2029                    setSelectionInt(position);
2030                    invokeOnItemScrollListener();
2031                }
2032                moved = true;
2033            }
2034        } else if (direction == FOCUS_DOWN) {
2035            if (mSelectedPosition < mItemCount - 1) {
2036                int position = lookForSelectablePosition(mItemCount - 1, true);
2037                if (position >= 0) {
2038                    mLayoutMode = LAYOUT_FORCE_BOTTOM;
2039                    setSelectionInt(position);
2040                    invokeOnItemScrollListener();
2041                }
2042                moved = true;
2043            }
2044        }
2045
2046        if (moved) {
2047            invalidate();
2048        }
2049
2050        return moved;
2051    }
2052
2053    /**
2054     * To avoid horizontal focus searches changing the selected item, we
2055     * manually focus search within the selected item (as applicable), and
2056     * prevent focus from jumping to something within another item.
2057     * @param direction one of {View.FOCUS_LEFT, View.FOCUS_RIGHT}
2058     * @return Whether this consumes the key event.
2059     */
2060    private boolean handleHorizontalFocusWithinListItem(int direction) {
2061        if (direction != View.FOCUS_LEFT && direction != View.FOCUS_RIGHT)  {
2062            throw new IllegalArgumentException("direction must be one of"
2063                    + " {View.FOCUS_LEFT, View.FOCUS_RIGHT}");
2064        }
2065
2066        final int numChildren = getChildCount();
2067        if (mItemsCanFocus && numChildren > 0 && mSelectedPosition != INVALID_POSITION) {
2068            final View selectedView = getSelectedView();
2069            if (selectedView != null && selectedView.hasFocus() &&
2070                    selectedView instanceof ViewGroup) {
2071
2072                final View currentFocus = selectedView.findFocus();
2073                final View nextFocus = FocusFinder.getInstance().findNextFocus(
2074                        (ViewGroup) selectedView, currentFocus, direction);
2075                if (nextFocus != null) {
2076                    // do the math to get interesting rect in next focus' coordinates
2077                    currentFocus.getFocusedRect(mTempRect);
2078                    offsetDescendantRectToMyCoords(currentFocus, mTempRect);
2079                    offsetRectIntoDescendantCoords(nextFocus, mTempRect);
2080                    if (nextFocus.requestFocus(direction, mTempRect)) {
2081                        return true;
2082                    }
2083                }
2084                // we are blocking the key from being handled (by returning true)
2085                // if the global result is going to be some other view within this
2086                // list.  this is to acheive the overall goal of having
2087                // horizontal d-pad navigation remain in the current item.
2088                final View globalNextFocus = FocusFinder.getInstance().findNextFocus(
2089                        (ViewGroup) getRootView(), currentFocus, direction);
2090                if (globalNextFocus != null) {
2091                    return isViewAncestorOf(globalNextFocus, this);
2092                }
2093            }
2094        }
2095        return false;
2096    }
2097
2098    /**
2099     * Scrolls to the next or previous item if possible.
2100     *
2101     * @param direction either {@link View#FOCUS_UP} or {@link View#FOCUS_DOWN}
2102     *
2103     * @return whether selection was moved
2104     */
2105    boolean arrowScroll(int direction) {
2106        try {
2107            mInLayout = true;
2108            final boolean handled = arrowScrollImpl(direction);
2109            if (handled) {
2110                playSoundEffect(SoundEffectConstants.getContantForFocusDirection(direction));
2111            }
2112            return handled;
2113        } finally {
2114            mInLayout = false;
2115        }
2116    }
2117
2118    /**
2119     * Handle an arrow scroll going up or down.  Take into account whether items are selectable,
2120     * whether there are focusable items etc.
2121     *
2122     * @param direction Either {@link android.view.View#FOCUS_UP} or {@link android.view.View#FOCUS_DOWN}.
2123     * @return Whether any scrolling, selection or focus change occured.
2124     */
2125    private boolean arrowScrollImpl(int direction) {
2126        if (getChildCount() <= 0) {
2127            return false;
2128        }
2129
2130        View selectedView = getSelectedView();
2131
2132        int nextSelectedPosition = lookForSelectablePositionOnScreen(direction);
2133        int amountToScroll = amountToScroll(direction, nextSelectedPosition);
2134
2135        // if we are moving focus, we may OVERRIDE the default behavior
2136        final ArrowScrollFocusResult focusResult = mItemsCanFocus ? arrowScrollFocused(direction) : null;
2137        if (focusResult != null) {
2138            nextSelectedPosition = focusResult.getSelectedPosition();
2139            amountToScroll = focusResult.getAmountToScroll();
2140        }
2141
2142        boolean needToRedraw = focusResult != null;
2143        if (nextSelectedPosition != INVALID_POSITION) {
2144            handleNewSelectionChange(selectedView, direction, nextSelectedPosition, focusResult != null);
2145            setSelectedPositionInt(nextSelectedPosition);
2146            setNextSelectedPositionInt(nextSelectedPosition);
2147            selectedView = getSelectedView();
2148            if (mItemsCanFocus && focusResult == null) {
2149                // there was no new view found to take focus, make sure we
2150                // don't leave focus with the old selection
2151                final View focused = getFocusedChild();
2152                if (focused != null) {
2153                    focused.clearFocus();
2154                }
2155            }
2156            needToRedraw = true;
2157            checkSelectionChanged();
2158        }
2159
2160        if (amountToScroll > 0) {
2161            scrollListItemsBy((direction == View.FOCUS_UP) ? amountToScroll : -amountToScroll);
2162            needToRedraw = true;
2163        }
2164
2165        // if we didn't find a new focusable, make sure any existing focused
2166        // item that was panned off screen gives up focus.
2167        if (mItemsCanFocus && (focusResult == null)
2168                && selectedView != null && selectedView.hasFocus()) {
2169            final View focused = selectedView.findFocus();
2170            if (distanceToView(focused) > 0) {
2171                focused.clearFocus();
2172            }
2173        }
2174
2175        // if  the current selection is panned off, we need to remove the selection
2176        if (nextSelectedPosition == INVALID_POSITION && selectedView != null
2177                && !isViewAncestorOf(selectedView, this)) {
2178            selectedView = null;
2179            hideSelector();
2180
2181            // but we don't want to set the ressurect position (that would make subsequent
2182            // unhandled key events bring back the item we just scrolled off!)
2183            mResurrectToPosition = INVALID_POSITION;
2184        }
2185
2186        if (needToRedraw) {
2187            if (selectedView != null) {
2188                positionSelector(selectedView);
2189                mSelectedTop = selectedView.getTop();
2190            }
2191            invalidate();
2192            invokeOnItemScrollListener();
2193            return true;
2194        }
2195
2196        return false;
2197    }
2198
2199    /**
2200     * When selection changes, it is possible that the previously selected or the
2201     * next selected item will change its size.  If so, we need to offset some folks,
2202     * and re-layout the items as appropriate.
2203     *
2204     * @param selectedView The currently selected view (before changing selection).
2205     *   should be <code>null</code> if there was no previous selection.
2206     * @param direction Either {@link android.view.View#FOCUS_UP} or
2207     *        {@link android.view.View#FOCUS_DOWN}.
2208     * @param newSelectedPosition The position of the next selection.
2209     * @param newFocusAssigned whether new focus was assigned.  This matters because
2210     *        when something has focus, we don't want to show selection (ugh).
2211     */
2212    private void handleNewSelectionChange(View selectedView, int direction, int newSelectedPosition,
2213            boolean newFocusAssigned) {
2214        if (newSelectedPosition == INVALID_POSITION) {
2215            throw new IllegalArgumentException("newSelectedPosition needs to be valid");
2216        }
2217
2218        // whether or not we are moving down or up, we want to preserve the
2219        // top of whatever view is on top:
2220        // - moving down: the view that had selection
2221        // - moving up: the view that is getting selection
2222        View topView;
2223        View bottomView;
2224        int topViewIndex, bottomViewIndex;
2225        boolean topSelected = false;
2226        final int selectedIndex = mSelectedPosition - mFirstPosition;
2227        final int nextSelectedIndex = newSelectedPosition - mFirstPosition;
2228        if (direction == View.FOCUS_UP) {
2229            topViewIndex = nextSelectedIndex;
2230            bottomViewIndex = selectedIndex;
2231            topView = getChildAt(topViewIndex);
2232            bottomView = selectedView;
2233            topSelected = true;
2234        } else {
2235            topViewIndex = selectedIndex;
2236            bottomViewIndex = nextSelectedIndex;
2237            topView = selectedView;
2238            bottomView = getChildAt(bottomViewIndex);
2239        }
2240
2241        final int numChildren = getChildCount();
2242
2243        // start with top view: is it changing size?
2244        if (topView != null) {
2245            topView.setSelected(!newFocusAssigned && topSelected);
2246            measureAndAdjustDown(topView, topViewIndex, numChildren);
2247        }
2248
2249        // is the bottom view changing size?
2250        if (bottomView != null) {
2251            bottomView.setSelected(!newFocusAssigned && !topSelected);
2252            measureAndAdjustDown(bottomView, bottomViewIndex, numChildren);
2253        }
2254    }
2255
2256    /**
2257     * Re-measure a child, and if its height changes, lay it out preserving its
2258     * top, and adjust the children below it appropriately.
2259     * @param child The child
2260     * @param childIndex The view group index of the child.
2261     * @param numChildren The number of children in the view group.
2262     */
2263    private void measureAndAdjustDown(View child, int childIndex, int numChildren) {
2264        int oldHeight = child.getHeight();
2265        measureItem(child);
2266        if (child.getMeasuredHeight() != oldHeight) {
2267            // lay out the view, preserving its top
2268            relayoutMeasuredItem(child);
2269
2270            // adjust views below appropriately
2271            final int heightDelta = child.getMeasuredHeight() - oldHeight;
2272            for (int i = childIndex + 1; i < numChildren; i++) {
2273                getChildAt(i).offsetTopAndBottom(heightDelta);
2274            }
2275        }
2276    }
2277
2278    /**
2279     * Measure a particular list child.
2280     * TODO: unify with setUpChild.
2281     * @param child The child.
2282     */
2283    private void measureItem(View child) {
2284        ViewGroup.LayoutParams p = child.getLayoutParams();
2285        if (p == null) {
2286            p = new ViewGroup.LayoutParams(
2287                    ViewGroup.LayoutParams.FILL_PARENT,
2288                    ViewGroup.LayoutParams.WRAP_CONTENT);
2289        }
2290
2291        int childWidthSpec = ViewGroup.getChildMeasureSpec(mWidthMeasureSpec,
2292                mListPadding.left + mListPadding.right, p.width);
2293        int lpHeight = p.height;
2294        int childHeightSpec;
2295        if (lpHeight > 0) {
2296            childHeightSpec = MeasureSpec.makeMeasureSpec(lpHeight, MeasureSpec.EXACTLY);
2297        } else {
2298            childHeightSpec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED);
2299        }
2300        child.measure(childWidthSpec, childHeightSpec);
2301    }
2302
2303    /**
2304     * Layout a child that has been measured, preserving its top position.
2305     * TODO: unify with setUpChild.
2306     * @param child The child.
2307     */
2308    private void relayoutMeasuredItem(View child) {
2309        final int w = child.getMeasuredWidth();
2310        final int h = child.getMeasuredHeight();
2311        final int childLeft = mListPadding.left;
2312        final int childRight = childLeft + w;
2313        final int childTop = child.getTop();
2314        final int childBottom = childTop + h;
2315        child.layout(childLeft, childTop, childRight, childBottom);
2316    }
2317
2318    /**
2319     * @return The amount to preview next items when arrow srolling.
2320     */
2321    private int getArrowScrollPreviewLength() {
2322        return Math.max(MIN_SCROLL_PREVIEW_PIXELS, getVerticalFadingEdgeLength());
2323    }
2324
2325    /**
2326     * Determine how much we need to scroll in order to get the next selected view
2327     * visible, with a fading edge showing below as applicable.  The amount is
2328     * capped at {@link #getMaxScrollAmount()} .
2329     *
2330     * @param direction either {@link android.view.View#FOCUS_UP} or
2331     *        {@link android.view.View#FOCUS_DOWN}.
2332     * @param nextSelectedPosition The position of the next selection, or
2333     *        {@link #INVALID_POSITION} if there is no next selectable position
2334     * @return The amount to scroll. Note: this is always positive!  Direction
2335     *         needs to be taken into account when actually scrolling.
2336     */
2337    private int amountToScroll(int direction, int nextSelectedPosition) {
2338        final int listBottom = getHeight() - mListPadding.bottom;
2339        final int listTop = mListPadding.top;
2340
2341        final int numChildren = getChildCount();
2342
2343        if (direction == View.FOCUS_DOWN) {
2344            int indexToMakeVisible = numChildren - 1;
2345            if (nextSelectedPosition != INVALID_POSITION) {
2346                indexToMakeVisible = nextSelectedPosition - mFirstPosition;
2347            }
2348
2349            final int positionToMakeVisible = mFirstPosition + indexToMakeVisible;
2350            final View viewToMakeVisible = getChildAt(indexToMakeVisible);
2351
2352            int goalBottom = listBottom;
2353            if (positionToMakeVisible < mItemCount - 1) {
2354                goalBottom -= getArrowScrollPreviewLength();
2355            }
2356
2357            if (viewToMakeVisible.getBottom() <= goalBottom) {
2358                // item is fully visible.
2359                return 0;
2360            }
2361
2362            if (nextSelectedPosition != INVALID_POSITION
2363                    && (goalBottom - viewToMakeVisible.getTop()) >= getMaxScrollAmount()) {
2364                // item already has enough of it visible, changing selection is good enough
2365                return 0;
2366            }
2367
2368            int amountToScroll = (viewToMakeVisible.getBottom() - goalBottom);
2369
2370            if ((mFirstPosition + numChildren) == mItemCount) {
2371                // last is last in list -> make sure we don't scroll past it
2372                final int max = getChildAt(numChildren - 1).getBottom() - listBottom;
2373                amountToScroll = Math.min(amountToScroll, max);
2374            }
2375
2376            return Math.min(amountToScroll, getMaxScrollAmount());
2377        } else {
2378            int indexToMakeVisible = 0;
2379            if (nextSelectedPosition != INVALID_POSITION) {
2380                indexToMakeVisible = nextSelectedPosition - mFirstPosition;
2381            }
2382            final int positionToMakeVisible = mFirstPosition + indexToMakeVisible;
2383            final View viewToMakeVisible = getChildAt(indexToMakeVisible);
2384            int goalTop = listTop;
2385            if (positionToMakeVisible > 0) {
2386                goalTop += getArrowScrollPreviewLength();
2387            }
2388            if (viewToMakeVisible.getTop() >= goalTop) {
2389                // item is fully visible.
2390                return 0;
2391            }
2392
2393            if (nextSelectedPosition != INVALID_POSITION &&
2394                    (viewToMakeVisible.getBottom() - goalTop) >= getMaxScrollAmount()) {
2395                // item already has enough of it visible, changing selection is good enough
2396                return 0;
2397            }
2398
2399            int amountToScroll = (goalTop - viewToMakeVisible.getTop());
2400            if (mFirstPosition == 0) {
2401                // first is first in list -> make sure we don't scroll past it
2402                final int max = listTop - getChildAt(0).getTop();
2403                amountToScroll = Math.min(amountToScroll,  max);
2404            }
2405            return Math.min(amountToScroll, getMaxScrollAmount());
2406        }
2407    }
2408
2409    /**
2410     * Holds results of focus aware arrow scrolling.
2411     */
2412    static private class ArrowScrollFocusResult {
2413        private int mSelectedPosition;
2414        private int mAmountToScroll;
2415
2416        /**
2417         * How {@link android.widget.ListView#arrowScrollFocused} returns its values.
2418         */
2419        void populate(int selectedPosition, int amountToScroll) {
2420            mSelectedPosition = selectedPosition;
2421            mAmountToScroll = amountToScroll;
2422        }
2423
2424        public int getSelectedPosition() {
2425            return mSelectedPosition;
2426        }
2427
2428        public int getAmountToScroll() {
2429            return mAmountToScroll;
2430        }
2431    }
2432
2433    /**
2434     * @param direction either {@link android.view.View#FOCUS_UP} or
2435     *        {@link android.view.View#FOCUS_DOWN}.
2436     * @return The position of the next selectable position of the views that
2437     *         are currently visible, taking into account the fact that there might
2438     *         be no selection.  Returns {@link #INVALID_POSITION} if there is no
2439     *         selectable view on screen in the given direction.
2440     */
2441    private int lookForSelectablePositionOnScreen(int direction) {
2442        final int firstPosition = mFirstPosition;
2443        if (direction == View.FOCUS_DOWN) {
2444            int startPos = (mSelectedPosition != INVALID_POSITION) ?
2445                    mSelectedPosition + 1 :
2446                    firstPosition;
2447            if (startPos >= mAdapter.getCount()) {
2448                return INVALID_POSITION;
2449            }
2450            if (startPos < firstPosition) {
2451                startPos = firstPosition;
2452            }
2453
2454            final int lastVisiblePos = getLastVisiblePosition();
2455            final ListAdapter adapter = getAdapter();
2456            for (int pos = startPos; pos <= lastVisiblePos; pos++) {
2457                if (adapter.isEnabled(pos)
2458                        && getChildAt(pos - firstPosition).getVisibility() == View.VISIBLE) {
2459                    return pos;
2460                }
2461            }
2462        } else {
2463            int last = firstPosition + getChildCount() - 1;
2464            int startPos = (mSelectedPosition != INVALID_POSITION) ?
2465                    mSelectedPosition - 1 :
2466                    firstPosition + getChildCount() - 1;
2467            if (startPos < 0) {
2468                return INVALID_POSITION;
2469            }
2470            if (startPos > last) {
2471                startPos = last;
2472            }
2473
2474            final ListAdapter adapter = getAdapter();
2475            for (int pos = startPos; pos >= firstPosition; pos--) {
2476                if (adapter.isEnabled(pos)
2477                        && getChildAt(pos - firstPosition).getVisibility() == View.VISIBLE) {
2478                    return pos;
2479                }
2480            }
2481        }
2482        return INVALID_POSITION;
2483    }
2484
2485    /**
2486     * Do an arrow scroll based on focus searching.  If a new view is
2487     * given focus, return the selection delta and amount to scroll via
2488     * an {@link ArrowScrollFocusResult}, otherwise, return null.
2489     *
2490     * @param direction either {@link android.view.View#FOCUS_UP} or
2491     *        {@link android.view.View#FOCUS_DOWN}.
2492     * @return The result if focus has changed, or <code>null</code>.
2493     */
2494    private ArrowScrollFocusResult arrowScrollFocused(final int direction) {
2495        final View selectedView = getSelectedView();
2496        View newFocus;
2497        if (selectedView != null && selectedView.hasFocus()) {
2498            View oldFocus = selectedView.findFocus();
2499            newFocus = FocusFinder.getInstance().findNextFocus(this, oldFocus, direction);
2500        } else {
2501            if (direction == View.FOCUS_DOWN) {
2502                final boolean topFadingEdgeShowing = (mFirstPosition > 0);
2503                final int listTop = mListPadding.top +
2504                        (topFadingEdgeShowing ? getArrowScrollPreviewLength() : 0);
2505                final int ySearchPoint =
2506                        (selectedView != null && selectedView.getTop() > listTop) ?
2507                                selectedView.getTop() :
2508                                listTop;
2509                mTempRect.set(0, ySearchPoint, 0, ySearchPoint);
2510            } else {
2511                final boolean bottomFadingEdgeShowing =
2512                        (mFirstPosition + getChildCount() - 1) < mItemCount;
2513                final int listBottom = getHeight() - mListPadding.bottom -
2514                        (bottomFadingEdgeShowing ? getArrowScrollPreviewLength() : 0);
2515                final int ySearchPoint =
2516                        (selectedView != null && selectedView.getBottom() < listBottom) ?
2517                                selectedView.getBottom() :
2518                                listBottom;
2519                mTempRect.set(0, ySearchPoint, 0, ySearchPoint);
2520            }
2521            newFocus = FocusFinder.getInstance().findNextFocusFromRect(this, mTempRect, direction);
2522        }
2523
2524        if (newFocus != null) {
2525            final int positionOfNewFocus = positionOfNewFocus(newFocus);
2526
2527            // if the focus change is in a different new position, make sure
2528            // we aren't jumping over another selectable position
2529            if (mSelectedPosition != INVALID_POSITION && positionOfNewFocus != mSelectedPosition) {
2530                final int selectablePosition = lookForSelectablePositionOnScreen(direction);
2531                if (selectablePosition != INVALID_POSITION &&
2532                        ((direction == View.FOCUS_DOWN && selectablePosition < positionOfNewFocus) ||
2533                        (direction == View.FOCUS_UP && selectablePosition > positionOfNewFocus))) {
2534                    return null;
2535                }
2536            }
2537
2538            int focusScroll = amountToScrollToNewFocus(direction, newFocus, positionOfNewFocus);
2539
2540            final int maxScrollAmount = getMaxScrollAmount();
2541            if (focusScroll < maxScrollAmount) {
2542                // not moving too far, safe to give next view focus
2543                newFocus.requestFocus(direction);
2544                mArrowScrollFocusResult.populate(positionOfNewFocus, focusScroll);
2545                return mArrowScrollFocusResult;
2546            } else if (distanceToView(newFocus) < maxScrollAmount){
2547                // Case to consider:
2548                // too far to get entire next focusable on screen, but by going
2549                // max scroll amount, we are getting it at least partially in view,
2550                // so give it focus and scroll the max ammount.
2551                newFocus.requestFocus(direction);
2552                mArrowScrollFocusResult.populate(positionOfNewFocus, maxScrollAmount);
2553                return mArrowScrollFocusResult;
2554            }
2555        }
2556        return null;
2557    }
2558
2559    /**
2560     * @param newFocus The view that would have focus.
2561     * @return the position that contains newFocus
2562     */
2563    private int positionOfNewFocus(View newFocus) {
2564        final int numChildren = getChildCount();
2565        for (int i = 0; i < numChildren; i++) {
2566            final View child = getChildAt(i);
2567            if (isViewAncestorOf(newFocus, child)) {
2568                return mFirstPosition + i;
2569            }
2570        }
2571        throw new IllegalArgumentException("newFocus is not a child of any of the"
2572                + " children of the list!");
2573    }
2574
2575    /**
2576     * Return true if child is an ancestor of parent, (or equal to the parent).
2577     */
2578    private boolean isViewAncestorOf(View child, View parent) {
2579        if (child == parent) {
2580            return true;
2581        }
2582
2583        final ViewParent theParent = child.getParent();
2584        return (theParent instanceof ViewGroup) && isViewAncestorOf((View) theParent, parent);
2585    }
2586
2587    /**
2588     * Determine how much we need to scroll in order to get newFocus in view.
2589     * @param direction either {@link android.view.View#FOCUS_UP} or
2590     *        {@link android.view.View#FOCUS_DOWN}.
2591     * @param newFocus The view that would take focus.
2592     * @param positionOfNewFocus The position of the list item containing newFocus
2593     * @return The amount to scroll.  Note: this is always positive!  Direction
2594     *   needs to be taken into account when actually scrolling.
2595     */
2596    private int amountToScrollToNewFocus(int direction, View newFocus, int positionOfNewFocus) {
2597        int amountToScroll = 0;
2598        newFocus.getDrawingRect(mTempRect);
2599        offsetDescendantRectToMyCoords(newFocus, mTempRect);
2600        if (direction == View.FOCUS_UP) {
2601            if (mTempRect.top < mListPadding.top) {
2602                amountToScroll = mListPadding.top - mTempRect.top;
2603                if (positionOfNewFocus > 0) {
2604                    amountToScroll += getArrowScrollPreviewLength();
2605                }
2606            }
2607        } else {
2608            final int listBottom = getHeight() - mListPadding.bottom;
2609            if (mTempRect.bottom > listBottom) {
2610                amountToScroll = mTempRect.bottom - listBottom;
2611                if (positionOfNewFocus < mItemCount - 1) {
2612                    amountToScroll += getArrowScrollPreviewLength();
2613                }
2614            }
2615        }
2616        return amountToScroll;
2617    }
2618
2619    /**
2620     * Determine the distance to the nearest edge of a view in a particular
2621     * direciton.
2622     * @param descendant A descendant of this list.
2623     * @return The distance, or 0 if the nearest edge is already on screen.
2624     */
2625    private int distanceToView(View descendant) {
2626        int distance = 0;
2627        descendant.getDrawingRect(mTempRect);
2628        offsetDescendantRectToMyCoords(descendant, mTempRect);
2629        final int listBottom = mBottom - mTop - mListPadding.bottom;
2630        if (mTempRect.bottom < mListPadding.top) {
2631            distance = mListPadding.top - mTempRect.bottom;
2632        } else if (mTempRect.top > listBottom) {
2633            distance = mTempRect.top - listBottom;
2634        }
2635        return distance;
2636    }
2637
2638
2639    /**
2640     * Scroll the children by amount, adding a view at the end and removing
2641     * views that fall off as necessary.
2642     *
2643     * @param amount The amount (positive or negative) to scroll.
2644     */
2645    private void scrollListItemsBy(int amount) {
2646        offsetChildrenTopAndBottom(amount);
2647
2648        final int listBottom = getHeight() - mListPadding.bottom;
2649        final int listTop = mListPadding.top;
2650        final AbsListView.RecycleBin recycleBin = mRecycler;
2651
2652        if (amount < 0) {
2653            // shifted items up
2654
2655            // may need to pan views into the bottom space
2656            int numChildren = getChildCount();
2657            View last = getChildAt(numChildren - 1);
2658            while (last.getBottom() < listBottom) {
2659                final int lastVisiblePosition = mFirstPosition + numChildren - 1;
2660                if (lastVisiblePosition < mItemCount - 1) {
2661                    last = addViewBelow(last, lastVisiblePosition);
2662                    numChildren++;
2663                } else {
2664                    break;
2665                }
2666            }
2667
2668            // may have brought in the last child of the list that is skinnier
2669            // than the fading edge, thereby leaving space at the end.  need
2670            // to shift back
2671            if (last.getBottom() < listBottom) {
2672                offsetChildrenTopAndBottom(listBottom - last.getBottom());
2673            }
2674
2675            // top views may be panned off screen
2676            View first = getChildAt(0);
2677            while (first.getBottom() < listTop) {
2678                AbsListView.LayoutParams layoutParams = (LayoutParams) first.getLayoutParams();
2679                if (recycleBin.shouldRecycleViewType(layoutParams.viewType)) {
2680                    removeViewInLayout(first);
2681                    recycleBin.addScrapView(first);
2682                } else {
2683                    detachViewFromParent(first);
2684                }
2685                first = getChildAt(0);
2686                mFirstPosition++;
2687            }
2688        } else {
2689            // shifted items down
2690            View first = getChildAt(0);
2691
2692            // may need to pan views into top
2693            while ((first.getTop() > listTop) && (mFirstPosition > 0)) {
2694                first = addViewAbove(first, mFirstPosition);
2695                mFirstPosition--;
2696            }
2697
2698            // may have brought the very first child of the list in too far and
2699            // need to shift it back
2700            if (first.getTop() > listTop) {
2701                offsetChildrenTopAndBottom(listTop - first.getTop());
2702            }
2703
2704            int lastIndex = getChildCount() - 1;
2705            View last = getChildAt(lastIndex);
2706
2707            // bottom view may be panned off screen
2708            while (last.getTop() > listBottom) {
2709                AbsListView.LayoutParams layoutParams = (LayoutParams) last.getLayoutParams();
2710                if (recycleBin.shouldRecycleViewType(layoutParams.viewType)) {
2711                    removeViewInLayout(last);
2712                    recycleBin.addScrapView(last);
2713                } else {
2714                    detachViewFromParent(last);
2715                }
2716                last = getChildAt(--lastIndex);
2717            }
2718        }
2719    }
2720
2721    private View addViewAbove(View theView, int position) {
2722        int abovePosition = position - 1;
2723        View view = obtainView(abovePosition);
2724        int edgeOfNewChild = theView.getTop() - mDividerHeight;
2725        setupChild(view, abovePosition, edgeOfNewChild, false, mListPadding.left, false, false);
2726        return view;
2727    }
2728
2729    private View addViewBelow(View theView, int position) {
2730        int belowPosition = position + 1;
2731        View view = obtainView(belowPosition);
2732        int edgeOfNewChild = theView.getBottom() + mDividerHeight;
2733        setupChild(view, belowPosition, edgeOfNewChild, true, mListPadding.left, false, false);
2734        return view;
2735    }
2736
2737    /**
2738     * Indicates that the views created by the ListAdapter can contain focusable
2739     * items.
2740     *
2741     * @param itemsCanFocus true if items can get focus, false otherwise
2742     */
2743    public void setItemsCanFocus(boolean itemsCanFocus) {
2744        mItemsCanFocus = itemsCanFocus;
2745        if (!itemsCanFocus) {
2746            setDescendantFocusability(ViewGroup.FOCUS_BLOCK_DESCENDANTS);
2747        }
2748    }
2749
2750    /**
2751     * @return Whether the views created by the ListAdapter can contain focusable
2752     * items.
2753     */
2754    public boolean getItemsCanFocus() {
2755        return mItemsCanFocus;
2756    }
2757
2758    @Override
2759    protected void dispatchDraw(Canvas canvas) {
2760        // Draw the dividers
2761        final int dividerHeight = mDividerHeight;
2762
2763        if (dividerHeight > 0 && mDivider != null) {
2764            // Only modify the top and bottom in the loop, we set the left and right here
2765            final Rect bounds = mTempRect;
2766            bounds.left = mPaddingLeft;
2767            bounds.right = mRight - mLeft - mPaddingRight;
2768
2769            final int count = getChildCount();
2770            final int headerCount = mHeaderViewInfos.size();
2771            final int footerLimit = mItemCount - mFooterViewInfos.size() - 1;
2772            final boolean headerDividers = mHeaderDividersEnabled;
2773            final boolean footerDividers = mFooterDividersEnabled;
2774            final int first = mFirstPosition;
2775            final boolean areAllItemsSelectable = mAreAllItemsSelectable;
2776            final ListAdapter adapter = mAdapter;
2777
2778            if (!mStackFromBottom) {
2779                int bottom;
2780                int listBottom = mBottom - mTop - mListPadding.bottom;
2781
2782                for (int i = 0; i < count; i++) {
2783                    if ((headerDividers || first + i >= headerCount) &&
2784                            (footerDividers || first + i < footerLimit)) {
2785                        View child = getChildAt(i);
2786                        bottom = child.getBottom();
2787                        // Don't draw dividers next to items that are not enabled
2788                        if (bottom < listBottom && (areAllItemsSelectable ||
2789                                (adapter.isEnabled(first + i) && (i == count - 1 ||
2790                                        adapter.isEnabled(first + i + 1))))) {
2791                            bounds.top = bottom;
2792                            bounds.bottom = bottom + dividerHeight;
2793                            drawDivider(canvas, bounds, i);
2794                        }
2795                    }
2796                }
2797            } else {
2798                int top;
2799                int listTop = mListPadding.top;
2800
2801                for (int i = 0; i < count; i++) {
2802                    if ((headerDividers || first + i >= headerCount) &&
2803                            (footerDividers || first + i < footerLimit)) {
2804                        View child = getChildAt(i);
2805                        top = child.getTop();
2806                        // Don't draw dividers next to items that are not enabled
2807                        if (top > listTop && (areAllItemsSelectable ||
2808                                (adapter.isEnabled(first + i) && (i == count - 1 ||
2809                                        adapter.isEnabled(first + i + 1))))) {
2810                            bounds.top = top - dividerHeight;
2811                            bounds.bottom = top;
2812                            // Give the method the child ABOVE the divider, so we
2813                            // subtract one from our child
2814                            // position. Give -1 when there is no child above the
2815                            // divider.
2816                            drawDivider(canvas, bounds, i - 1);
2817                        }
2818                    }
2819                }
2820            }
2821        }
2822
2823        // Draw the indicators (these should be drawn above the dividers) and children
2824        super.dispatchDraw(canvas);
2825    }
2826
2827    /**
2828     * Draws a divider for the given child in the given bounds.
2829     *
2830     * @param canvas The canvas to draw to.
2831     * @param bounds The bounds of the divider.
2832     * @param childIndex The index of child (of the View) above the divider.
2833     *            This will be -1 if there is no child above the divider to be
2834     *            drawn.
2835     */
2836    void drawDivider(Canvas canvas, Rect bounds, int childIndex) {
2837        // This widget draws the same divider for all children
2838        final Drawable divider = mDivider;
2839        final boolean clipDivider = mClipDivider;
2840
2841        if (!clipDivider) {
2842            divider.setBounds(bounds);
2843        } else {
2844            canvas.save();
2845            canvas.clipRect(bounds);
2846        }
2847
2848        divider.draw(canvas);
2849
2850        if (clipDivider) {
2851            canvas.restore();
2852        }
2853    }
2854
2855    /**
2856     * Returns the drawable that will be drawn between each item in the list.
2857     *
2858     * @return the current drawable drawn between list elements
2859     */
2860    public Drawable getDivider() {
2861        return mDivider;
2862    }
2863
2864    /**
2865     * Sets the drawable that will be drawn between each item in the list. If the drawable does
2866     * not have an intrinsic height, you should also call {@link #setDividerHeight(int)}
2867     *
2868     * @param divider The drawable to use.
2869     */
2870    public void setDivider(Drawable divider) {
2871        if (divider != null) {
2872            mDividerHeight = divider.getIntrinsicHeight();
2873            mClipDivider = divider instanceof ColorDrawable;
2874        } else {
2875            mDividerHeight = 0;
2876            mClipDivider = false;
2877        }
2878        mDivider = divider;
2879        requestLayoutIfNecessary();
2880    }
2881
2882    /**
2883     * @return Returns the height of the divider that will be drawn between each item in the list.
2884     */
2885    public int getDividerHeight() {
2886        return mDividerHeight;
2887    }
2888
2889    /**
2890     * Sets the height of the divider that will be drawn between each item in the list. Calling
2891     * this will override the intrinsic height as set by {@link #setDivider(Drawable)}
2892     *
2893     * @param height The new height of the divider in pixels.
2894     */
2895    public void setDividerHeight(int height) {
2896        mDividerHeight = height;
2897        requestLayoutIfNecessary();
2898    }
2899
2900    /**
2901     * Enables or disables the drawing of the divider for header views.
2902     *
2903     * @param headerDividersEnabled True to draw the headers, false otherwise.
2904     *
2905     * @see #setFooterDividersEnabled(boolean)
2906     * @see #addHeaderView(android.view.View)
2907     */
2908    public void setHeaderDividersEnabled(boolean headerDividersEnabled) {
2909        mHeaderDividersEnabled = headerDividersEnabled;
2910        invalidate();
2911    }
2912
2913    /**
2914     * Enables or disables the drawing of the divider for footer views.
2915     *
2916     * @param footerDividersEnabled True to draw the footers, false otherwise.
2917     *
2918     * @see #setHeaderDividersEnabled(boolean)
2919     * @see #addFooterView(android.view.View)
2920     */
2921    public void setFooterDividersEnabled(boolean footerDividersEnabled) {
2922        mFooterDividersEnabled = footerDividersEnabled;
2923        invalidate();
2924    }
2925
2926    @Override
2927    protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
2928        super.onFocusChanged(gainFocus, direction, previouslyFocusedRect);
2929
2930        int closetChildIndex = -1;
2931        if (gainFocus && previouslyFocusedRect != null) {
2932            previouslyFocusedRect.offset(mScrollX, mScrollY);
2933
2934            // figure out which item should be selected based on previously
2935            // focused rect
2936            Rect otherRect = mTempRect;
2937            int minDistance = Integer.MAX_VALUE;
2938            final int childCount = getChildCount();
2939            final int firstPosition = mFirstPosition;
2940            final ListAdapter adapter = mAdapter;
2941
2942            for (int i = 0; i < childCount; i++) {
2943                // only consider selectable views
2944                if (!adapter.isEnabled(firstPosition + i)) {
2945                    continue;
2946                }
2947
2948                View other = getChildAt(i);
2949                other.getDrawingRect(otherRect);
2950                offsetDescendantRectToMyCoords(other, otherRect);
2951                int distance = getDistance(previouslyFocusedRect, otherRect, direction);
2952
2953                if (distance < minDistance) {
2954                    minDistance = distance;
2955                    closetChildIndex = i;
2956                }
2957            }
2958        }
2959
2960        if (closetChildIndex >= 0) {
2961            setSelection(closetChildIndex + mFirstPosition);
2962        } else {
2963            requestLayout();
2964        }
2965    }
2966
2967
2968    /*
2969     * (non-Javadoc)
2970     *
2971     * Children specified in XML are assumed to be header views. After we have
2972     * parsed them move them out of the children list and into mHeaderViews.
2973     */
2974    @Override
2975    protected void onFinishInflate() {
2976        super.onFinishInflate();
2977
2978        int count = getChildCount();
2979        if (count > 0) {
2980            for (int i = 0; i < count; ++i) {
2981                addHeaderView(getChildAt(i));
2982            }
2983            removeAllViews();
2984        }
2985    }
2986
2987    /* (non-Javadoc)
2988     * @see android.view.View#findViewById(int)
2989     * First look in our children, then in any header and footer views that may be scrolled off.
2990     */
2991    @Override
2992    protected View findViewTraversal(int id) {
2993        View v;
2994        v = super.findViewTraversal(id);
2995        if (v == null) {
2996            v = findViewInHeadersOrFooters(mHeaderViewInfos, id);
2997            if (v != null) {
2998                return v;
2999            }
3000            v = findViewInHeadersOrFooters(mFooterViewInfos, id);
3001            if (v != null) {
3002                return v;
3003            }
3004        }
3005        return v;
3006    }
3007
3008    /* (non-Javadoc)
3009     *
3010     * Look in the passed in list of headers or footers for the view.
3011     */
3012    View findViewInHeadersOrFooters(ArrayList<FixedViewInfo> where, int id) {
3013        if (where != null) {
3014            int len = where.size();
3015            View v;
3016
3017            for (int i = 0; i < len; i++) {
3018                v = where.get(i).view;
3019
3020                if (!v.isRootNamespace()) {
3021                    v = v.findViewById(id);
3022
3023                    if (v != null) {
3024                        return v;
3025                    }
3026                }
3027            }
3028        }
3029        return null;
3030    }
3031
3032    /* (non-Javadoc)
3033     * @see android.view.View#findViewWithTag(String)
3034     * First look in our children, then in any header and footer views that may be scrolled off.
3035     */
3036    @Override
3037    protected View findViewWithTagTraversal(Object tag) {
3038        View v;
3039        v = super.findViewWithTagTraversal(tag);
3040        if (v == null) {
3041            v = findViewTagInHeadersOrFooters(mHeaderViewInfos, tag);
3042            if (v != null) {
3043                return v;
3044            }
3045
3046            v = findViewTagInHeadersOrFooters(mFooterViewInfos, tag);
3047            if (v != null) {
3048                return v;
3049            }
3050        }
3051        return v;
3052    }
3053
3054    /* (non-Javadoc)
3055     *
3056     * Look in the passed in list of headers or footers for the view with the tag.
3057     */
3058    View findViewTagInHeadersOrFooters(ArrayList<FixedViewInfo> where, Object tag) {
3059        if (where != null) {
3060            int len = where.size();
3061            View v;
3062
3063            for (int i = 0; i < len; i++) {
3064                v = where.get(i).view;
3065
3066                if (!v.isRootNamespace()) {
3067                    v = v.findViewWithTag(tag);
3068
3069                    if (v != null) {
3070                        return v;
3071                    }
3072                }
3073            }
3074        }
3075        return null;
3076    }
3077
3078    @Override
3079    public boolean onTouchEvent(MotionEvent ev) {
3080        if (mItemsCanFocus && ev.getAction() == MotionEvent.ACTION_DOWN && ev.getEdgeFlags() != 0) {
3081            // Don't handle edge touches immediately -- they may actually belong to one of our
3082            // descendants.
3083            return false;
3084        }
3085        return super.onTouchEvent(ev);
3086    }
3087
3088    /**
3089     * @see #setChoiceMode(int)
3090     *
3091     * @return The current choice mode
3092     */
3093    public int getChoiceMode() {
3094        return mChoiceMode;
3095    }
3096
3097    /**
3098     * Defines the choice behavior for the List. By default, Lists do not have any choice behavior
3099     * ({@link #CHOICE_MODE_NONE}). By setting the choiceMode to {@link #CHOICE_MODE_SINGLE}, the
3100     * List allows up to one item to  be in a chosen state. By setting the choiceMode to
3101     * {@link #CHOICE_MODE_MULTIPLE}, the list allows any number of items to be chosen.
3102     *
3103     * @param choiceMode One of {@link #CHOICE_MODE_NONE}, {@link #CHOICE_MODE_SINGLE}, or
3104     * {@link #CHOICE_MODE_MULTIPLE}
3105     */
3106    public void setChoiceMode(int choiceMode) {
3107        mChoiceMode = choiceMode;
3108        if (mChoiceMode != CHOICE_MODE_NONE && mCheckStates == null) {
3109            mCheckStates = new SparseBooleanArray();
3110        }
3111    }
3112
3113    @Override
3114    public boolean performItemClick(View view, int position, long id) {
3115        boolean handled = false;
3116
3117        if (mChoiceMode != CHOICE_MODE_NONE) {
3118            handled = true;
3119
3120            if (mChoiceMode == CHOICE_MODE_MULTIPLE) {
3121                boolean oldValue = mCheckStates.get(position, false);
3122                mCheckStates.put(position, !oldValue);
3123            } else {
3124                boolean oldValue = mCheckStates.get(position, false);
3125                if (!oldValue) {
3126                    mCheckStates.clear();
3127                    mCheckStates.put(position, true);
3128                }
3129            }
3130
3131            mDataChanged = true;
3132            rememberSyncState();
3133            requestLayout();
3134        }
3135
3136        handled |= super.performItemClick(view, position, id);
3137
3138        return handled;
3139    }
3140
3141    /**
3142     * Sets the checked state of the specified position. The is only valid if
3143     * the choice mode has been set to {@link #CHOICE_MODE_SINGLE} or
3144     * {@link #CHOICE_MODE_MULTIPLE}.
3145     *
3146     * @param position The item whose checked state is to be checked
3147     * @param value The new checked sate for the item
3148     */
3149    public void setItemChecked(int position, boolean value) {
3150        if (mChoiceMode == CHOICE_MODE_NONE) {
3151            return;
3152        }
3153
3154        if (mChoiceMode == CHOICE_MODE_MULTIPLE) {
3155            mCheckStates.put(position, value);
3156        } else {
3157            boolean oldValue = mCheckStates.get(position, false);
3158            mCheckStates.clear();
3159            if (!oldValue) {
3160                mCheckStates.put(position, true);
3161            }
3162        }
3163
3164        // Do not generate a data change while we are in the layout phase
3165        if (!mInLayout && !mBlockLayoutRequests) {
3166            mDataChanged = true;
3167            rememberSyncState();
3168            requestLayout();
3169        }
3170    }
3171
3172    /**
3173     * Returns the checked state of the specified position. The result is only
3174     * valid if the choice mode has not been set to {@link #CHOICE_MODE_SINGLE}
3175     * or {@link #CHOICE_MODE_MULTIPLE}.
3176     *
3177     * @param position The item whose checked state to return
3178     * @return The item's checked state
3179     *
3180     * @see #setChoiceMode(int)
3181     */
3182    public boolean isItemChecked(int position) {
3183        if (mChoiceMode != CHOICE_MODE_NONE && mCheckStates != null) {
3184            return mCheckStates.get(position);
3185        }
3186
3187        return false;
3188    }
3189
3190    /**
3191     * Returns the currently checked item. The result is only valid if the choice
3192     * mode has not been set to {@link #CHOICE_MODE_SINGLE}.
3193     *
3194     * @return The position of the currently checked item or
3195     *         {@link #INVALID_POSITION} if nothing is selected
3196     *
3197     * @see #setChoiceMode(int)
3198     */
3199    public int getCheckedItemPosition() {
3200        if (mChoiceMode == CHOICE_MODE_SINGLE && mCheckStates != null && mCheckStates.size() == 1) {
3201            return mCheckStates.keyAt(0);
3202        }
3203
3204        return INVALID_POSITION;
3205    }
3206
3207    /**
3208     * Returns the set of checked items in the list. The result is only valid if
3209     * the choice mode has not been set to {@link #CHOICE_MODE_SINGLE}.
3210     *
3211     * @return  A SparseBooleanArray which will return true for each call to
3212     *          get(int position) where position is a position in the list.
3213     */
3214    public SparseBooleanArray getCheckedItemPositions() {
3215        if (mChoiceMode != CHOICE_MODE_NONE) {
3216            return mCheckStates;
3217        }
3218        return null;
3219    }
3220
3221    /**
3222     * Clear any choices previously set
3223     */
3224    public void clearChoices() {
3225        if (mCheckStates != null) {
3226            mCheckStates.clear();
3227        }
3228    }
3229
3230    static class SavedState extends BaseSavedState {
3231        SparseBooleanArray checkState;
3232
3233        /**
3234         * Constructor called from {@link ListView#onSaveInstanceState()}
3235         */
3236        SavedState(Parcelable superState, SparseBooleanArray checkState) {
3237            super(superState);
3238            this.checkState = checkState;
3239        }
3240
3241        /**
3242         * Constructor called from {@link #CREATOR}
3243         */
3244        private SavedState(Parcel in) {
3245            super(in);
3246            checkState = in.readSparseBooleanArray();
3247        }
3248
3249        @Override
3250        public void writeToParcel(Parcel out, int flags) {
3251            super.writeToParcel(out, flags);
3252            out.writeSparseBooleanArray(checkState);
3253        }
3254
3255        @Override
3256        public String toString() {
3257            return "ListView.SavedState{"
3258                    + Integer.toHexString(System.identityHashCode(this))
3259                    + " checkState=" + checkState + "}";
3260        }
3261
3262        public static final Parcelable.Creator<SavedState> CREATOR
3263                = new Parcelable.Creator<SavedState>() {
3264            public SavedState createFromParcel(Parcel in) {
3265                return new SavedState(in);
3266            }
3267
3268            public SavedState[] newArray(int size) {
3269                return new SavedState[size];
3270            }
3271        };
3272    }
3273
3274    @Override
3275    public Parcelable onSaveInstanceState() {
3276        Parcelable superState = super.onSaveInstanceState();
3277        return new SavedState(superState, mCheckStates);
3278    }
3279
3280    @Override
3281    public void onRestoreInstanceState(Parcelable state) {
3282        SavedState ss = (SavedState) state;
3283
3284        super.onRestoreInstanceState(ss.getSuperState());
3285
3286        if (ss.checkState != null) {
3287           mCheckStates = ss.checkState;
3288        }
3289
3290    }
3291}
3292