com.google.appinventor.components.runtime

Class ListView

java.lang.Object

com.google.appinventor.components.runtime.VisibleComponent

com.google.appinventor.components.runtime.AndroidViewComponent

com.google.appinventor.components.runtime.ListView

All Implemented Interfaces:

android.widget.AdapterView.OnItemClickListener, Component

public final class ListView
extends AndroidViewComponent
implements android.widget.AdapterView.OnItemClickListener

ListView Component. Non-Visible component to create a ListView in the Screen from a series of elements added from a comma separated set of text elements. It is similar to the ListPicker component but this one is placed on screen instead of opening a new Activity. TOFO(hal): Think about generalizing this to include more than text/

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentContainer	container

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
ListView(ComponentContainer container) Creates a new ListView component.

Method Summary

Methods

Modifier and Type	Method and Description
void	AfterPicking() Simple event to be raised after the an element has been chosen in the list.
int	BackgroundColor() Returns the listview's background color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB.
void	BackgroundColor(int argb) Specifies the ListView's background color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB.
YailList	Elements() Elements property getter method
void	Elements(YailList itemsList) Set a list of text elements to build a ListView
void	ElementsFromString(java.lang.String itemstring) Specifies the text elements of the ListView.
android.view.View	getView() Returns the View that is displayed in the UI.
void	Height(int height) Sets the height of the listView on the screen
android.text.Spannable[]	itemsToColoredText()
void	onItemClick(android.widget.AdapterView<?> parent, android.view.View view, int position, long id) Simple event to raise when the component is clicked.
java.lang.String	Selection() Returns the text in the ListView at the position set by SelectionIndex
void	Selection(java.lang.String value) Selection property setter method.
int	SelectionIndex() Selection index property getter method.
void	SelectionIndex(int index) Sets the index to the passed argument for selection
void	setAdapterData() Sets the items of the ListView through an adapter
void	setBackgroundColor(int color) Assigns a value to the backgroundColor
boolean	ShowFilterBar() Returns true or false depending on the visibility of the Filter bar element
void	ShowFilterBar(boolean showFilter) Sets true or false to determine whether the search filter box is displayed in the ListView
int	TextColor() Returns the listview's text item color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB.
void	TextColor(int argb) Specifies the ListView item's text color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB.
int	TextSize() Returns the listview's text font Size
void	TextSize(int fontSize) Specifies the ListView item's text font size
void	Width(int width) Sets the width of the listView on the screen

Methods inherited from class com.google.appinventor.components.runtime.AndroidViewComponent

Column, Column, CopyHeight, CopyWidth, getDispatchDelegate, Height, Row, Row, Visible, Visible, Width

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

container

protected final ComponentContainer container

Constructor Detail

ListView

public ListView(ComponentContainer container)

Creates a new ListView component.

Parameters:

container - container that the component will be placed in

Method Detail

getView

public android.view.View getView()

Description copied from class: AndroidViewComponent

Returns the View that is displayed in the UI.

Specified by:

getView in class AndroidViewComponent

Height

public void Height(int height)

Sets the height of the listView on the screen

Overrides:

Height in class AndroidViewComponent

Parameters:

height - for height length

Width

public void Width(int width)

Sets the width of the listView on the screen

Overrides:

Width in class AndroidViewComponent

Parameters:

width - for width length

ShowFilterBar

public void ShowFilterBar(boolean showFilter)

Sets true or false to determine whether the search filter box is displayed in the ListView

Parameters:

showFilter - set the visibility according to this input

ShowFilterBar

public boolean ShowFilterBar()

Returns true or false depending on the visibility of the Filter bar element

Returns:

true or false (visibility)

Elements

public void Elements(YailList itemsList)

Set a list of text elements to build a ListView

Parameters:

itemsList - a YailList containing the strings to be added to the ListView

Elements

public YailList Elements()

Elements property getter method

Returns:

a YailList representing the list of strings to be picked from

ElementsFromString

public void ElementsFromString(java.lang.String itemstring)

Specifies the text elements of the ListView.

Parameters:

itemstring - a string containing a comma-separated list of the strings to be picked from

setAdapterData

public void setAdapterData()

Sets the items of the ListView through an adapter

itemsToColoredText

public android.text.Spannable[] itemsToColoredText()

SelectionIndex

public int SelectionIndex()

Selection index property getter method.

SelectionIndex

public void SelectionIndex(int index)

Sets the index to the passed argument for selection

Parameters:

index - the index to be selected

Selection

public java.lang.String Selection()

Returns the text in the ListView at the position set by SelectionIndex

Selection

public void Selection(java.lang.String value)

Selection property setter method.

onItemClick

public void onItemClick(android.widget.AdapterView<?> parent,
               android.view.View view,
               int position,
               long id)

Simple event to raise when the component is clicked. Implementation of AdapterView.OnItemClickListener

Specified by:

onItemClick in interface android.widget.AdapterView.OnItemClickListener

AfterPicking

public void AfterPicking()

Simple event to be raised after the an element has been chosen in the list. The selected element is available in the Selection property.

setBackgroundColor

public void setBackgroundColor(int color)

Assigns a value to the backgroundColor

Parameters:

color - an alpha-red-green-blue integer for a color

BackgroundColor

public int BackgroundColor()

Returns the listview's background color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB. An alpha of 00 indicates fully transparent and FF means opaque.

Returns:

background color in the format 0xAARRGGBB, which includes alpha, red, green, and blue components

BackgroundColor

public void BackgroundColor(int argb)

Specifies the ListView's background color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB. An alpha of 00 indicates fully transparent and FF means opaque.

Parameters:

argb - background color in the format 0xAARRGGBB, which includes alpha, red, green, and blue components

TextColor

public int TextColor()

Returns the listview's text item color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB. An alpha of 00 indicates fully transparent and FF means opaque.

Returns:

background color in the format 0xAARRGGBB, which includes alpha, red, green, and blue components

TextColor

public void TextColor(int argb)

Specifies the ListView item's text color as an alpha-red-green-blue integer, i.e., 0xAARRGGBB. An alpha of 00 indicates fully transparent and FF means opaque.

Parameters:

argb - background color in the format 0xAARRGGBB, which includes alpha, red, green, and blue components

TextSize

public int TextSize()

Returns the listview's text font Size

Returns:

text size as an float

TextSize

public void TextSize(int fontSize)

Specifies the ListView item's text font size

Parameters:

integer - value for font size