Android - An Open Handset Alliance Project

android.widget.ListView

Summary

XML Attributes

Fields

Public Constructors

Public Methods

Protected Methods

Nested Classes

Known Direct Subclasses

XML Attributes inherited from class android.widget.AbsListView

XML Attributes inherited from class android.view.ViewGroup

XML Attributes inherited from class android.view.View

Constants inherited from class android.widget.AbsListView

Constants inherited from class android.widget.AdapterView

Constants inherited from class android.view.ViewGroup

Constants inherited from class android.view.View

Fields inherited from class android.widget.AbsListView

Fields inherited from class android.widget.AdapterView

Fields inherited from class android.view.ViewGroup

Fields inherited from class android.view.View

android.widget
public class

A view that shows items in a vertically scrolling list. The items come from the ListAdapter associated with this view.

Note: You cannot use the value wrap_content for the android:layout_height attribute of a ListView in XML if the parent's size is also not strictly specified (for example, if the parent were ScrollView you could not specify wrap_content since it also can be any length. However, you can use wrap_content if the ListView parent has a specific size, such as 100 pixels.

Also see ViewGroup.LayoutParams for layout attributes.

ListView.OnListViewScrollListener Interface definition for a callback to be invoked when either the number of visible elements change or the index of the first element changes.

ExpandableListView

Attribute name	Related methods
android:entries		Reference to an array resource that will populate the ListView.

Attribute name	Related methods
android:drawSelectorOnTop	setDrawSelectorOnTop(boolean)
android:listSelector	setSelector(int)

android:clipChildren, android:clipToPadding

Attribute name	Related methods
android:clipChildren	setClipChildren(boolean)	Defines whether a child is limited to draw inside of its bounds or not.
android:clipToPadding	setClipToPadding(boolean)	Defines whether the ViewGroup will clip its drawing surface so as to exclude the padding area.

Attribute name	Related methods
android:background	setBackground(int)	A drawable to use as the background.
android:clickable	setClickable(boolean)	Defines whether this view reacts to click events.
android:drawingCacheQuality	setDrawingCacheQuality(int)	Defines the quality of translucent drawing caches.
android:fadingEdge	setVerticalFadingEdgeEnabled(boolean)	Defines which edges should be fadeded on scrolling.
android:fadingEdgeLength	getVerticalFadingEdgeLength()	Defines the length of the fading edges.
android:fitStatusBar		Boolean internal attribute to adjust view layout based on the status bar location.
android:focusType	setFocusType(int)	Sets the circumstances under which this view will take focus.
android:focusable	setFocusable(boolean)	Boolean that controls whether a view can take focus.
android:focusableInTouchMode	setFocusableInTouchMode(boolean)	Boolean that controls whether a view can take focus while in touch mode.
android:freezeDisabled	setFreezeDisabled(boolean)	If set, no icicle will be saved for this view when it is being frozen.
android:id	setId(int)	Supply an identifier name for this view, to later retrieve it with View.findViewById() or Activity.findViewById().
android:nextFocusDown		Defines the next view to give focus to when the next focus is FOCUS_DOWN If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusLeft		Defines the next view to give focus to when the next focus is FOCUS_LEFT.
android:nextFocusRight		Defines the next view to give focus to when the next focus is FOCUS_RIGHT If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:nextFocusUp		Defines the next view to give focus to when the next focus is FOCUS_UP If the reference refers to a view that does not exist or is part of a hierarchy that is invisible, a RuntimeException will result when the reference is accessed.
android:padding	setPadding(int,int,int,int)	Sets the padding, in pixels, of all four edges.
android:paddingBottom	setPadding(int,int,int,int)	Sets the padding, in pixels, of the bottom edge; see padding.
android:paddingLeft	setPadding(int,int,int,int)	Sets the padding, in pixels, of the left edge; see padding.
android:paddingRight	setPadding(int,int,int,int)	Sets the padding, in pixels, of the right edge; see padding.
android:paddingTop	setPadding(int,int,int,int)	Sets the padding, in pixels, of the top edge; see padding.
android:scrollX		The initial horizontal scroll offset, in pixels.
android:scrollY		The initial vertical scroll offset, in pixels.
android:scrollbarDefaultDelayBeforeFade		Delay in milliseconds before the scrollbars disappear.
android:scrollbarFadeDuration		Duration in milliseconds of the fade when the scrollbars disappear.
android:scrollbarSize		Sets the width of vertical scrollbars and height of horizontal scrollbars.
android:scrollbarThumbHorizontal		Drawable for horizontal scrollbars' thumb.
android:scrollbarThumbVertical		Drawable for vertical scrollbars' thumb.
android:scrollbarTrackHorizontal		Drawable for horizontal scrollbars' track.
android:scrollbarTrackVertical		Drawable for vertical scrollbars' track.
android:scrollbars		Defines which scrollbars should be displayed on scrolling or not.
android:visibility	setVisibility(int)	Controls the initial visibility of the view.

			Value
