com.hootsuite.nachos.terminator

Class DefaultChipTerminatorHandler

java.lang.Object

com.hootsuite.nachos.terminator.DefaultChipTerminatorHandler

All Implemented Interfaces:

ChipTerminatorHandler

public class DefaultChipTerminatorHandler
extends java.lang.Object
implements ChipTerminatorHandler

Field Summary

Fields inherited from interface com.hootsuite.nachos.terminator.ChipTerminatorHandler

BEHAVIOR_CHIPIFY_ALL, BEHAVIOR_CHIPIFY_CURRENT_TOKEN, BEHAVIOR_CHIPIFY_TO_TERMINATOR, PASTE_BEHAVIOR_USE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
DefaultChipTerminatorHandler()

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 ChipTerminatorHandler.addChipTerminator(char, int) and ChipTerminatorHandler.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultChipTerminatorHandler

public DefaultChipTerminatorHandler()

Method Detail

setChipTerminators

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

Description copied from interface: ChipTerminatorHandler

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

Specified by:

setChipTerminators in interface ChipTerminatorHandler

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

public void addChipTerminator(char character,
                              int behavior)

Description copied from interface: ChipTerminatorHandler

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:

• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_ALL
• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_CURRENT_TOKEN
• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_TO_TERMINATOR

Specified by:

addChipTerminator in interface ChipTerminatorHandler

Parameters:

character - the character to mark as a chip terminator

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

setPasteBehavior

public void setPasteBehavior(int pasteBehavior)

Description copied from interface: ChipTerminatorHandler

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

• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_ALL
• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_CURRENT_TOKEN
• ChipTerminatorHandler.BEHAVIOR_CHIPIFY_TO_TERMINATOR

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

Specified by:

setPasteBehavior in interface ChipTerminatorHandler

Parameters:

pasteBehavior - the behavior to use on a paste event

findAndHandleChipTerminators

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

Description copied from interface: ChipTerminatorHandler

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

Specified by:

findAndHandleChipTerminators in interface ChipTerminatorHandler

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 ChipTerminatorHandler.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.