| java.lang.Object | |||||
| ↳ | android.view.View | ||||
| ↳ | android.view.ViewGroup | ||||
| ↳ | com.htc.widget.HtcAdapterView<T extends android.widget.Adapter> | ||||
| ↳ | com.htc.widget.HtcAbsListView | ||||
| ↳ | com.htc.widget.HtcListView | ||||
Class Overview
A view that shows items in a vertically scrolling list. The items
come from the ListAdapter associated with this view.
See the List View tutorial.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| HtcListView.FixedViewInfo | A class that represents a fixed view in a list, for example a header at the top or a footer at the bottom. | ||||||||||
| XML Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| android:divider | Drawable or color to draw between list items. | ||||||||||
| android:dividerHeight | Height of the divider. | ||||||||||
| android:entries | Reference to an array resource that will populate the ListView. | ||||||||||
| android:footerDividersEnabled | When set to false, the ListView will not draw the divider before each footer view. | ||||||||||
| android:headerDividersEnabled | When set to false, the ListView will not draw the divider after each header view. | ||||||||||
|
[Expand]
Inherited XML Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From class
com.htc.widget.HtcAbsListView
| |||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | DEFAULT_INTRO_ANIMATION | Used to indicate the intro animation type | |||||||||
| int | DOWN_INTRO_ANIMATION | ||||||||||
| int | LEFT_INTRO_ANIMATION | ||||||||||
| int | RIGHT_INTRO_ANIMATION | ||||||||||
| int | UP_INTRO_ANIMATION | ||||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.htc.widget.HtcAbsListView
| |||||||||||
|
From class
com.htc.widget.HtcAdapterView
| |||||||||||
|
From class
android.view.ViewGroup
| |||||||||||
|
From class
android.view.View
| |||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| mBoucingAnimatorSet | |||||||||||
| mEmptyHeight | |||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.htc.widget.HtcAbsListView
| |||||||||||
|
From class
android.view.ViewGroup
| |||||||||||
|
From class
android.view.View
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Adds a fixed view to appear at the bottom of the list.
| |||||||||||
Adds a fixed view to appear at the bottom of the list.
| |||||||||||
Adds a fixed view to appear at the bottom of the list.
| |||||||||||
Adds a fixed view to appear at the top of the list.
| |||||||||||
Adds a fixed view to appear at the top of the list.
| |||||||||||
Enables or disables one kind of animation;
default : enable all animations
HtcAbsListView.ANIM_OVERSCROLL, ANIM_INTRO, ANIM_CLICK, ANIM_ADD, ANIM_DEL;
can use bit operation, e.g.: ANIM_OVERSCROLL & ANIM_INTRO
| |||||||||||
Returns the adapter currently in use in this ListView.
| |||||||||||
This method is deprecated.
Use #getCheckedItemIds() instead.
| |||||||||||
Returns the drawable that will be drawn between each item in the list.
| |||||||||||
Returns the number of footer views in the list.
| |||||||||||
Returns the number of header views in the list.
| |||||||||||
Callback method to be invoked when the list or grid has been scrolled.
| |||||||||||
Callback method to be invoked while the list view or grid view is being scrolled.
| |||||||||||
Removes a previously-added footer view.
| |||||||||||
Removes a previously-added header view.
| |||||||||||
Enables or disables 2D Press Animation
| |||||||||||
Enables activated background for item in portrait mode.
| |||||||||||
Sets the data behind this ListView.
| |||||||||||
When set to a non-zero value, the cache color hint indicates that this list is always drawn
on top of a solid, single-color, opaque background.
| |||||||||||
Sets the scale X of item of click animation.
| |||||||||||
Sets the scale Y of item of click animation.
| |||||||||||
Specifies if the background is in dark style.
| |||||||||||
Sets the drawable that will be drawn between each item in the list.
| |||||||||||
Sets the height of the divider that will be drawn between each item in the list.
| |||||||||||
Sets whether draw the bottom shadow of listView
| |||||||||||
Sets whether draw the shadow of pressed item or not
| |||||||||||
Sets whether listview will expand height to fill parent without showing listview background.
| |||||||||||
Enables or disables the drawing of the divider for footer views.
| |||||||||||
Enables or disables the drawing of the divider for header views.
| |||||||||||
Sets the delay in milliseconds before the intro animation runs
| |||||||||||
Indicates the intro aniamtion type
| |||||||||||
Indicates that the views created by the ListAdapter can contain focusable
items.
| |||||||||||
Sets the drawable that will be drawn below all other list content.
| |||||||||||
Sets the drawable that will be drawn above all other list content.
| |||||||||||
Sets up this AbsListView to use a remote views adapter which connects to a RemoteViewsService
through the specified intent.
| |||||||||||
Sets the currently selected item.
| |||||||||||
setSelectionAfterHeaderView set the selection to be the first list item
after the header views.
| |||||||||||
Sets the selected item and positions the selection y pixels from the top edge
of the ListView.
| |||||||||||
Smoothly scrolls to the specified adapter position offset.
| |||||||||||
Smoothly scrolls to the specified adapter position.
| |||||||||||
Plays the intro animation
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
com.htc.widget.HtcAbsListView
| |||||||||||
|
From class
com.htc.widget.HtcAdapterView
| |||||||||||
|
From class
android.view.ViewGroup
| |||||||||||
|
From class
android.view.View
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.graphics.drawable.Drawable.Callback
| |||||||||||
|
From interface
android.graphics.drawable.Drawable.Callback2
| |||||||||||
|
From interface
android.text.TextWatcher
| |||||||||||
|
From interface
android.view.GestureDetector.OnGestureListener
| |||||||||||
|
From interface
android.view.HtcIfViewGroup
| |||||||||||
|
From interface
android.view.KeyEvent.Callback
| |||||||||||
|
From interface
android.view.ViewManager
| |||||||||||
|
From interface
android.view.ViewParent
| |||||||||||
|
From interface
android.view.ViewTreeObserver.OnGlobalLayoutListener
| |||||||||||
|
From interface
android.view.ViewTreeObserver.OnTouchModeChangeListener
| |||||||||||
|
From interface
android.view.accessibility.AccessibilityEventSource
| |||||||||||
|
From interface
android.widget.Filter.FilterListener
| |||||||||||
XML Attributes
android:divider
Drawable or color to draw between list items.
May be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
May be a color value, in the form of "#rgb", "#argb",
"#rrggbb", or "#aarrggbb".
This corresponds to the global attribute resource symbol divider.
Related Methods
android:dividerHeight
Height of the divider. Will use the intrinsic height of the divider if this is not specified.
Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp".
Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size),
in (inches), mm (millimeters).
This may also be a reference to a resource (in the form
"@[package:]type:name") or
theme attribute (in the form
"?[package:][type:]name")
containing a value of this type.
This corresponds to the global attribute resource symbol dividerHeight.
Related Methods
android:entries
Reference to an array resource that will populate the ListView. For static content, this is simpler than populating the ListView programmatically.
Must be a reference to another resource, in the form "@[+][package:]type:name"
or to a theme attribute in the form "?[package:][type:]name".
This corresponds to the global attribute resource symbol entries.
Related Methods
android:footerDividersEnabled
When set to false, the ListView will not draw the divider before each footer view. The default value is true.
Must be a boolean value, either "true" or "false".
This may also be a reference to a resource (in the form
"@[package:]type:name") or
theme attribute (in the form
"?[package:][type:]name")
containing a value of this type.
This corresponds to the global attribute resource symbol footerDividersEnabled.
Related Methods
android:headerDividersEnabled
When set to false, the ListView will not draw the divider after each header view. The default value is true.
Must be a boolean value, either "true" or "false".
This may also be a reference to a resource (in the form
"@[package:]type:name") or
theme attribute (in the form
"?[package:][type:]name")
containing a value of this type.
This corresponds to the global attribute resource symbol headerDividersEnabled.
Related Methods
Constants
public static final int DEFAULT_INTRO_ANIMATION
Used to indicate the intro animation type
Fields
Public Constructors
Public Methods
public void addFootViewWithoutDivider (View v, Object data, boolean isSelectable)
Adds a fixed view to appear at the bottom of the list. If addFooterView is called more than once, the views will appear in the order they were added. Views added using this call can take focus if they want.
NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied cursor with one that that will also account for header views.
Parameters
| v | The view to add. |
|---|---|
| data | Data to associate with this view |
| isSelectable | true if the footer view can be selected |
public void addFooterView (View v, Object data, boolean isSelectable)
Adds a fixed view to appear at the bottom of the list. If addFooterView is called more than once, the views will appear in the order they were added. Views added using this call can take focus if they want.
NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied cursor with one that will also account for header and footer views.
Parameters
| v | The view to add. |
|---|---|
| data | Data to associate with this view |
| isSelectable | true if the footer view can be selected |
public void addFooterView (View v)
Adds a fixed view to appear at the bottom of the list. If addFooterView is called more than once, the views will appear in the order they were added. Views added using this call can take focus if they want.
NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied cursor with one that will also account for header and footer views.
Parameters
| v | The view to add. |
|---|
public void addHeaderView (View v, Object data, boolean isSelectable)
Adds a fixed view to appear at the top of the list. If addHeaderView is called more than once, the views will appear in the order they were added. Views added using this call can take focus if they want.
NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied cursor with one that will also account for header and footer views.
Parameters
| v | The view to add. |
|---|---|
| data | Data to associate with this view |
| isSelectable | Whether the item is selectable |
public void addHeaderView (View v)
Adds a fixed view to appear at the top of the list. If addHeaderView is called more than once, the views will appear in the order they were added. Views added using this call can take focus if they want.
NOTE: Call this before calling setAdapter. This is so ListView can wrap the supplied cursor with one that will also account for header and footer views.
Parameters
| v | The view to add. |
|---|
public void enableAnimation (int anim_id, boolean enable)
Enables or disables one kind of animation; default : enable all animations HtcAbsListView.ANIM_OVERSCROLL, ANIM_INTRO, ANIM_CLICK, ANIM_ADD, ANIM_DEL; can use bit operation, e.g.: ANIM_OVERSCROLL & ANIM_INTRO
Parameters
| anim_id | HtcAbsListView.ANIM_OVERSCROLL, ANIM_INTRO, ANIM_CLICK, ANIM_ADD, ANIM_DEL; |
|---|---|
| enable | true or false |
public ListAdapter getAdapter ()
Returns the adapter currently in use in this ListView. The returned adapter
might not be the same adapter passed to setAdapter(ListAdapter) but
might be a WrapperListAdapter.
Returns
- The adapter currently used to display data in this ListView.
See Also
public long[] getCheckItemIds ()
This method is deprecated.
Use #getCheckedItemIds() instead.
Returns the set of checked items ids. The result is only valid if the
choice mode has not been set to CHOICE_MODE_NONE.
Returns
- A new array which contains the id of each checked item in the list.
public Drawable getDivider ()
Returns the drawable that will be drawn between each item in the list.
Returns
- The current drawable drawn between list elements
public int getDividerHeight ()
Returns
- Returns the height of the divider that will be drawn between each item in the list.
public int getFooterViewsCount ()
Returns the number of footer views in the list. Footer views are special views at the bottom of the list that should not be recycled during a layout.
Returns
- The number of footer views, 0 in the default implementation.
public int getHeaderViewsCount ()
Returns the number of header views in the list. Header views are special views at the top of the list that should not be recycled during a layout.
Returns
- The number of header views, 0 in the default implementation.
public boolean getItemsCanFocus ()
Returns
- Whether the views created by the ListAdapter can contain focusable items.
public int getMaxScrollAmount ()
Returns
- The maximum amount a list view will scroll in response to an arrow event.
public Drawable getOverscrollFooter ()
Returns
- The drawable that will be drawn below all other list content
public Drawable getOverscrollHeader ()
Returns
- The drawable that will be drawn above all other list content
public boolean onFling (MotionEvent e1, MotionEvent e2, float velocityX, float velocityY)
public void onScroll (HtcAbsListView view, int firstVisibleItem, int visibleItemCount, int totalItemCount)
Callback method to be invoked when the list or grid has been scrolled. This will be called after the scroll has completed
Parameters
| view | The view whose scroll state is being reported |
|---|---|
| firstVisibleItem | The index of the first visible cell (ignore if visibleItemCount == 0) |
| visibleItemCount | The number of visible cells |
| totalItemCount | The number of items in the list adaptor |
public boolean onScroll (MotionEvent e1, MotionEvent e2, float distanceX, float distanceY)
public void onScrollStateChanged (HtcAbsListView view, int scrollState)
Callback method to be invoked while the list view or grid view is being scrolled. If the
view is being scrolled, this method will be called before the next frame of the scroll is
rendered. In particular, it will be called before any calls to
getView(int, View, ViewGroup).
Parameters
| view | The view whose scroll state is being reported |
|---|---|
| scrollState | The current scroll state. One of #SCROLL_STATE_IDLE, #SCROLL_STATE_TOUCH_SCROLL or #SCROLL_STATE_IDLE. |
public boolean performItemClick (View view, int position, long id)
Parameters
| view | The view within the AdapterView that was clicked. |
|---|---|
| position | The position of the view in the adapter. |
| id | The row id of the item that was clicked. |
Returns
- True if there was an assigned OnItemClickListener that was called, false otherwise is returned.
public boolean removeFooterView (View v)
Removes a previously-added footer view.
Parameters
| v | The view to remove |
|---|
Returns
- true if the view was removed, false if the view was not a footer view
public boolean removeHeaderView (View v)
Removes a previously-added header view.
Parameters
| v | The view to remove |
|---|
Returns
- true if the view was removed, false if the view was not a header view
public boolean requestChildRectangleOnScreen (View child, Rect rect, boolean immediate)
public void set2DPressAnimationEnabled (boolean enabled)
Enable or disable 2D Press Animation
public void setActivatedPortrait (boolean b)
Enables activated background for item in portrait mode. default value is false;
Parameters
| b | true: enable; false: disable |
|---|
public void setAdapter (ListAdapter adapter)
Sets the data behind this ListView. The adapter passed to this method may be wrapped by a WrapperListAdapter, depending on the ListView features currently in use. For instance, adding headers and/or footers will cause the adapter to be wrapped.
Parameters
| adapter | The ListAdapter which is responsible for maintaining the data backing this list and for producing a view to represent an item in that data set. |
|---|
See Also
public void setCacheColorHint (int color)
When set to a non-zero value, the cache color hint indicates that this list is always drawn
on top of a solid, single-color, opaque background.
Zero means that what's behind this object is translucent (non solid) or is not made of a
single color. This hint will not affect any existing background drawable set on this view (
typically set via setBackgroundDrawable(Drawable)).
Parameters
| color | The background color |
|---|
public void setClickAnimationScaleX (float scaleX)
Sets the scale X of item of click animation.
public void setClickAnimationScaleY (float scaleY)
Sets the scale Y of item of click animation.
public void setDarkModeEnabled (boolean enabled)
Specifies if the background is in dark style. The would impact the background of the child item.
Parameters
| enabled | True if dark mode is enabled. |
|---|
public void setDivider (Drawable divider)
Sets the drawable that will be drawn between each item in the list. If the drawable does
not have an intrinsic height, you should also call setDividerHeight(int)
Parameters
| divider | The drawable to use. |
|---|
public void setDividerHeight (int height)
Sets the height of the divider that will be drawn between each item in the list. Calling
this will override the intrinsic height as set by setDivider(Drawable)
Parameters
| height | The new height of the divider in pixels. |
|---|
public void setDrawBottomShadow (boolean isEnabled)
Sets whether draw the bottom shadow of listView
Parameters
| isEnabled | If true, draw bottom shadow of listView. Otherwise, do not draw it. |
|---|
public void setDrawPressShadow (boolean isEnabled)
Sets whether draw the shadow of pressed item or not
Parameters
| isEnabled | If true, draw shadow of pressed item. Otherwise, do not draw it. |
|---|
public void setFillEmpty (boolean fillEmpty)
Sets whether listview will expand height to fill parent without showing listview background.
Parameters
| fillEmpty | Sets true to enable fill empty and false to disable. |
|---|
public void setFooterDividersEnabled (boolean footerDividersEnabled)
Enables or disables the drawing of the divider for footer views.
Parameters
| footerDividersEnabled | True to draw the footers, false otherwise. |
|---|
public void setHeaderDividersEnabled (boolean headerDividersEnabled)
Enables or disables the drawing of the divider for header views.
Parameters
| headerDividersEnabled | True to draw the headers, false otherwise. |
|---|
public void setIntroAnimationDelay (int delay)
Sets the delay in milliseconds before the intro animation runs
public void setIntroAnimationType (int type)
Indicates the intro aniamtion type
Parameters
| type | The intro animation type |
|---|
public void setItemsCanFocus (boolean itemsCanFocus)
Indicates that the views created by the ListAdapter can contain focusable items.
Parameters
| itemsCanFocus | true if items can get focus, false otherwise |
|---|
public void setOverscrollFooter (Drawable footer)
Sets the drawable that will be drawn below all other list content. This area can become visible when the user overscrolls the list, or when the list's content does not fully fill the container area.
Parameters
| footer | The drawable to use |
|---|
public void setOverscrollHeader (Drawable header)
Sets the drawable that will be drawn above all other list content. This area can become visible when the user overscrolls the list.
Parameters
| header | The drawable to use |
|---|
public void setRemoteViewsAdapter (Intent intent)
Sets up this AbsListView to use a remote views adapter which connects to a RemoteViewsService through the specified intent.
Parameters
| intent | The intent used to identify the RemoteViewsService for the adapter to connect to. |
|---|
public void setSelection (int position)
Sets the currently selected item. If in touch mode, the item will not be selected but it will still be positioned appropriately. If the specified selection position is less than 0, then the item at position 0 will be selected.
Parameters
| position | Index (starting at 0) of the data item to be selected. |
|---|
public void setSelectionAfterHeaderView ()
setSelectionAfterHeaderView set the selection to be the first list item after the header views.
public void setSelectionFromTop (int position, int y)
Sets the selected item and positions the selection y pixels from the top edge of the ListView. (If in touch mode, the item will not be selected but it will still be positioned appropriately.)
Parameters
| position | Index (starting at 0) of the data item to be selected. |
|---|---|
| y | The distance from the top edge of the ListView (plus padding) that the item will be positioned. |
public void smoothScrollByOffset (int offset)
Smoothly scrolls to the specified adapter position offset. The view will scroll such that the indicated position is displayed.
Parameters
| offset | The amount to offset from the adapter position to scroll to. |
|---|
public void smoothScrollToPosition (int position)
Smoothly scrolls to the specified adapter position. The view will scroll such that the indicated position is displayed.
Parameters
| position | Scroll to this adapter position. |
|---|