int	LAYOUT_FORCE_BOTTOM	Show the last item	3	0x00000003
int	LAYOUT_FORCE_TOP	Show the first item	1	0x00000001
int	LAYOUT_MOVE_SELECTION	Layout as a result of using the navigation keys	7	0x00000007
int	LAYOUT_NORMAL	Regular layout	0	0x00000000
int	LAYOUT_SCROLL	Layout while tracking motion events	5	0x00000005
int	LAYOUT_SET_SELECTION	Force the selected item to be on screen	2	0x00000002
int	LAYOUT_SPECIFIC	Make a mSelectedItem appear in a specific location and build the rest of the views from there.	4	0x00000004
int	LAYOUT_SYNC	Layout to sync as a result of a data change	6	0x00000006
int	TOUCH_MODE_DONE_WAITING	Indicates we have waited for everything we can wait for, but the user's finger still down	2	0x00000002
int	TOUCH_MODE_DOWN	Indicates we just recieved the touch event and we are waiting to see if the it is a tap or a scroll gesture.	0	0x00000000
int	TOUCH_MODE_REST	Indicates that we are not in the middle of a touch gesture	-1	0xffffffff
int	TOUCH_MODE_SCROLL	Indicates the touch gesture is a scroll	3	0x00000003
int	TOUCH_MODE_TAP	Indicates the touch has been reconized as a tap and we are now waiting to see if the touch is a longpress	1	0x00000001

			Value
int	SYNC_FIRST_POSITION	Sync based on the first row	1	0x00000001
int	SYNC_MAX_DURATION_MILLIS	Maximum amount of time to spend in findSyncPosition()	100	0x00000064
int	SYNC_SELECTED_POSITION	Sync based on the selected row	0	0x00000000

FLAG_SUPPORT_STATIC_TRANSFORMATIONS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

			Value
int	FLAG_SUPPORT_STATIC_TRANSFORMATIONS	When set, this ViewGroup supports static transformations on children; this causes getChildStaticTransformation(View, android.view.animation.Transformation) to be invoked when a child is drawn.	2048	0x00000800
int	PERSISTENT_ALL_CACHES	Used to indicate that all drawing caches should be kept in memory.	3	0x00000003
int	PERSISTENT_ANIMATION_CACHE	Used to indicate that the animation drawing cache should be kept in memory.	1	0x00000001
int	PERSISTENT_NO_CACHE	Used to indicate that no drawing cache should be kept in memory.	0	0x00000000
int	PERSISTENT_SCROLLING_CACHE	Used to indicate that the scrolling drawing cache should be kept in memory.	2	0x00000002

DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, GONE, INVISIBLE, NORMAL_FOCUS, NO_ID, VIEW_LOG_TAG, VISIBLE, WEAK_FOCUS

			Value
int	DRAWING_CACHE_QUALITY_AUTO	Enables automatic quality mode for the drawing cache.	0	0x00000000
int	DRAWING_CACHE_QUALITY_HIGH	Enables high quality mode for the drawing cache.	1048576	0x00100000
int	DRAWING_CACHE_QUALITY_LOW	Enables low quality mode for the drawing cache.	524288	0x00080000
int	FOCUS_BACKWARD	Use with focusSearch(int).	1	0x00000001
int	FOCUS_DOWN	Use with focusSearch(int).	130	0x00000082
int	FOCUS_FORWARD	Use with focusSearch(int).	2	0x00000002
int	FOCUS_LEFT	Use with focusSearch(int).	17	0x00000011
int	FOCUS_RIGHT	Use with focusSearch(int).	66	0x00000042
int	FOCUS_UP	Use with focusSearch(int).	33	0x00000021
int	GONE	This view is invisible, and it doesn't take any space for layout purposes.	8	0x00000008
int	INVISIBLE	This view is invisible, but it still takes up space for layout purposes.	4	0x00000004
int	NORMAL_FOCUS	This view wants keystrokes.	0	0x00000000
int	NO_ID	Used to mark a View that has no ID.	-1	0xffffffff
String	VIEW_LOG_TAG	The logging tag used by this class with android.util.Log.	"View"
int	VISIBLE	This view is visible.	0	0x00000000
int	WEAK_FOCUS	This view wants keystrokes, but only if none of its children has focus.	2	0x00000002

protected			Drawable	mDivider
protected			int	mDividerHeight

