public class

ListView

extends AbsListView

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.AbsListView
		↳	com.neomades.ui.ListView

Class Overview

A ListView is a vertical list of views, where only one view can be clicked at the same time.

Each view can be different.

Handling selection

 ItemSelectedListener listViewListener = new ItemSelectedListener() {
 	public void onItemSelected(int index, String item) {
 		// do some stuff
 	}
 }
 ListView list = new ListView();
 // add items here
 list.setItemSelectedListener(listViewListener);

Async ListView

In order to improve Long lists performance, prefer using ListAdapter.

A ListAdapter enable recycling item's view. Every time ListView needs to show a new item , it will call the getView() method from its adapter.

getView() takes three arguments arguments: the item position, a convertView, and the parent ViewGroup.

 public View getView(int position, View convertView, View parent) {
 	if (convertView == null) {
 		// build a new item
 		convertView = View.inflateXML(Res.layout.your_layout);
 	}
 
 	// update the convertView
 	// Warning: findView could damage performances (see ViewHolder pattern
 	// chapter)
 	TextLabel text = (TextLabel) convertView.findView(Res.id.your_textLabel);
 	text.setText("Position " + position);
 
 	return convertView;
 }

ViewHolder pattern

 public View getView(int position, View convertView, View parent) {
 	ViewHolder holder;
 	if (convertView == null) {
 		// build a new item
 		convertView = View.inflateXML(Res.layout.your_layout);
 		holder = new ViewHolder();
 		// Because findView may have poor performances
 		// It will done only once in the view build step
 		// and saved inside ViewHolder for the next use
 		holder.textLabel = (TextLabel) convertView.findView(Res.id.your_textLabel);
 		convertView.setTag(holder);
 	}
 
 	// update the convertView
 	holder = (ViewHolder) convertView.getTag();
 	holder.textLabel.setText("Position " + position);
 
 	return convertView;
 }

Cross Platform Considerations

Avoid setting MATCH_CONTENT for ListViews or ScrollViews at all times. The hierarchy of ListView is also concerned by this note. MATCH_CONTENT in the hierarchy could break down the ListView display.

Summary

XML Attributes
Attribute Name	Related Method	Description
listIndicatorVisible	setListIndicatorVisible(boolean)

[Expand]

Inherited XML Attributes

From class com.neomades.ui.AbsListView

From class com.neomades.ui.View

Constants
int	STYLE_GROUPED	A ListView whose sections present distinct groups of rows.
int	STYLE_PLAIN	A plain ListView.

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	ListView() Creates a new list view.
	ListView(int style) Sets the iOS UITableView style.

Public Methods
void	scrollToPosition(int itemPosition) Set the scrolled position of your ListView.
void	scrollToTop() Move the scroll position to the first item of your `ListView`.
void	setListIndicatorVisible(boolean indicatorVisible) Displays or hide the list indicator (generally something that represents an arrow at the tight of the ListView cell).
void	setPullToRefreshListener(PullToRefreshListener listener) Sets a pull-to-refresh listener to the `ListView`.
void	setPullToRefreshText(String text) If a `PullToRefreshListener` is set, this text will be displayed at the top of the list when the user is pulling downward but not enough to trigger the pull-to-refresh event.
void	setRefreshComplete() If a `PullToRefreshListener` is set, notifies the `ListView` that the refresh is over.
void	setRefreshLoadingText(String text) If a `PullToRefreshListener` is set, this text will be displayed at the top of the list when a pull-to-refresh event occurred.
void	setReleaseToRefreshText(String text) If a `PullToRefreshListener` is set, this text will be displayed at the top of the list when the user has enough pulled downward.
void	setRowHeightAdapter(RowHeightAdapter rowHeightAdapter) Sets an adapter for row heights.

[Expand]

Inherited Methods

From class com.neomades.ui.AbsListView

void	addView(View view, int atIndex) Inserts a view at a specified position.
void	addView(View view) Add a new item view to the list.
int	getViewsCount() Returns the number of views inside this container.
void	notifyDataChanged() Notifies the list that data has changed and the list should update the UI.
void	removeAllViews() Remove all views from this container.
void	removeIndex(int index) Remove a view at the specified `index`.
void	removeView(View view) Remove a view from this list.
void	setFadingEdgeColor(Color color) Sets the fading edge color.
void	setFadingEdgeEnabled(boolean enabled) Sets if the vertical/horizontal edges should be faded when this view is scrolled vertically/horizontally.
void	setFadingEdgeLength(int length) Sets the fading edge length
void	setFastScrollEnabled(boolean enabled) Specifies whether fast scrolling is enabled or disabled.
void	setHorizontalScrollBarEnabled(boolean scrollBarEnabled) Displays or hides the horizontal scroll bar.
void	setIndexerEnabled(boolean indexerEnabled) Enables or not the alphabetic indexer.
void	setIndexes(String[] indexes) Sets a specific list of indexes to show on the right of the list.
void	setItemClickedListener(ItemClickedListener listener) Set the item clicked listener.
void	setItemTypeAdapter(ItemTypeAdapter itemTypeAdapter) Sets the adapter that provides the data type to differentiate the data item views in this widget.
void	setListAdapter(ListAdapter adapter) Sets the adapter that provides the views to represent the data in this list.
void	setListIndexer(ListIndexer indexer) Sets the alphabetical indexer at the right of the list.
void	setListScrollListener(ListScrollListener listener) Associates a `ListSrollListener` with this ListView.
void	setRowHeight(int height) Sets the row height in DP unit for every row.
void	setSectionsVisible(boolean visible) Enables or not section items in the list.
void	setSelectionColor(Color selectionColor) Changes the default color that is applied when a user select an item.
void	setSelectionColorEnabled(boolean selectionEnabled) Enables or disables the fact that the colors of an item changes when an user selects it.
void	setSeparatorColor(Color separatorColor) Changes the color of the separators between each items of the list.
void	setSeparatorHeight(int height) Sets the size of the separator between two items of the list.
void	setSeparatorVisible(boolean visible) Displays or hide the separator (usually a line) between between each items in the list.
void	setVerticalScrollBarEnabled(boolean scrollBarEnabled) Displays or hides the vertical scroll bar.

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

