com.otaliastudios.autocomplete

Class Autocomplete<T>

java.lang.Object

com.otaliastudios.autocomplete.Autocomplete<T>

All Implemented Interfaces:

android.text.NoCopySpan, android.text.SpanWatcher, android.text.TextWatcher

public final class Autocomplete<T>
extends java.lang.Object
implements android.text.TextWatcher, android.text.SpanWatcher

Entry point for adding Autocomplete behavior to a EditText. You can construct a Autocomplete using the builder provided by on(EditText). Building is enough, but you can hold a reference to this class to call its public methods. Requires: - EditText: this is both the anchor for the popup, and the source of text events that we listen to - AutocompletePresenter: this presents items in the popup window. See class for more info. - AutocompleteCallback: if specified, this listens to click events and visibility changes - AutocompletePolicy: if specified, this controls how and when to show the popup based on text events If not, this defaults to Autocomplete.SimplePolicy: shows the popup when text.length() bigger than 0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Autocomplete.Builder<T> Builder for building Autocomplete.
static class	Autocomplete.SimplePolicy A very simple AutocompletePolicy implementation.

Nested classes/interfaces inherited from interface android.text.NoCopySpan

android.text.NoCopySpan.Concrete

Method Summary

Modifier and Type	Method and Description
void	afterTextChanged(android.text.Editable s)
void	beforeTextChanged(java.lang.CharSequence s, int start, int count, int after)
void	dismissPopup() Dismisses the popup, if showing.
boolean	isPopupShowing() Returns true if the popup is showing.
static <T> Autocomplete.Builder<T>	on(android.widget.EditText anchor) Entry point for building autocomplete on a certain EditText.
void	onSpanAdded(android.text.Spannable text, java.lang.Object what, int start, int end)
void	onSpanChanged(android.text.Spannable text, java.lang.Object what, int ostart, int oend, int nstart, int nend)
void	onSpanRemoved(android.text.Spannable text, java.lang.Object what, int start, int end)
void	onTextChanged(java.lang.CharSequence s, int start, int before, int count)
void	setEnabled(boolean enabled) Switch to control the autocomplete behavior.
void	setGravity(int gravity) Sets the gravity for the popup.
void	setOffsetFromAnchor(int offset) Controls the vertical offset of the popup from the EditText anchor.
void	setOutsideTouchable(boolean outsideTouchable) Controls whether the popup should listen to clicks outside its boundaries.
void	showPopup(java.lang.CharSequence query) Shows the popup with the given query.

Methods inherited from class java.lang.Object

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

Method Detail

on

public static <T> Autocomplete.Builder<T> on(android.widget.EditText anchor)

Entry point for building autocomplete on a certain EditText.

Type Parameters:

T - your data model

Parameters:

anchor - the anchor for the popup, and the source of text events

Returns:

a Builder for set up

showPopup

public void showPopup(java.lang.CharSequence query)

Shows the popup with the given query. There is rarely need to call this externally: it is already triggered by events on the anchor. To control when this is called, provide a good implementation of AutocompletePolicy.

Parameters:

query - query text.

dismissPopup

public void dismissPopup()

Dismisses the popup, if showing. There is rarely need to call this externally: it is already triggered by events on the anchor. To control when this is called, provide a good implementation of AutocompletePolicy.

isPopupShowing

public boolean isPopupShowing()

Returns true if the popup is showing.

Returns:

whether the popup is currently showing

setEnabled

public void setEnabled(boolean enabled)

Switch to control the autocomplete behavior. When disabled, no popup is shown. This is useful if you want to do runtime edits to the anchor text, without triggering the popup.

Parameters:

enabled - whether to enable autocompletion

setGravity

public void setGravity(int gravity)

Sets the gravity for the popup. Basically only Gravity.START and Gravity.END do work.

Parameters:

gravity - gravity for the popup

setOffsetFromAnchor

public void setOffsetFromAnchor(int offset)

Controls the vertical offset of the popup from the EditText anchor.

Parameters:

offset - offset in pixels.

setOutsideTouchable

public void setOutsideTouchable(boolean outsideTouchable)

Controls whether the popup should listen to clicks outside its boundaries.

Parameters:

outsideTouchable - true to listen to outside clicks

beforeTextChanged

public void beforeTextChanged(java.lang.CharSequence s,
                              int start,
                              int count,
                              int after)

Specified by:

beforeTextChanged in interface android.text.TextWatcher

onTextChanged

public void onTextChanged(java.lang.CharSequence s,
                          int start,
                          int before,
                          int count)

Specified by:

onTextChanged in interface android.text.TextWatcher

afterTextChanged

public void afterTextChanged(android.text.Editable s)

Specified by:

afterTextChanged in interface android.text.TextWatcher

onSpanAdded

public void onSpanAdded(android.text.Spannable text,
                        java.lang.Object what,
                        int start,
                        int end)

Specified by:

onSpanAdded in interface android.text.SpanWatcher

onSpanRemoved

public void onSpanRemoved(android.text.Spannable text,
                          java.lang.Object what,
                          int start,
                          int end)

Specified by:

onSpanRemoved in interface android.text.SpanWatcher

onSpanChanged

public void onSpanChanged(android.text.Spannable text,
                          java.lang.Object what,
                          int ostart,
                          int oend,
                          int nstart,
                          int nend)

Specified by:

onSpanChanged in interface android.text.SpanWatcher