protected	ListAdapter	mAdapter	The adapter containing the data to be displayed by this view
protected	boolean	mBlockLayoutRequests	When set to true, calls to requestLayout() will not propagate up the parent hierarchy.
protected	boolean	mCachingStarted	When the view is scrolling, this flag is set to true to indicate subclasses that the drawing cache was enabled on the children
protected	DataSetObserver	mDataSetObserver	Should be used by subclasses to listen to changes in the dataset
protected	boolean	mDrawSelectorOnTop	Indicates whether the list selector should be drawn on top of the children or behind
protected	long	mLastSelectedRowID	Indicates the ID (from the adapter) of the last selected element.
protected	int	mLastY	Y value from on the previous motion event (if any)
protected	int	mLayoutMode	Controls how the next layout will happen
protected	Rect	mListPadding	This view's padding
protected	int	mMotionCorrection	How far the finger moved before we started scrolling
protected	int	mMotionPosition	The position of the view that received the down motion event
protected	int	mMotionViewNewTop	The desired offset to the top of the mMotionPosition view after a scroll
protected	int	mMotionViewOriginalTop	The offset to the top of the mMotionPosition view when the down motion event was received
protected	int	mMotionX	The X value associated with the the down motion event
protected	int	mMotionY	The Y value associated with the the down motion event
protected	RecycleBin	mRecycler	The data set used to store unused views that should be reused during the next layout to avoid creating new ones
protected	View	mScrollDown	The down scroll indicator
protected	View	mScrollUp	The top scroll indicator
protected	boolean	mScrollingCacheEnabled	When set to true, the list automatically discards the children's bitmap cache after scrolling.
protected	int	mSelectedTop	The offset in pixels form the top of the AdapterView to the top of the currently selected view.
protected	int	mSelectionBottomPadding	The selection's bottom padding
protected	int	mSelectionLeftPadding	The selection's left padding
protected	int	mSelectionRightPadding	The selection's right padding
protected	int	mSelectionTopPadding	The selection's top padding
protected	Drawable	mSelector	The drawable used to draw the selector
protected	Rect	mSelectorRect	Defines the selector's location and dimension at drawing time
protected	boolean	mStackFromBottom	Indicates whether the list is stacked from the bottom edge or the top edge.
protected	int	mTouchMode	One of TOUCH_MODE_REST, TOUCH_MODE_DOWN, TOUCH_MODE_TAP, TOUCH_MODE_SCROLL, or TOUCH_MODE_DONE_WAITING
protected	int	mWidthMeasureSpec	Subclasses must retain their measure spec from onMeasure() into this member

protected	boolean	mDataChanged	True if the data has changed since the last layout
protected	View	mEmptyView	View to show if there is nothing in the list
protected	int	mFirstPosition	The position of the first child displayed
protected	boolean	mInLayout
protected	int	mItemCount
protected	boolean	mNeedSync	True if we need to sync to mSyncRowId
protected	int	mNextSelectedPosition	The index within the adapter's data set of the item to select during the next layout.
protected	long	mNextSelectedRowId	The item id of the item to select during the next layout.
protected	OnItemClickListener	mOnItemClickListener
protected	OnItemLongClickListener	mOnItemLongClickListener
protected	OnItemSelectedListener	mOnItemSelectedListener
protected	int	mSelectedPosition	The index within the adapter's data set of the currently selected item.
protected	long	mSelectedRowId	The item id of the currently selected item.
protected	int	mSpecificTop	The offset in pixels form the top of the AdapterView to the top of the view to select during the next layout.
protected	int	mSyncMode	Indicates whether to sync based on the selection or position
protected	int	mSyncPosition	Position from which to start looking for mSyncRowId
protected	long	mSyncRowId	Row id to look for when data has changed

mDisappearingChildren, mGroupFlags, mOnHierarchyChangeListener, mPersistentDrawingCache

mBottom, mContext, mLayoutParams, mLeft, mLocation, mOnClickListener, mOnFocusChangeListener, mOnLongClickListener, mOnPopulateContextMenuListener, mPaddingBottom, mPaddingLeft, mPaddingRight, mPaddingTop, mParent, mRight, mScrollX, mScrollY, mTag, mTop