XML Attributes

listIndicatorVisible

Related Methods

setListIndicatorVisible(boolean)

Constants

public static final int STYLE_GROUPED

A ListView whose sections present distinct groups of rows. The section headers and footers do not float.

Constant Value: 1 (0x00000001)

public static final int STYLE_PLAIN

A plain ListView. Any section headers or footers are displayed as inline separators and float when the ListView is scrolled.

Constant Value: 0 (0x00000000)

Public Constructors

public ListView ()

Creates a new list view.

public ListView (int style)

Sets the iOS UITableView style. (Only for iOS)

Parameters

style	STYLE_PLAIN (default) or STYLE_GROUPED

Public Methods

public void scrollToPosition (int itemPosition)

Set the scrolled position of your ListView.

If the position is higher than the item count, the ListView is scrolled to the last item.
If the position is less than 0, the ListView is scrolled to the first item.

Cross Platform considerations

On Android, ListView will scroll to the item position only if it is not already locate in the visible area.
If the item is below the visible area, it will move to the bottom of the ListView.
If the item is above the visible area, it will move to the top of the ListView.

Parameters

itemPosition	the item position to scroll to

public void scrollToTop ()

Move the scroll position to the first item of your ListView.

public void setListIndicatorVisible (boolean indicatorVisible)

Displays or hide the list indicator (generally something that represents an arrow at the tight of the ListView cell).

Related XML Attributes

listIndicatorVisible

Parameters

indicatorVisible	true to display the indicator

public void setPullToRefreshListener (PullToRefreshListener listener)

Sets a pull-to-refresh listener to the ListView. To have more precision about the pull-to-refresh mechanism, see PullToRefreshListener.

To properly configure a pull-to-refresh on the ListView, text in the header of the list can be configured. These texts will be shown in the upper part of the list when the user over-scrolls it.

setPullToRefreshText(String): the user is pulling downward the list but it is not enough yet to trigger the refresh.
setReleaseToRefreshText(String): the list was enough pulled, indicates to the user that he can release the list to trigger the refresh.
setRefreshLoadingText(String): the list is refreshing.

Do not forget to call setRefreshComplete() in the pull-to-refresh callback to indicate to the list that the refresh is over.

Should be called before setListAdapter(ListAdapter) and related methods.

Parameters

listener	non-null listener will enabled pull to refresh mode

public void setPullToRefreshText (String text)

If a PullToRefreshListener is set, this text will be displayed at the top of the list when the user is pulling downward but not enough to trigger the pull-to-refresh event.

Cross Platform considerations

This method has effect only in Android and iOS platforms.

Parameters

text	the text that will be displayed at the top of the list

public void setRefreshComplete ()

If a PullToRefreshListener is set, notifies the ListView that the refresh is over. This will hide the refresh text.

Should be called at the end of onRefresh method.

public void setRefreshLoadingText (String text)

If a PullToRefreshListener is set, this text will be displayed at the top of the list when a pull-to-refresh event occurred. It may indicate to the user that the list is refreshing.

Cross Platform considerations

This method has effect only in Android and iOS platforms.

Parameters

text	the text that will be displayed at the top of the list

public void setReleaseToRefreshText (String text)

If a PullToRefreshListener is set, this text will be displayed at the top of the list when the user has enough pulled downward. It may indicate to the user that he can release the list to trigger the refresh.

Cross Platform considerations

This method has effect only in Android and iOS platforms.

Parameters

text	the text that will be displayed at the top of the list

public void setRowHeightAdapter (RowHeightAdapter rowHeightAdapter)

Sets an adapter for row heights.

The adapter gives an height for each row (could be different).

Parameters

rowHeightAdapter	an adapter or null

Interfaces

Classes

Enums

Exceptions

ListView

Class Overview

Handling selection

Async ListView

ViewHolder pattern

Cross Platform Considerations

See Also

Summary

XML Attributes

listIndicatorVisible

Related Methods

Constants

public static final int STYLE_GROUPED

public static final int STYLE_PLAIN

Public Constructors

public ListView ()

public ListView (int style)

Parameters

See Also

Public Methods

public void scrollToPosition (int itemPosition)

Cross Platform considerations

Parameters

public void scrollToTop ()

public void setListIndicatorVisible (boolean indicatorVisible)

Related XML Attributes

Parameters

public void setPullToRefreshListener (PullToRefreshListener listener)

Parameters

See Also

public void setPullToRefreshText (String text)

Cross Platform considerations

Parameters

See Also

public void setRefreshComplete ()

See Also

public void setRefreshLoadingText (String text)

Cross Platform considerations

Parameters

See Also

public void setReleaseToRefreshText (String text)

Cross Platform considerations

Parameters

See Also

public void setRowHeightAdapter (RowHeightAdapter rowHeightAdapter)

Parameters