Most visited

Recently visited

Added in API level 1

MultiAutoCompleteTextView

public class MultiAutoCompleteTextView
extends AutoCompleteTextView

java.lang.Object
   ↳ android.view.View
     ↳ android.widget.TextView
       ↳ android.widget.EditText
         ↳ android.widget.AutoCompleteTextView
           ↳ android.widget.MultiAutoCompleteTextView
Known Direct Subclasses


An editable text view, extending AutoCompleteTextView, that can show completion suggestions for the substring of the text where the user is typing instead of necessarily for the entire thing.

You must provide a MultiAutoCompleteTextView.Tokenizer to distinguish the various substrings.

The following code snippet shows how to create a text view which suggests various countries names while the user is typing:

 public class CountriesActivity extends Activity {
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.autocomplete_7);

         ArrayAdapter<String> adapter = new ArrayAdapter<String>(this,
                 android.R.layout.simple_dropdown_item_1line, COUNTRIES);
         MultiAutoCompleteTextView textView = (MultiAutoCompleteTextView) findViewById(R.id.edit);
         textView.setAdapter(adapter);
         textView.setTokenizer(new MultiAutoCompleteTextView.CommaTokenizer());
     }

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

Summary

Nested classes

class MultiAutoCompleteTextView.CommaTokenizer

This simple Tokenizer can be used for lists where the items are separated by a comma and one or more spaces. 

interface MultiAutoCompleteTextView.Tokenizer

 

Inherited XML attributes

From class android.widget.AutoCompleteTextView
From class android.widget.TextView
From class android.view.View

Inherited constants

From class android.view.View

Inherited fields

From class android.view.View

Public constructors

MultiAutoCompleteTextView(Context context)
MultiAutoCompleteTextView(Context context, AttributeSet attrs)
MultiAutoCompleteTextView(Context context, AttributeSet attrs, int defStyleAttr)
MultiAutoCompleteTextView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Public methods

boolean enoughToFilter()

Instead of filtering whenever the total length of the text exceeds the threshhold, this subclass filters only when the length of the range from findTokenStart(CharSequence, int) to getSelectionEnd() meets or exceeds getThreshold().

CharSequence getAccessibilityClassName()

Return the class name of this object to be used for accessibility purposes.

void performValidation()

Instead of validating the entire text, this subclass method validates each token of the text individually.

void setTokenizer(MultiAutoCompleteTextView.Tokenizer t)

Sets the Tokenizer that will be used to determine the relevant range of the text where the user is typing.

Protected methods

void performFiltering(CharSequence text, int keyCode)

Instead of filtering on the entire contents of the edit box, this subclass method filters on the range from findTokenStart(CharSequence, int) to getSelectionEnd() if the length of that range meets or exceeds getThreshold().

void performFiltering(CharSequence text, int start, int end, int keyCode)

Starts filtering the content of the drop down list.

void replaceText(CharSequence text)

Performs the text completion by replacing the range from findTokenStart(CharSequence, int) to getSelectionEnd() by the the result of passing text through terminateToken(CharSequence).

Inherited methods

From class android.widget.AutoCompleteTextView
From class android.widget.EditText
From class android.widget.TextView
From class android.view.View
From class java.lang.Object
From interface android.widget.Filter.FilterListener
From interface android.view.ViewTreeObserver.OnPreDrawListener
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource

Public constructors

MultiAutoCompleteTextView

Added in API level 1
MultiAutoCompleteTextView (Context context)

Parameters
context Context

MultiAutoCompleteTextView

Added in API level 1
MultiAutoCompleteTextView (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

MultiAutoCompleteTextView

Added in API level 1
MultiAutoCompleteTextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

MultiAutoCompleteTextView

Added in API level 21
MultiAutoCompleteTextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

Public methods

enoughToFilter

Added in API level 1
boolean enoughToFilter ()

Instead of filtering whenever the total length of the text exceeds the threshhold, this subclass filters only when the length of the range from findTokenStart(CharSequence, int) to getSelectionEnd() meets or exceeds getThreshold().

Returns
boolean

getAccessibilityClassName

Added in API level 23
CharSequence getAccessibilityClassName ()

Return the class name of this object to be used for accessibility purposes. Subclasses should only override this if they are implementing something that should be seen as a completely new class of view when used by accessibility, unrelated to the class it is deriving from. This is used to fill in AccessibilityNodeInfo.setClassName.

Returns
CharSequence

performValidation

Added in API level 1
void performValidation ()

Instead of validating the entire text, this subclass method validates each token of the text individually. Empty tokens are removed.

setTokenizer

Added in API level 1
void setTokenizer (MultiAutoCompleteTextView.Tokenizer t)

Sets the Tokenizer that will be used to determine the relevant range of the text where the user is typing.

Parameters
t MultiAutoCompleteTextView.Tokenizer

Protected methods

performFiltering

Added in API level 1
void performFiltering (CharSequence text, 
                int keyCode)

Instead of filtering on the entire contents of the edit box, this subclass method filters on the range from findTokenStart(CharSequence, int) to getSelectionEnd() if the length of that range meets or exceeds getThreshold().

Parameters
text CharSequence: the filtering pattern
keyCode int: the last character inserted in the edit box; beware that this will be null when text is being added through a soft input method.

performFiltering

Added in API level 1
void performFiltering (CharSequence text, 
                int start, 
                int end, 
                int keyCode)

Starts filtering the content of the drop down list. The filtering pattern is the specified range of text from the edit box. Subclasses may override this method to filter with a different pattern, for instance a smaller substring of text.

Parameters
text CharSequence
start int
end int
keyCode int

replaceText

Added in API level 1
void replaceText (CharSequence text)

Performs the text completion by replacing the range from findTokenStart(CharSequence, int) to getSelectionEnd() by the the result of passing text through terminateToken(CharSequence). In addition, the replaced region will be marked as an AutoText substition so that if the user immediately presses DEL, the completion will be undone. Subclasses may override this method to do some different insertion of the content into the edit box.

Parameters
text CharSequence: the selected suggestion in the drop down list

Hooray!