com.otaliastudios.autocomplete

Class CharPolicy

java.lang.Object

com.otaliastudios.autocomplete.CharPolicy

All Implemented Interfaces:

AutocompletePolicy

public class CharPolicy
extends java.lang.Object
implements AutocompletePolicy

A special AutocompletePolicy for cases when you want to trigger the popup when a certain character is shown. For instance, this might be the case for hashtags ('#') or usernames ('@') or whatever you wish. Passing this to Autocomplete.Builder ensures the following behavior (assuming '@'): - text "@john" : presenter will be passed the query "john" - text "You should see this @j" : presenter will be passed the query "j" - text "You should see this @john @m" : presenter will be passed the query "m"

Constructor Summary

Constructors

Constructor and Description
CharPolicy(char trigger) Constructs a char policy for the given character.
CharPolicy(char trigger, boolean needSpaceBefore) Constructs a char policy for the given character.

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.
static int[]	getQueryRange(android.text.Spannable text) Returns the current query out of the given Spannable.
protected boolean	isValidChar(char ch) Can be overriden to understand which characters are valid.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharPolicy

public CharPolicy(char trigger)

Constructs a char policy for the given character.

Parameters:

trigger - the triggering character.

CharPolicy

public CharPolicy(char trigger,
                  boolean needSpaceBefore)

Constructs a char policy for the given character. You can choose whether a whitespace is needed before 'trigger'.

Parameters:

trigger - the triggering character.

needSpaceBefore - whether we need a space before trigger

Method Detail

isValidChar

protected boolean isValidChar(char ch)

Can be overriden to understand which characters are valid. The default implementation returns true for any character except whitespaces.

Parameters:

ch - the character

Returns:

whether it's valid part of a query

shouldShowPopup

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

Description copied from interface: AutocompletePolicy

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) == '@'

Specified by:

shouldShowPopup in interface AutocompletePolicy

Parameters:

text - current text, along with its Spans

cursorPos - the position of the cursor

Returns:

true if popup should be shown

shouldDismissPopup

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

Description copied from interface: AutocompletePolicy

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.

Specified by:

shouldDismissPopup in interface AutocompletePolicy

Parameters:

text - current text, along with its Spans

cursorPos - the position of the cursor

Returns:

true if popup should be hidden

getQuery

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

Description copied from interface: AutocompletePolicy

Called to understand which query should be passed to AutocompletePresenter for a showing popup. If this is called, AutocompletePolicy.shouldShowPopup(Spannable, int) just returned true, or AutocompletePolicy.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 AutocompletePolicy.shouldShowPopup(Spannable, int), and get the span position here.

Specified by:

getQuery in interface AutocompletePolicy

Parameters:

text - current text, along with its Spans

Returns:

the query for presenter

onDismiss

public void onDismiss(android.text.Spannable text)

Description copied from interface: AutocompletePolicy

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

Specified by:

onDismiss in interface AutocompletePolicy

Parameters:

text - text at the moment of dismissing

getQueryRange

@Nullable
public static int[] getQueryRange(android.text.Spannable text)

Returns the current query out of the given Spannable.

Parameters:

text - the anchor text

Returns:

an int[] with query start and query end positions