com.tokenautocomplete

Class TokenCompleteTextView<T>

java.lang.Object

AppCompatAutoCompleteTextView

com.tokenautocomplete.TokenCompleteTextView<T>

All Implemented Interfaces:

android.widget.TextView.OnEditorActionListener, ViewSpan.Layout

public abstract class TokenCompleteTextView<T>
extends AppCompatAutoCompleteTextView
implements android.widget.TextView.OnEditorActionListener, ViewSpan.Layout

GMail style auto complete view with easy token customization override getViewForObject to provide your token view
Created by mgod on 9/12/13.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenCompleteTextView.TokenClickStyle
protected class	TokenCompleteTextView.TokenImageSpan
static interface	TokenCompleteTextView.TokenListener<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
TokenCompleteTextView(android.content.Context context)
TokenCompleteTextView(android.content.Context context, android.util.AttributeSet attrs)
TokenCompleteTextView(android.content.Context context, android.util.AttributeSet attrs, int defStyle)

Method Summary

Modifier and Type	Method and Description
protected void	addListeners() Add the TextChangedListeners
void	addObjectAsync(T object) Append a token object to the object list.
void	addObjectSync(T object) Append a token object to the object list.
void	allowCollapse(boolean allowCollapse) Set whether the view should collapse to a single line when it loses focus.
protected TokenCompleteTextView.TokenImageSpan	buildSpanForObject(T obj)
boolean	canDeleteSelection(int beforeLength) Checks if selection can be deleted.
void	clearAsync() Remove all objects from the token list.
void	clearCompletionText() Clear the completion text only.
protected java.lang.CharSequence	convertSelectionToString(java.lang.Object object)
protected java.util.List<T>	convertSerializableObjectsToTypedObjects(java.util.List s)
protected java.lang.String	currentCompletionText()
protected abstract T	defaultObject(java.lang.String completionText) Provides a default completion when the user hits , and there is no item in the completion list
boolean	enoughToFilter()
boolean	extractText(android.view.inputmethod.ExtractedTextRequest request, android.view.inputmethod.ExtractedText outText)
java.lang.CharSequence	getContentText() Get the content entered in the text field, including hidden text when ellipsized
int	getMaxViewSpanWidth()
java.util.List<T>	getObjects() Get the list of Tokens
protected java.util.List<java.io.Serializable>	getSerializableObjects()
java.lang.CharSequence	getTextForAccessibility() Correctly build accessibility string for token contents This seems to be a hidden API, but there doesn't seem to be another reasonable way
protected abstract android.view.View	getViewForObject(T object) A token view for the object
void	invalidate()
boolean	isTokenRemovable(T token) Override if you want to prevent a token from being removed.
protected float	maxTextWidth()
android.view.inputmethod.InputConnection	onCreateInputConnection(android.view.inputmethod.EditorInfo outAttrs)
boolean	onEditorAction(android.widget.TextView view, int action, android.view.KeyEvent keyEvent)
void	onFocusChanged(boolean hasFocus, int direction, android.graphics.Rect previous)
void	onInitializeAccessibilityEvent(android.view.accessibility.AccessibilityEvent event)
boolean	onKeyDown(int keyCode, android.view.KeyEvent event)
boolean	onKeyUp(int keyCode, android.view.KeyEvent event)
protected void	onLayout(boolean changed, int left, int top, int right, int bottom)
void	onRestoreInstanceState(android.os.Parcelable state)
android.os.Parcelable	onSaveInstanceState()
protected void	onSelectionChanged(int selStart, int selEnd)
protected void	onTextChanged(java.lang.CharSequence text, int start, int lengthBefore, int lengthAfter)
boolean	onTouchEvent(android.view.MotionEvent event)
void	performBestGuess(boolean guess) Set whether we try to guess an entry from the autocomplete spinner or just use the defaultObject implementation for inline token completion.
void	performCollapse(boolean hasFocus) Collapse the view by removing all the tokens not on the first line.
void	performCompletion()
protected void	performFiltering(java.lang.CharSequence text, int keyCode)
void	preventFreeFormText(boolean prevent) If set to true, the only content in this view will be the tokens and the current completion text.
protected void	removeListeners() Remove the TextChangedListeners
void	removeObjectAsync(T object) Remove an object from the token list.
void	removeObjectSync(T object) Remove an object from the token list.
protected void	replaceText(java.lang.CharSequence ignore)
void	setPrefix(java.lang.CharSequence p) A String of text that is shown before all the tokens inside the EditText (Think "To: " in an email address field.
void	setPrefix(java.lang.CharSequence prefix, int color) You can get a color integer either using androidx.core.content.ContextCompat#getColor(android.content.Context, int) or with Color.parseColor(String).
void	setTokenClickStyle(TokenCompleteTextView.TokenClickStyle cStyle) Set the action to be taken when a Token is clicked
void	setTokenizer(Tokenizer t)
void	setTokenLimit(int tokenLimit) Set a number of tokens limit.
void	setTokenListener(TokenCompleteTextView.TokenListener<T> l) Set the listener that will be notified of changes in the Token list
boolean	shouldIgnoreToken(T token) Override if you want to prevent a token from being added.
protected java.lang.CharSequence	tokenToString(T token) Override if you need custom logic to provide a sting representation of a token

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

TokenCompleteTextView

public TokenCompleteTextView(android.content.Context context)

TokenCompleteTextView

public TokenCompleteTextView(android.content.Context context,
                             android.util.AttributeSet attrs)

TokenCompleteTextView

public TokenCompleteTextView(android.content.Context context,
                             android.util.AttributeSet attrs,
                             int defStyle)

Method Detail

addListeners

protected void addListeners()

Add the TextChangedListeners

removeListeners

protected void removeListeners()

Remove the TextChangedListeners

performFiltering

protected void performFiltering(java.lang.CharSequence text,
                                int keyCode)

setTokenizer

public void setTokenizer(Tokenizer t)

setTokenClickStyle

public void setTokenClickStyle(TokenCompleteTextView.TokenClickStyle cStyle)

Set the action to be taken when a Token is clicked

Parameters:

cStyle - The TokenClickStyle

setTokenListener

public void setTokenListener(TokenCompleteTextView.TokenListener<T> l)

Set the listener that will be notified of changes in the Token list

Parameters:

l - The TokenListener

shouldIgnoreToken

public boolean shouldIgnoreToken(T token)

Override if you want to prevent a token from being added. Defaults to false.

Parameters:

token - the token to check

Returns:

true if the token should not be added, false if it's ok to add it.

isTokenRemovable

public boolean isTokenRemovable(T token)

Override if you want to prevent a token from being removed. Defaults to true.

Parameters:

token - the token to check

Returns:

false if the token should not be removed, true if it's ok to remove it.

setPrefix

public void setPrefix(java.lang.CharSequence p)

A String of text that is shown before all the tokens inside the EditText (Think "To: " in an email address field. I would advise against this: use a label and a hint.

Parameters:

p - String with the hint

setPrefix

public void setPrefix(java.lang.CharSequence prefix,
                      int color)

You can get a color integer either using androidx.core.content.ContextCompat#getColor(android.content.Context, int) or with Color.parseColor(String).

Color.parseColor(String) accepts these formats (copied from android.graphics.Color): You can use: '#RRGGBB', '#AARRGGBB' or one of the following names: 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray', 'grey', 'lightgrey', 'darkgrey', 'aqua', 'fuchsia', 'lime', 'maroon', 'navy', 'olive', 'purple', 'silver', 'teal'.

Parameters:

prefix - prefix

color - A single color value in the form 0xAARRGGBB.

getObjects

public java.util.List<T> getObjects()

Get the list of Tokens

Returns:

List of tokens

getContentText

public java.lang.CharSequence getContentText()

Get the content entered in the text field, including hidden text when ellipsized

Returns:

CharSequence of the entered content

performBestGuess

public void performBestGuess(boolean guess)

Set whether we try to guess an entry from the autocomplete spinner or just use the defaultObject implementation for inline token completion.

Parameters:

guess - true to enable guessing

preventFreeFormText

public void preventFreeFormText(boolean prevent)

If set to true, the only content in this view will be the tokens and the current completion text. Use this setting to create things like lists of email addresses. If false, it the view will allow text in addition to tokens. Use this if you want to use the token search to find things like user names or hash tags to put in with text.

Parameters:

prevent - true to prevent non-token text. Defaults to true.

allowCollapse

public void allowCollapse(boolean allowCollapse)

Set whether the view should collapse to a single line when it loses focus.

Parameters:

allowCollapse - true if it should collapse

setTokenLimit

public void setTokenLimit(int tokenLimit)

Set a number of tokens limit.

Parameters:

tokenLimit - The number of tokens permitted. -1 value disables limit.

getViewForObject

protected abstract android.view.View getViewForObject(T object)

A token view for the object

Parameters:

object - the object selected by the user from the list

Returns:

a view to display a token in the text field for the object

defaultObject

protected abstract T defaultObject(java.lang.String completionText)

Provides a default completion when the user hits , and there is no item in the completion list

Parameters:

completionText - the current text we are completing against

Returns:

a best guess for what the user meant to complete or null if you don't want a guess

getTextForAccessibility

public java.lang.CharSequence getTextForAccessibility()

Correctly build accessibility string for token contents This seems to be a hidden API, but there doesn't seem to be another reasonable way

Returns:

custom string for accessibility

clearCompletionText

public void clearCompletionText()

Clear the completion text only.

onInitializeAccessibilityEvent

public void onInitializeAccessibilityEvent(android.view.accessibility.AccessibilityEvent event)

tokenToString

protected java.lang.CharSequence tokenToString(T token)

Override if you need custom logic to provide a sting representation of a token

Parameters:

token - the token to convert

Returns:

the string representation of the token. Defaults to Object.toString()

currentCompletionText

protected java.lang.String currentCompletionText()

maxTextWidth

protected float maxTextWidth()

getMaxViewSpanWidth

public int getMaxViewSpanWidth()

Specified by:

getMaxViewSpanWidth in interface ViewSpan.Layout

invalidate

public void invalidate()

enoughToFilter

public boolean enoughToFilter()

performCompletion

public void performCompletion()

onCreateInputConnection

public android.view.inputmethod.InputConnection onCreateInputConnection(@NonNull
                                                                        android.view.inputmethod.EditorInfo outAttrs)

onKeyUp

public boolean onKeyUp(int keyCode,
                       @NonNull
                       android.view.KeyEvent event)

onKeyDown

public boolean onKeyDown(int keyCode,
                         @NonNull
                         android.view.KeyEvent event)

onEditorAction

public boolean onEditorAction(android.widget.TextView view,
                              int action,
                              android.view.KeyEvent keyEvent)

Specified by:

onEditorAction in interface android.widget.TextView.OnEditorActionListener

onTouchEvent

public boolean onTouchEvent(@NonNull
                            android.view.MotionEvent event)

onSelectionChanged

protected void onSelectionChanged(int selStart,
                                  int selEnd)

onLayout

protected void onLayout(boolean changed,
                        int left,
                        int top,
                        int right,
                        int bottom)

performCollapse

public void performCollapse(boolean hasFocus)

Collapse the view by removing all the tokens not on the first line. Displays a "+x" token. Restores the hidden tokens when the view gains focus.

Parameters:

hasFocus - boolean indicating whether we have the focus or not.

onFocusChanged

public void onFocusChanged(boolean hasFocus,
                           int direction,
                           android.graphics.Rect previous)

convertSelectionToString

protected java.lang.CharSequence convertSelectionToString(java.lang.Object object)

buildSpanForObject

protected TokenCompleteTextView.TokenImageSpan buildSpanForObject(T obj)

replaceText

protected void replaceText(java.lang.CharSequence ignore)

extractText

public boolean extractText(@NonNull
                           android.view.inputmethod.ExtractedTextRequest request,
                           @NonNull
                           android.view.inputmethod.ExtractedText outText)

addObjectSync

@UiThread
public void addObjectSync(T object)

Append a token object to the object list. May only be called from the main thread.

Parameters:

object - the object to add to the displayed tokens

addObjectAsync

public void addObjectAsync(T object)

Append a token object to the object list. Object will be added on the main thread.

Parameters:

object - the object to add to the displayed tokens

removeObjectSync

@UiThread
public void removeObjectSync(T object)

Remove an object from the token list. Will remove duplicates if present or do nothing if no object is present in the view. Uses Object.equals(Object) to find objects. May only be called from the main thread

Parameters:

object - object to remove, may be null or not in the view

removeObjectAsync

public void removeObjectAsync(T object)

Remove an object from the token list. Will remove duplicates if present or do nothing if no object is present in the view. Uses Object.equals(Object) to find objects. Object will be added on the main thread

Parameters:

object - object to remove, may be null or not in the view

clearAsync

public void clearAsync()

Remove all objects from the token list. Objects will be removed on the main thread.

getSerializableObjects

protected java.util.List<java.io.Serializable> getSerializableObjects()

convertSerializableObjectsToTypedObjects

protected java.util.List<T> convertSerializableObjectsToTypedObjects(java.util.List s)

onSaveInstanceState

public android.os.Parcelable onSaveInstanceState()

onRestoreInstanceState

public void onRestoreInstanceState(android.os.Parcelable state)

canDeleteSelection

public boolean canDeleteSelection(int beforeLength)

Checks if selection can be deleted. This method is called from TokenInputConnection .

Parameters:

beforeLength - the number of characters before the current selection end to check

Returns:

true if there are no non-deletable pieces of the section

onTextChanged

protected void onTextChanged(java.lang.CharSequence text,
                             int start,
                             int lengthBefore,
                             int lengthAfter)