com.otaliastudios.autocomplete

Interface AutocompletePolicy

All Known Implementing Classes:

Autocomplete.SimplePolicy, CharPolicy

public interface AutocompletePolicy

This interface controls when to show or hide the popup window, and, in the first case, what text should be passed to the popup AutocompletePresenter.

See Also:

for the simplest possible implementation

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getQuery(android.text.Spannable text) Called to understand which query should be passed to AutocompletePresenter for a showing popup.
void	onDismiss(android.text.Spannable text) Called when popup is dismissed.
boolean	shouldDismissPopup(android.text.Spannable text, int cursorPos) Called to understand whether a currently shown popup should be closed, maybe because text is invalid.
boolean	shouldShowPopup(android.text.Spannable text, int cursorPos) Called to understand whether the popup should be shown.

Method Detail

shouldShowPopup

boolean shouldShowPopup(android.text.Spannable text,
                        int cursorPos)

Called to understand whether the popup should be shown. Some naive examples: - Show when there's text: return text.length() > 0 - Show when last char is @: return text.getCharAt(text.length()-1) == '@'

Parameters:

text - current text, along with its Spans

cursorPos - the position of the cursor

Returns:

true if popup should be shown

shouldDismissPopup

boolean shouldDismissPopup(android.text.Spannable text,
                           int cursorPos)

Called to understand whether a currently shown popup should be closed, maybe because text is invalid. A reasonable implementation is return !shouldShowPopup(text, cursorPos). However this is defined so you can add or clear spans.

Parameters:

text - current text, along with its Spans

cursorPos - the position of the cursor

Returns:

true if popup should be hidden

getQuery

java.lang.CharSequence getQuery(android.text.Spannable text)

Called to understand which query should be passed to AutocompletePresenter for a showing popup. If this is called, shouldShowPopup(Spannable, int) just returned true, or shouldDismissPopup(Spannable, int) just returned false. This is useful to understand which part of the text should be passed to presenters. For example, user might have typed '@john' to select a username, but you just want to search for 'john'. For more complex cases, you can add inclusive Spans in shouldShowPopup(Spannable, int), and get the span position here.

Parameters:

text - current text, along with its Spans

Returns:

the query for presenter

onDismiss

void onDismiss(android.text.Spannable text)

Called when popup is dismissed. This can be used, for instance, to clear custom Spans from the text.

Parameters:

text - text at the moment of dismissing