AutoCompleteTextField

Class Overview

An editable text field that shows completion suggestions automatically while the user is typing. The list of suggestions is displayed in a drop down menu from which the user can choose an item to replace the content of the edit box with.

The drop down can be dismissed at any time by pressing the back key or, if no item is selected in the drop down, by pressing the enter/dpad center key.

The list of suggestions only appears after a given number of characters are typed. This number is defined by the threshold setThreshold(int). The default value is 3 characters.

The suggestions only display when user is typing text. Using methods setText(String) or setText(int) do not display suggestions.

Providing suggestions

The classic way to provide suggestions is to use setData(List). When using this method, all the possible suggestions should be provided.

The following code snippet shows how to create a field which suggests various country names while the user is typing:

 public class CountriesScreen extends Screen {
 	protected void onCreate() {
 		setContentView(R.layout.countries);
 		AutoCompleteTextField field = (AutoCompleteTextField) findView(Res.id.countries_list);
 		field.setData(COUNTRIES);
 	}

 	private static final String[] COUNTRIES = new String[] { "Belgium", "France", "Italy", "Germany", "Spain" };
 }
 

Adapting views

The AutoCompleteTextField can accept complex data types as suggestions with setData(List). Custom views can be shown in the drop-down list to improve the display of each suggestion instead of having plain text only. See setViewAdapter(AutoCompleteViewAdapter).

Text converting

The AutoCompleteTextField can accept complex data types as suggestions with setData(List). The default converter (if no AutoCompleteViewAdapter is present) will call the toString() method on each data object to display it in the drop-down list. To customize the displayed text, a custom AutoCompleteTextConverter can be used with setTextConverter(AutoCompleteTextConverter).

Default filtering

When using setData(List), a default filter is used to show the user only a sub-list of suggestions that best matches the typed text.

This default filter browses the data source to look if the string representation of each element contains a word starting with the current text, ignoring the case. The String representation of the object is obtained through the default or custom AutoCompleteTextConverter.

Custom filtering

Custom filtering can be used to change the way the suggestions are filtered out of the original data. The filter can be applied with setFilter(AutoCompleteFilter). After the text has changed and before the suggestions are presented to the screen, find(String) is called on the custom filter to give an opportunity to return a custom List of suggestions.

A custom filter can also be used if you're going to perform an asynchronous operation (background thread calculations, call a web service). In such a situation, at the end of the operation, simply call setData(List) to apply the suggestions.

Summary

[Expand] Inherited XML Attributes
From class com.neomades.ui.TextEdit Attribute Name Related Method Description autoCorrect setAutoCorrect(boolean) Auto-correct mode   capitalizeMode setCapitalizeMode(CapitalizeMode) Capitalize mode   contentAlignment setContentAlignment(int) A combination of alignment values (eg: TOP|LEFT)   cursorPosition setCursorPosition(int) The caret position   defaultText setDefaultText(int) Res.string.XXXX or a text   font setFont(Font) Font resource id: Res.font.FONT_XXXX   maxLength setMaxLength(int) Max number of characters   passwordMode setPasswordMode(boolean) If the field hides characters   readOnly setReadOnly(boolean) If the text inside is not editable   text setText(int) Res.string.XXXX or a text   textColor setTextColor(Color) #AARRGGBB or a color   textMode setTextMode(TextMode) The text mode   textSize setTextSize(int) a size in dp
From class com.neomades.ui.View Attribute Name Related Method Description background setBackground(int) Res.background.XXXX   backgroundColor setBackgroundColor(Color) #AARRGGBB or a color   backgroundImage setBackgroundImage(Image) Res.image.XXXX or a color   borderColor setBorderColor(Color) #AARRGGBB or a color   borderWidth setBorderWidth(int) eg: 10dp or 10 (dp is the default unit)   clickable setClickable(boolean) If the view could be clicked   cornerRadius setCornerRadius(int) eg: 10dp or 10 (dp is the default unit)   enabled setEnabled(boolean) If the view could be enabled   focusable setFocusable(boolean) If the view could be focused   height setHeight(int) eg: 10dp or 10 (dp is the default unit)   id setId(int) Res.id.XXXX   layoutAlignment setLayoutAlignment(int) A combination of alignment values (eg: TOP|LEFT)   margin setMargin(int) eg: 10dp or 10 (dp is the default unit)   marginBottom setMarginBottom(int) eg: 10dp or 10 (dp is the default unit)   marginLeft setMarginLeft(int) eg: 10dp or 10 (dp is the default unit)   marginRight setMarginRight(int) eg: 10dp or 10 (dp is the default unit)   marginTop setMarginTop(int) eg: 10dp or 10 (dp is the default unit)   padding setPadding(int) eg: 10dp or 10 (dp is the default unit)   paddingBottom setPaddingBottom(int) eg: 10dp or 10 (dp is the default unit)   paddingLeft setPaddingLeft(int) eg: 10dp or 10 (dp is the default unit)   paddingRight setPaddingRight(int) eg: 10dp or 10 (dp is the default unit)   paddingTop setPaddingTop(int) eg: 10dp or 10 (dp is the default unit)   stretchHorizontalMode setStretchHorizontalMode(int) The dimension could be adapted to the parent dimension or to the content size.  stretchVerticalMode setStretchVerticalMode(int) The dimension could be adapted to the parent dimension or to the content size.  visible setVisible(boolean) If the view is visible or hidden and collapsed   width setWidth(int) eg: 10dp or 10 (dp is the default unit)

[Expand] Inherited Constants
From interface com.neomades.ui.Alignment int BOTTOM Vertical bottom int HCENTER Horizontal center int LEFT Horizontal left int RIGHT Horizontal right int TOP Vertical top int VCENTER Vertical center or middle
From interface com.neomades.ui.StretchMode int MATCH_CONTENT The view will get the size of its content int MATCH_PARENT The view will fill the size of its parent

[Expand] Inherited Methods
From class com.neomades.ui.TextEdit void clear() Removes the text of this field String getDefaultText() Gets the default text of this text field. String getText() Returns the text of this text field. boolean isReadOnly() Returns if the the field is readonly or can be edited int length() Returns the length of the text of this field void setAutoCorrect(boolean autocorrect) Sets if auto-correct should be enabled. void setCapitalizeMode(CapitalizeMode mode) Changes the capitalize mode. void setContentAlignment(int alignment) Sets the alignment of the text in this component. void setCursorPosition(int index) Moves the cursor position before the character at the given index. void setDefaultText(String defaultText) Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted. void setDefaultText(int resId) Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted. void setFont(Font font) Sets the font for this text field void setMaxLength(int maxLength) Sets the maximum number of authorized characters into this TextField. void setPasswordMode(boolean passwordMode) Sets the password mode. void setReadOnly(boolean readonly) Sets the state of this field to readonly or editable void setReturnKeyListener(ReturnKeyListener returnKeyListener) Associates a ReturnKeyListener to this TextField. void setReturnKeyType(int returnKeyType) Changes the content of the return key. void setText(String text) Sets the text of this text field void setText(int resId) Sets the text of the text field void setTextChangedListener(TextChangedListener listener) Sets a text change listener (called when the text has been changed by the user) void setTextColor(Color color) Sets the text color of this textfield's text void setTextMode(TextMode mode) Changes the text mode. void setTextSize(int sizeInDp) Sets the text size to a given value (in dp).
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.