com.hootsuite.nachos.terminator

Interface ChipTerminatorHandler

All Known Implementing Classes:

DefaultChipTerminatorHandler

public interface ChipTerminatorHandler

This interface is used to handle the management of characters that should trigger the creation of chips in a text view.

See Also:

ChipTokenizer

Field Summary

Fields

Modifier and Type	Field and Description
static int	BEHAVIOR_CHIPIFY_ALL When a chip terminator character is encountered in newly inserted text, all tokens in the whole text view will be chipified
static int	BEHAVIOR_CHIPIFY_CURRENT_TOKEN When a chip terminator character is encountered in newly inserted text, only the current token (that in which the chip terminator character was found) will be chipified.
static int	BEHAVIOR_CHIPIFY_TO_TERMINATOR When a chip terminator character is encountered in newly inserted text, only the text from the previous chip up until the chip terminator character will be chipified.
static int	PASTE_BEHAVIOR_USE_DEFAULT Constant for use with setPasteBehavior(int).

Method Summary

Modifier and Type	Method and Description
void	addChipTerminator(char character, int behavior) Adds a character as a chip terminator.
int	findAndHandleChipTerminators(ChipTokenizer tokenizer, android.text.Editable text, int start, int end, boolean isPasteEvent) Parses the provided text looking for characters marked as chip terminators through addChipTerminator(char, int) and setChipTerminators(Map).
void	setChipTerminators(java.util.Map<java.lang.Character,java.lang.Integer> chipTerminators) Sets all the characters that will be marked as chip terminators.
void	setPasteBehavior(int pasteBehavior) Customizes the way paste events are handled.

Field Detail

BEHAVIOR_CHIPIFY_ALL

static final int BEHAVIOR_CHIPIFY_ALL

When a chip terminator character is encountered in newly inserted text, all tokens in the whole text view will be chipified

See Also:

Constant Field Values

BEHAVIOR_CHIPIFY_CURRENT_TOKEN

static final int BEHAVIOR_CHIPIFY_CURRENT_TOKEN

When a chip terminator character is encountered in newly inserted text, only the current token (that in which the chip terminator character was found) will be chipified. This token may extend beyond where the chip terminator character was located.

See Also:

Constant Field Values

BEHAVIOR_CHIPIFY_TO_TERMINATOR

static final int BEHAVIOR_CHIPIFY_TO_TERMINATOR

When a chip terminator character is encountered in newly inserted text, only the text from the previous chip up until the chip terminator character will be chipified. This may not be an entire token.

See Also:

Constant Field Values

PASTE_BEHAVIOR_USE_DEFAULT

static final int PASTE_BEHAVIOR_USE_DEFAULT

Constant for use with setPasteBehavior(int). Use this if a paste should behave the same as a standard text input (the chip temrinators will all behave according to their pre-determined behavior set through addChipTerminator(char, int) or setChipTerminators(Map)).

See Also:

Constant Field Values

Method Detail

setChipTerminators

void setChipTerminators(java.util.Map<java.lang.Character,java.lang.Integer> chipTerminators)

Sets all the characters that will be marked as chip terminators. This will replace any previously set chip terminators.

Parameters:

chipTerminators - a map of characters to be marked as chip terminators to behaviors that describe how to respond to the characters, or null to remove all chip terminators

addChipTerminator

void addChipTerminator(char character,
                       int behavior)

Adds a character as a chip terminator. When the provided character is encountered in entered text, the nearby text will be chipified according to the behavior provided here. behavior Must be one of:

• BEHAVIOR_CHIPIFY_ALL
• BEHAVIOR_CHIPIFY_CURRENT_TOKEN
• BEHAVIOR_CHIPIFY_TO_TERMINATOR

Parameters:

character - the character to mark as a chip terminator

behavior - the behavior describing how to respond to the chip terminator

setPasteBehavior

void setPasteBehavior(int pasteBehavior)

Customizes the way paste events are handled. If one of:

• BEHAVIOR_CHIPIFY_ALL
• BEHAVIOR_CHIPIFY_CURRENT_TOKEN
• BEHAVIOR_CHIPIFY_TO_TERMINATOR

is passed, all chip terminators will be handled with that behavior when a paste event occurs. If PASTE_BEHAVIOR_USE_DEFAULT is passed, whatever behavior is configured for a particular chip terminator (through setChipTerminators(Map) or addChipTerminator(char, int) will be used for that chip terminator

Parameters:

pasteBehavior - the behavior to use on a paste event

findAndHandleChipTerminators

int findAndHandleChipTerminators(ChipTokenizer tokenizer,
                                 android.text.Editable text,
                                 int start,
                                 int end,
                                 boolean isPasteEvent)

Parses the provided text looking for characters marked as chip terminators through addChipTerminator(char, int) and setChipTerminators(Map). The provided Editable will be modified if chip terminators are encountered.

Parameters:

tokenizer - the ChipTokenizer to use to identify and chipify tokens in the text

text - the text in which to search for chip terminators tokens to be chipped

start - the index at which to begin looking for chip terminators (inclusive)

end - the index at which to end looking for chip terminators (exclusive)

isPasteEvent - true if this handling is for a paste event in which case the behavior set in setPasteBehavior(int) will be used, otherwise false

Returns:

an non-negative integer indicating the index where the cursor (selection) should be placed once the handling is complete, or a negative integer indicating that the cursor should not be moved.