public
class
AutoCompleteTextView
extends EditText
implements
Filter.FilterListener
java.lang.Object | ||||
↳ | android.view.View | |||
↳ | android.widget.TextView | |||
↳ | android.widget.EditText | |||
↳ | android.widget.AutoCompleteTextView |
Known Direct Subclasses |
Known Indirect Subclasses |
An editable text view 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 is obtained from a data adapter and appears
only after a given number of characters defined by
the threshold
.
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 icicle) { super.onCreate(icicle); setContentView(R.layout.countries); ArrayAdapter<String> adapter = new ArrayAdapter<String>(this, android.R.layout.simple_dropdown_item_1line, COUNTRIES); AutoCompleteTextView textView = (AutoCompleteTextView) findViewById(R.id.countries_list); textView.setAdapter(adapter); } private static final String[] COUNTRIES = new String[] { "Belgium", "France", "Italy", "Germany", "Spain" }; }
See the Text Fields guide.
Nested classes | ||
---|---|---|
interface |
AutoCompleteTextView.OnDismissListener
Listener to respond to the AutoCompleteTextView's completion list being dismissed. |
|
interface |
AutoCompleteTextView.Validator
This interface is used to make sure that the text entered in this TextView complies to a certain format. |
XML attributes | ||
---|---|---|
android:completionHint |
Defines the hint displayed in the drop down menu. | |
android:completionHintView |
Defines the hint view displayed in the drop down menu. | |
android:completionThreshold |
Defines the number of characters that the user must type before completion suggestions are displayed in a drop down menu. | |
android:dropDownAnchor |
View to anchor the auto-complete dropdown to. | |
android:dropDownHeight |
Specifies the basic height of the dropdown. | |
android:dropDownHorizontalOffset |
Amount of pixels by which the drop down should be offset horizontally. | |
android:dropDownSelector |
Selector in a drop down list. | |
android:dropDownVerticalOffset |
Amount of pixels by which the drop down should be offset vertically. | |
android:dropDownWidth |
Specifies the basic width of the dropdown. | |
android:popupBackground |
The background to use for the popup window. |
Inherited XML attributes | |
---|---|
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 | |
---|---|
AutoCompleteTextView(Context context)
Constructs a new auto-complete text view with the given context's theme. |
|
AutoCompleteTextView(Context context, AttributeSet attrs)
Constructs a new auto-complete text view with the given context's theme and the supplied attribute set. |
|
AutoCompleteTextView(Context context, AttributeSet attrs, int defStyleAttr)
Constructs a new auto-complete text view with the given context's theme, the supplied attribute set, and default style attribute. |
|
AutoCompleteTextView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Constructs a new auto-complete text view with the given context's theme, the supplied attribute set, and default styles. |
|
AutoCompleteTextView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes, Resources.Theme popupTheme)
Constructs a new auto-complete text view with the given context, the supplied attribute set, default styles, and the theme against which the completion popup should be inflated. |
Public methods | |
---|---|
void
|
clearListSelection()
Clear the list selection. |
void
|
dismissDropDown()
Closes the drop down if present on screen. |
boolean
|
enoughToFilter()
Returns |
ListAdapter
|
getAdapter()
Returns a filterable list adapter used for auto completion. |
CharSequence
|
getCompletionHint()
Gets the optional hint text displayed at the bottom of the the matching list. |
int
|
getDropDownAnchor()
Returns the id for the view that the auto-complete drop down list is anchored to. |
Drawable
|
getDropDownBackground()
Gets the background of the auto-complete drop-down list. |
int
|
getDropDownHeight()
Returns the current height for the auto-complete drop down list. |
int
|
getDropDownHorizontalOffset()
Gets the horizontal offset used for the auto-complete drop-down list. |
int
|
getDropDownVerticalOffset()
Gets the vertical offset used for the auto-complete drop-down list. |
int
|
getDropDownWidth()
Returns the current width for the auto-complete drop down list. |
AdapterView.OnItemClickListener
|
getItemClickListener()
This method was deprecated
in API level 3.
Use |
AdapterView.OnItemSelectedListener
|
getItemSelectedListener()
This method was deprecated
in API level 3.
Use |
int
|
getListSelection()
Get the position of the dropdown view selection, if there is one. |
AdapterView.OnItemClickListener
|
getOnItemClickListener()
Returns the listener that is notified whenever the user clicks an item in the drop down list. |
AdapterView.OnItemSelectedListener
|
getOnItemSelectedListener()
Returns the listener that is notified whenever the user selects an item in the drop down list. |
int
|
getThreshold()
Returns the number of characters the user must type before the drop down list is shown. |
AutoCompleteTextView.Validator
|
getValidator()
Returns the Validator set with |
boolean
|
isPerformingCompletion()
Identifies whether the view is currently performing a text completion, so subclasses can decide whether to respond to text changed events. |
boolean
|
isPopupShowing()
Indicates whether the popup menu is showing. |
void
|
onCommitCompletion(CompletionInfo completion)
Called by the framework in response to a text completion from
the current input method, provided by it calling
|
void
|
onFilterComplete(int count)
Notifies the end of a filtering operation. |
boolean
|
onKeyDown(int keyCode, KeyEvent event)
Default implementation of |
boolean
|
onKeyPreIme(int keyCode, KeyEvent event)
Handle a key event before it is processed by any input method associated with the view hierarchy. |
boolean
|
onKeyUp(int keyCode, KeyEvent event)
Default implementation of |
void
|
onWindowFocusChanged(boolean hasWindowFocus)
Called when the window containing this view gains or loses focus. |
void
|
performCompletion()
Performs the text completion by converting the selected item from the drop down list into a string, replacing the text box's content with this string and finally dismissing the drop down menu. |
void
|
performValidation()
If a validator was set on this view and the current string is not valid, ask the validator to fix it. |
<T extends ListAdapter & Filterable>
void
|
setAdapter(T adapter)
Changes the list of data used for auto completion. |
void
|
setCompletionHint(CharSequence hint)
Sets the optional hint text that is displayed at the bottom of the the matching list. |
void
|
setDropDownAnchor(int id)
Sets the view to which the auto-complete drop down list should anchor. |
void
|
setDropDownBackgroundDrawable(Drawable d)
Sets the background of the auto-complete drop-down list. |
void
|
setDropDownBackgroundResource(int id)
Sets the background of the auto-complete drop-down list. |
void
|
setDropDownHeight(int height)
Sets the current height for the auto-complete drop down list. |
void
|
setDropDownHorizontalOffset(int offset)
Sets the horizontal offset used for the auto-complete drop-down list. |
void
|
setDropDownVerticalOffset(int offset)
Sets the vertical offset used for the auto-complete drop-down list. |
void
|
setDropDownWidth(int width)
Sets the current width for the auto-complete drop down list. |
void
|
setListSelection(int position)
Set the position of the dropdown view selection. |
void
|
setOnClickListener(View.OnClickListener listener)
Register a callback to be invoked when this view is clicked. |
void
|
setOnDismissListener(AutoCompleteTextView.OnDismissListener dismissListener)
Set a listener that will be invoked whenever the AutoCompleteTextView's list of completions is dismissed. |
void
|
setOnItemClickListener(AdapterView.OnItemClickListener l)
Sets the listener that will be notified when the user clicks an item in the drop down list. |
void
|
setOnItemSelectedListener(AdapterView.OnItemSelectedListener l)
Sets the listener that will be notified when the user selects an item in the drop down list. |
void
|
setText(CharSequence text, boolean filter)
Like |
void
|
setThreshold(int threshold)
Specifies the minimum number of characters the user has to type in the edit box before the drop down list is shown. |
void
|
setValidator(AutoCompleteTextView.Validator validator)
Sets the validator used to perform text validation. |
void
|
showDropDown()
Displays the drop down on screen. |
Protected methods | |
---|---|
CharSequence
|
convertSelectionToString(Object selectedItem)
Converts the selected item from the drop down list into a sequence of character that can be used in the edit box. |
Filter
|
getFilter()
Returns the Filter obtained from |
void
|
onAttachedToWindow()
This is called when the view is attached to a window. |
void
|
onDetachedFromWindow()
This is called when the view is detached from a window. |
void
|
onDisplayHint(int hint)
Gives this view a hint about whether is displayed or not. |
void
|
onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect)
Called by the view system when the focus state of this view changes. |
void
|
performFiltering(CharSequence text, int keyCode)
Starts filtering the content of the drop down list. |
void
|
replaceText(CharSequence text)
Performs the text completion by replacing the current text by the selected item. |
boolean
|
setFrame(int l, int t, int r, int b)
Assign a size and position to this view. |
Inherited methods | |
---|---|
From
class
android.widget.EditText
| |
From
class
android.widget.TextView
| |
From
class
android.view.View
| |
From
class
java.lang.Object
| |
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
| |
From
interface
android.widget.Filter.FilterListener
|
Defines the hint displayed in the drop down menu.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
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 completionHint
.
Related methods:
Defines the hint view displayed in the drop down menu.
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 completionHintView
.
Defines the number of characters that the user must type before completion suggestions are displayed in a drop down menu.
Must be an integer value, such as "100
".
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 completionThreshold
.
Related methods:
View to anchor the auto-complete dropdown to. If not specified, the text view itself is used.
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 dropDownAnchor
.
Related methods:
Specifies the basic height of the dropdown. Its value may be a dimension (such as "12dip") for a constant height, fill_parent or match_parent to fill the height of the screen, or wrap_content to match the height of the content of the drop down.
May 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.
May be one of the following constant values.
Constant | Value | Description |
---|---|---|
fill_parent | -1 | The dropdown should fit the height of the screen.
This constant is deprecated starting from API Level 8 and
is replaced by match_parent . |
match_parent | -1 | The dropdown should fit the height of the screen. Introduced in API Level 8. |
wrap_content | -2 | The dropdown should fit the height of the content. |
This corresponds to the global attribute
resource symbol dropDownHeight
.
Related methods:
Amount of pixels by which the drop down should be offset horizontally.
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 dropDownHorizontalOffset
.
Related methods:
Selector in a drop down list.
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 dropDownSelector
.
Amount of pixels by which the drop down should be offset vertically.
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 dropDownVerticalOffset
.
Related methods:
Specifies the basic width of the dropdown. Its value may be a dimension (such as "12dip") for a constant width, fill_parent or match_parent to match the width of the screen, or wrap_content to match the width of the anchored view.
May 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.
May be one of the following constant values.
Constant | Value | Description |
---|---|---|
fill_parent | -1 | The dropdown should fill the width of the screen.
This constant is deprecated starting from API Level 8 and
is replaced by match_parent . |
match_parent | -1 | The dropdown should fit the width of the screen. Introduced in API Level 8. |
wrap_content | -2 | The dropdown should fit the width of its anchor. |
This corresponds to the global attribute
resource symbol dropDownWidth
.
Related methods:
The background to use for the popup window.
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 popupBackground
.
Related methods:
AutoCompleteTextView (Context context)
Constructs a new auto-complete text view with the given context's theme.
Parameters | |
---|---|
context |
Context :
The Context the view is running in, through which it can
access the current theme, resources, etc.
|
AutoCompleteTextView (Context context, AttributeSet attrs)
Constructs a new auto-complete text view with the given context's theme and the supplied attribute set.
Parameters | |
---|---|
context |
Context :
The Context the view is running in, through which it can
access the current theme, resources, etc. |
attrs |
AttributeSet :
The attributes of the XML tag that is inflating the view.
|
AutoCompleteTextView (Context context, AttributeSet attrs, int defStyleAttr)
Constructs a new auto-complete text view with the given context's theme, the supplied attribute set, and default style attribute.
Parameters | |
---|---|
context |
Context :
The Context the view is running in, through which it can
access the current theme, resources, etc. |
attrs |
AttributeSet :
The attributes of the XML tag that is inflating the view. |
defStyleAttr |
int :
An attribute in the current theme that contains a
reference to a style resource that supplies default
values for the view. Can be 0 to not look for
defaults.
|
AutoCompleteTextView (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Constructs a new auto-complete text view with the given context's theme, the supplied attribute set, and default styles.
Parameters | |
---|---|
context |
Context :
The Context the view is running in, through which it can
access the current theme, resources, etc. |
attrs |
AttributeSet :
The attributes of the XML tag that is inflating the view. |
defStyleAttr |
int :
An attribute in the current theme that contains a
reference to a style resource that supplies default
values for the view. Can be 0 to not look for
defaults. |
defStyleRes |
int :
A resource identifier of a style resource that
supplies default values for the view, used only if
defStyleAttr is 0 or can not be found in the theme.
Can be 0 to not look for defaults.
|
AutoCompleteTextView (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes, Resources.Theme popupTheme)
Constructs a new auto-complete text view with the given context, the supplied attribute set, default styles, and the theme against which the completion popup should be inflated.
Parameters | |
---|---|
context |
Context :
The context against which the view is inflated, which
provides access to the current theme, resources, etc. |
attrs |
AttributeSet :
The attributes of the XML tag that is inflating the view. |
defStyleAttr |
int :
An attribute in the current theme that contains a
reference to a style resource that supplies default
values for the view. Can be 0 to not look for
defaults. |
defStyleRes |
int :
A resource identifier of a style resource that
supplies default values for the view, used only if
defStyleAttr is 0 or can not be found in the theme.
Can be 0 to not look for defaults. |
popupTheme |
Resources.Theme :
The theme against which the completion popup window
should be inflated. May be null to use the
view theme. If set, this will override any value
specified by
AutoCompleteTextView_popupTheme .
|
void clearListSelection ()
Clear the list selection. This may only be temporary, as user input will often bring it back.
void dismissDropDown ()
Closes the drop down if present on screen.
boolean enoughToFilter ()
Returns true
if the amount of text in the field meets
or exceeds the getThreshold()
requirement. You can override
this to impose a different standard for when filtering will be
triggered.
Returns | |
---|---|
boolean |
ListAdapter getAdapter ()
Returns a filterable list adapter used for auto completion.
Returns | |
---|---|
ListAdapter |
a data adapter used for auto completion |
CharSequence getCompletionHint ()
Gets the optional hint text displayed at the bottom of the the matching list.
Related XML Attributes:
Returns | |
---|---|
CharSequence |
The hint text, if any |
See also:
int getDropDownAnchor ()
Returns the id for the view that the auto-complete drop down list is anchored to.
Related XML Attributes:
Returns | |
---|---|
int |
the view's id, or NO_ID if none specified |
Drawable getDropDownBackground ()
Gets the background of the auto-complete drop-down list.
Related XML Attributes:
Returns | |
---|---|
Drawable |
the background drawable |
int getDropDownHeight ()
Returns the current height for the auto-complete drop down list. This can
be a fixed height, or MATCH_PARENT
to fill
the screen, or WRAP_CONTENT
to fit the height
of the drop down's content.
Related XML Attributes:
Returns | |
---|---|
int |
the height for the drop down list |
int getDropDownHorizontalOffset ()
Gets the horizontal offset used for the auto-complete drop-down list.
Related XML Attributes:
Returns | |
---|---|
int |
the horizontal offset |
int getDropDownVerticalOffset ()
Gets the vertical offset used for the auto-complete drop-down list.
Related XML Attributes:
Returns | |
---|---|
int |
the vertical offset |
int getDropDownWidth ()
Returns the current width for the auto-complete drop down list. This can
be a fixed width, or MATCH_PARENT
to fill the screen, or
WRAP_CONTENT
to fit the width of its anchor view.
Related XML Attributes:
Returns | |
---|---|
int |
the width for the drop down list |
AdapterView.OnItemClickListener getItemClickListener ()
This method was deprecated
in API level 3.
Use getOnItemClickListener()
intead
Returns the listener that is notified whenever the user clicks an item in the drop down list.
Returns | |
---|---|
AdapterView.OnItemClickListener |
the item click listener |
AdapterView.OnItemSelectedListener getItemSelectedListener ()
This method was deprecated
in API level 3.
Use getOnItemSelectedListener()
intead
Returns the listener that is notified whenever the user selects an item in the drop down list.
Returns | |
---|---|
AdapterView.OnItemSelectedListener |
the item selected listener |
int getListSelection ()
Get the position of the dropdown view selection, if there is one. Returns
ListView.INVALID_POSITION
if there is no dropdown or if
there is no selection.
Returns | |
---|---|
int |
the position of the current selection, if there is one, or
ListView.INVALID_POSITION if not. |
See also:
AdapterView.OnItemClickListener getOnItemClickListener ()
Returns the listener that is notified whenever the user clicks an item in the drop down list.
Returns | |
---|---|
AdapterView.OnItemClickListener |
the item click listener |
AdapterView.OnItemSelectedListener getOnItemSelectedListener ()
Returns the listener that is notified whenever the user selects an item in the drop down list.
Returns | |
---|---|
AdapterView.OnItemSelectedListener |
the item selected listener |
int getThreshold ()
Returns the number of characters the user must type before the drop down list is shown.
Related XML Attributes:
Returns | |
---|---|
int |
the minimum number of characters to type to show the drop down |
See also:
AutoCompleteTextView.Validator getValidator ()
Returns the Validator set with setValidator(AutoCompleteTextView.Validator)
,
or null
if it was not set.
Returns | |
---|---|
AutoCompleteTextView.Validator |
boolean isPerformingCompletion ()
Identifies whether the view is currently performing a text completion, so subclasses can decide whether to respond to text changed events.
Returns | |
---|---|
boolean |
boolean isPopupShowing ()
Indicates whether the popup menu is showing.
Returns | |
---|---|
boolean |
true if the popup menu is showing, false otherwise |
void onCommitCompletion (CompletionInfo completion)
Called by the framework in response to a text completion from
the current input method, provided by it calling
InputConnection.commitCompletion()
. The default implementation does
nothing; text views that are supporting auto-completion should override
this to do their desired behavior.
Parameters | |
---|---|
completion |
CompletionInfo :
The auto complete text the user has selected.
|
void onFilterComplete (int count)
Notifies the end of a filtering operation.
Parameters | |
---|---|
count |
int :
the number of values computed by the filter
|
boolean onKeyDown (int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyDown()
: perform press of the view
when KEYCODE_DPAD_CENTER
or KEYCODE_ENTER
is released, if the view is enabled and clickable.
Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.
Parameters | |
---|---|
keyCode |
int :
a key code that represents the button pressed, from
KeyEvent |
event |
KeyEvent :
the KeyEvent object that defines the button action
|
Returns | |
---|---|
boolean |
If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false. |
boolean onKeyPreIme (int keyCode, KeyEvent event)
Handle a key event before it is processed by any input method associated with the view hierarchy. This can be used to intercept key events in special situations before the IME consumes them; a typical example would be handling the BACK key to update the application's UI instead of allowing the IME to see it and close itself.
Parameters | |
---|---|
keyCode |
int :
The value in event.getKeyCode(). |
event |
KeyEvent :
Description of the key event. |
Returns | |
---|---|
boolean |
If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false. |
boolean onKeyUp (int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyUp()
: perform clicking of the view
when KEYCODE_DPAD_CENTER
, KEYCODE_ENTER
or KEYCODE_SPACE
is released.
Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.
Parameters | |
---|---|
keyCode |
int :
A key code that represents the button pressed, from
KeyEvent . |
event |
KeyEvent :
The KeyEvent object that defines the button action.
|
Returns | |
---|---|
boolean |
If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false. |
void onWindowFocusChanged (boolean hasWindowFocus)
Called when the window containing this view gains or loses focus. Note that this is separate from view focus: to receive key events, both your view and its window must have focus. If a window is displayed on top of yours that takes input focus, then your own window will lose focus but the view focus will remain unchanged.
Parameters | |
---|---|
hasWindowFocus |
boolean :
True if the window containing this view now has
focus, false otherwise.
|
void performCompletion ()
Performs the text completion by converting the selected item from the drop down list into a string, replacing the text box's content with this string and finally dismissing the drop down menu.
void performValidation ()
If a validator was set on this view and the current string is not valid, ask the validator to fix it.
void setAdapter (T adapter)
Changes the list of data used for auto completion. The provided list must be a filterable list adapter.
The caller is still responsible for managing any resources used by the adapter.
Notably, when the AutoCompleteTextView is closed or released, the adapter is not notified.
A common case is the use of CursorAdapter
, which
contains a Cursor
that must be closed. This can be done
automatically (see
startManagingCursor()
),
or by manually closing the cursor when the AutoCompleteTextView is dismissed.
Parameters | |
---|---|
adapter |
T :
the adapter holding the auto completion data |
See also:
void setCompletionHint (CharSequence hint)
Sets the optional hint text that is displayed at the bottom of the the matching list. This can be used as a cue to the user on how to best use the list, or to provide extra information.
Related XML Attributes:
Parameters | |
---|---|
hint |
CharSequence :
the text to be displayed to the user |
See also:
void setDropDownAnchor (int id)
Sets the view to which the auto-complete drop down list should anchor. The view corresponding to this id will not be loaded until the next time it is needed to avoid loading a view which is not yet instantiated.
Related XML Attributes:
Parameters | |
---|---|
id |
int :
the id to anchor the drop down list view to |
void setDropDownBackgroundDrawable (Drawable d)
Sets the background of the auto-complete drop-down list.
Related XML Attributes:
Parameters | |
---|---|
d |
Drawable :
the drawable to set as the background |
void setDropDownBackgroundResource (int id)
Sets the background of the auto-complete drop-down list.
Related XML Attributes:
Parameters | |
---|---|
id |
int :
the id of the drawable to set as the background |
void setDropDownHeight (int height)
Sets the current height for the auto-complete drop down list. This can
be a fixed height, or MATCH_PARENT
to fill
the screen, or WRAP_CONTENT
to fit the height
of the drop down's content.
Related XML Attributes:
Parameters | |
---|---|
height |
int :
the height to use |
void setDropDownHorizontalOffset (int offset)
Sets the horizontal offset used for the auto-complete drop-down list.
Related XML Attributes:
Parameters | |
---|---|
offset |
int :
the horizontal offset |
void setDropDownVerticalOffset (int offset)
Sets the vertical offset used for the auto-complete drop-down list.
Related XML Attributes:
Parameters | |
---|---|
offset |
int :
the vertical offset |
void setDropDownWidth (int width)
Sets the current width for the auto-complete drop down list. This can
be a fixed width, or MATCH_PARENT
to fill the screen, or
WRAP_CONTENT
to fit the width of its anchor view.
Related XML Attributes:
Parameters | |
---|---|
width |
int :
the width to use |
void setListSelection (int position)
Set the position of the dropdown view selection.
Parameters | |
---|---|
position |
int :
The position to move the selector to.
|
void setOnClickListener (View.OnClickListener listener)
Register a callback to be invoked when this view is clicked. If this view is not clickable, it becomes clickable.
Parameters | |
---|---|
listener |
View.OnClickListener :
The callback that will run |
void setOnDismissListener (AutoCompleteTextView.OnDismissListener dismissListener)
Set a listener that will be invoked whenever the AutoCompleteTextView's list of completions is dismissed.
Parameters | |
---|---|
dismissListener |
AutoCompleteTextView.OnDismissListener :
Listener to invoke when completions are dismissed
|
void setOnItemClickListener (AdapterView.OnItemClickListener l)
Sets the listener that will be notified when the user clicks an item in the drop down list.
Parameters | |
---|---|
l |
AdapterView.OnItemClickListener :
the item click listener
|
void setOnItemSelectedListener (AdapterView.OnItemSelectedListener l)
Sets the listener that will be notified when the user selects an item in the drop down list.
Parameters | |
---|---|
l |
AdapterView.OnItemSelectedListener :
the item selected listener
|
void setText (CharSequence text, boolean filter)
Like setText(CharSequence)
, except that it can disable filtering.
Parameters | |
---|---|
text |
CharSequence
|
filter |
boolean :
If false , no filtering will be performed
as a result of this call.
|
void setThreshold (int threshold)
Specifies the minimum number of characters the user has to type in the edit box before the drop down list is shown.
When threshold
is less than or equals 0, a threshold of
1 is applied.
Related XML Attributes:
Parameters | |
---|---|
threshold |
int :
the number of characters to type before the drop down
is shown |
See also:
void setValidator (AutoCompleteTextView.Validator validator)
Sets the validator used to perform text validation.
Parameters | |
---|---|
validator |
AutoCompleteTextView.Validator :
The validator used to validate the text entered in this widget. |
See also:
CharSequence convertSelectionToString (Object selectedItem)
Converts the selected item from the drop down list into a sequence of character that can be used in the edit box.
Parameters | |
---|---|
selectedItem |
Object :
the item selected by the user for completion |
Returns | |
---|---|
CharSequence |
a sequence of characters representing the selected suggestion |
Filter getFilter ()
Returns the Filter obtained from getFilter()
,
or null
if setAdapter(T)
was not called with
a Filterable.
Returns | |
---|---|
Filter |
void onAttachedToWindow ()
This is called when the view is attached to a window. At this point it
has a Surface and will start drawing. Note that this function is
guaranteed to be called before onDraw(android.graphics.Canvas)
,
however it may be called any time before the first onDraw -- including
before or after onMeasure(int, int)
.
void onDetachedFromWindow ()
This is called when the view is detached from a window. At this point it no longer has a surface for drawing.
void onDisplayHint (int hint)
Gives this view a hint about whether is displayed or not. For instance, when a View moves out of the screen, it might receives a display hint indicating the view is not displayed. Applications should not rely on this hint as there is no guarantee that they will receive one.
Parameters | |
---|---|
hint |
int :
A hint about whether or not this view is displayed:
VISIBLE or INVISIBLE .
|
void onFocusChanged (boolean focused, int direction, Rect previouslyFocusedRect)
Called by the view system when the focus state of this view changes. When the focus change event is caused by directional navigation, direction and previouslyFocusedRect provide insight into where the focus is coming from. When overriding, be sure to call up through to the super class so that the standard focus handling will occur.
Parameters | |
---|---|
focused |
boolean :
True if the View has focus; false otherwise. |
direction |
int :
The direction focus has moved when requestFocus()
is called to give this view focus. Values are
FOCUS_UP , FOCUS_DOWN , FOCUS_LEFT ,
FOCUS_RIGHT , FOCUS_FORWARD , or FOCUS_BACKWARD .
It may not always apply, in which case use the default. |
previouslyFocusedRect |
Rect :
The rectangle, in this view's coordinate
system, of the previously focused view. If applicable, this will be
passed in as finer grained information about where the focus is coming
from (in addition to direction). Will be null otherwise.
|
void performFiltering (CharSequence text, int keyCode)
Starts filtering the content of the drop down list. The filtering
pattern is the content of the edit box. Subclasses should override this
method to filter with a different pattern, for instance a substring of
text
.
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.
|
void replaceText (CharSequence text)
Performs the text completion by replacing the current text by the selected item. Subclasses should override this method to avoid replacing the whole content of the edit box.
Parameters | |
---|---|
text |
CharSequence :
the selected suggestion in the drop down list
|
boolean setFrame (int l, int t, int r, int b)
Assign a size and position to this view. This is called from layout.
Parameters | |
---|---|
l |
int :
Left position, relative to parent |
t |
int :
Top position, relative to parent |
r |
int :
Right position, relative to parent |
b |
int :
Bottom position, relative to parent |
Returns | |
---|---|
boolean |
true if the new size and position are different than the previous ones |