protected		int	mBottom	The distance in pixels from the top edge of this view's parent to the bottom edge of this view.
protected		Context	mContext	The application environment this view lives in.
protected		LayoutParams	mLayoutParams	The layout parameters associated with this view and used by the parent ViewGroup to determine how this view should be laid out.
protected		int	mLeft	The distance in pixels from the left edge of this view's parent to the left edge of this view.
protected	final	int[]	mLocation	Used to store a pair of coordinates, for instance returned values returned by getLocationInWindow(int[]).
protected		OnClickListener	mOnClickListener	Listener used to dispatch click events.
protected		OnFocusChangeListener	mOnFocusChangeListener	Listener used to dispatch focus change events.
protected		OnLongClickListener	mOnLongClickListener	Listener used to dispatch long click events.
protected		OnPopulateContextMenuListener	mOnPopulateContextMenuListener	Listener used to build the context menu.
protected		int	mPaddingBottom	The bottom padding in pixels, that is the distance in pixels between the bottom edge of this view and the bottom edge of its content.
protected		int	mPaddingLeft	The left padding in pixels, that is the distance in pixels between the left edge of this view and the left edge of its content.
protected		int	mPaddingRight	The right padding in pixels, that is the distance in pixels between the right edge of this view and the right edge of its content.
protected		int	mPaddingTop	The top padding in pixels, that is the distance in pixels between the top edge of this view and the top edge of its content.
protected		ViewParent	mParent	The parent this view is attached to.
protected		int	mRight	The distance in pixels from the left edge of this view's parent to the right edge of this view.
protected		int	mScrollX	The offset, in pixels, by which the content of this view is scrolled horizontally.
protected		int	mScrollY	The offset, in pixels, by which the content of this view is scrolled vertically.
protected		Object	mTag	The view's tag.
protected		int	mTop	The distance in pixels from the top edge of this view's parent to the top edge of this view.

					ListView(Context context)
					ListView(Context context, AttributeSet attrs, Map inflateParams)
					ListView(Context context, AttributeSet attrs, Map inflateParams, int defStyle)

				void	addFooterView(View v)
					Add a fixed view to appear at the bottom of the list.
				void	addFooterView(View v, Object data, boolean isSelectable)
					Add a fixed view to appear at the bottom of the list.
				void	addHeaderView(View v)
					Add a fixed view to appear at the top of the list.
				void	addHeaderView(View v, Object data, boolean isSelectable)
					Add a fixed view to appear at the top of the list.
				boolean	dispatchKeyEvent(KeyEvent event)
					Dispatch a key event to the next view on the focus path.
				void	draw(Canvas canvas)
					Manually render this view (and all of its children) to the given Canvas.
				ListAdapter	getAdapter()
				boolean	getItemsCanFocus()
				int	getMaxScrollAmount()
				int	getNumberOfFooterViews()
					Gets the number of footer views in the list.
				int	getNumberOfHeaderViews()
					Gets the number of header views in the list.
				boolean	onKeyDown(int keyCode, KeyEvent event)
					Default implementation of KeyEvent.Callback.onKeyMultiple(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_NEWLINE is released, if the view is enabled and clickable.
				boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event)
					Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).
				boolean	removeFooterView(View v)
					Removes a previously-added footer view.
				boolean	removeHeaderView(View v)
					Removes a previously-added header view.
				boolean	requestChildRectangleOnScreen(View child, Rect rect, boolean immediate)
					Called when a child of this group wants a particular rectangle to be positioned onto the screen.
				void	setAdapter(ListAdapter adapter)
					Sets the data behind this ListView.
				void	setDivider(Drawable divider)
					Sets the drawable that will be drawn between each item in the list.
				void	setDividerHeight(int height)
					Sets the height of the divider that will be drawn between each item in the list.
				void	setItemsCanFocus(boolean itemsCanFocus)
					Indicates that the views created by the ListAdapter can contain focusable items.
				void	setOnListViewScrollListener(OnListViewScrollListener l)
					Set the listener that will receive notifications every time the list scrolls.
				void	setSelection(int position)
					Sets the currently selected item
				void	setSelectionAfterHeaderView()
					setSelectionAfterHeaderView set the selection to be the first list item after the header views.
				void	setSelectionFromTop(int position, int y)
					Sets the selected item and positions the selection y pixels from the top edge of the ListView.
				void	setStripes(Drawable[] stripes, int stripeHeight)
				boolean	verifyDrawable(Drawable dr)
					If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.

java.lang.Object

android.view.View

Drawable.Callback KeyEvent.Callback

android.view.ViewGroup

ViewManager ViewParent

android.widget.AdapterView

android.widget.AbsListView

android.widget.ListView

				boolean	arrowScroll(int direction)
					Scrolls to the next or previous item if possible.
				boolean	canAnimate()
					Indicates whether the view group has the ability to animate its children after the first layout.
				void	dispatchDraw(Canvas canvas)
					Called by draw to draw the child views.
				void	drawDivider(Canvas canvas, Rect bounds, int childIndex)
					Draws a divider for the given child in the given bounds.
				void	drawableStateChanged()
					This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
				int	findMotionRow(int y)
					Find the row closest to y.
				View	findViewInHeadersOrFooters(ArrayList where, int id)
				View	findViewTagInHeadersOrFooters(ArrayList where, Object tag)
				View	findViewTraversal(int id)

				View