com.laserscorpion.rttapp.ui

Class TextEntryMonitor

java.lang.Object

com.laserscorpion.rttapp.ui.TextEntryMonitor

All Implemented Interfaces:

android.text.NoCopySpan, android.text.TextWatcher

public class TextEntryMonitor
extends java.lang.Object
implements android.text.TextWatcher

The TextEntryMonitor, one of which is created by the RTTCallActivity at a time, listens for input on the user's text field (EditText), and keeps track of which characters have changed. It sends those characters in the real-time call via the SipClient.

There are two modes, real time and en bloc, specified in the constructor.

Real-time mode:
If text is added or deleted at the end, TextEntryMonitor tells the SipClient to send the new characters (possibly '\b') in the real-time call. If edits are made earlier in the text, it undoes them, since the user is not allowed to add or remove text anywhere besides the end of the field. Keeping track of these edits is pretty annoying, and you need to understand how the Android.text.TextWatcher interface works before touching any of this.

En bloc mode:
Text is not sent character by character. It is only sent as complete messages, when checkAndSend() is called.

Nested Class Summary

Nested classes/interfaces inherited from interface android.text.NoCopySpan

android.text.NoCopySpan.Concrete

Constructor Summary

Constructors

Constructor and Description
TextEntryMonitor(android.widget.EditText watchThis, boolean realTime, SipClient sipClient, java.lang.CharSequence startText, boolean screenRotated) The only constructor.

Method Summary

Modifier and Type	Method and Description
void	afterTextChanged(android.text.Editable s)
void	beforeTextChanged(java.lang.CharSequence s, int start, int count, int after)
void	checkAndSend() Used in the case when the user has chosen to send entire messages, not individual characters, i.e.
void	onTextChanged(java.lang.CharSequence s, int start, int before, int count) onTextChanged is the bulk of the logic to determine which characters to send to the other party when the user enters text.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextEntryMonitor

public TextEntryMonitor(android.widget.EditText watchThis,
                        boolean realTime,
                        SipClient sipClient,
                        java.lang.CharSequence startText,
                        boolean screenRotated)

The only constructor.

Parameters:

watchThis - the text field to monitor for changes

realTime - whether the text should be sent in real time, character by character, or only when checkAndSend() is called

sipClient - the global hub for all things SIP, and who is responsible for sending the real-time text chars

startText - initial text to populate the field with, to be ignored (likely put there because the activity is destroyed and recreated)

screenRotated - whether this new TextEntryMonitor is being created due to screen rotation, i.e. the activity is destroyed and recreated

Method Detail

onTextChanged

public void onTextChanged(java.lang.CharSequence s,
                          int start,
                          int before,
                          int count)

onTextChanged is the bulk of the logic to determine which characters to send to the other party when the user enters text. If useRealTimeText == false, these listener methods are never called. In turn, most methods total are never called. En bloc methods are at the end of the class. This method enforces the rule that the user may only enter and delete text at the end of the field, not earlier (as in SipCon1). The important thing to know here is that in beforeTextChanged(), we set currentText to the text in the field before the change occurs. Then, in onTextChanged(), s is the *new* text and currentText is the *old* text. If we edit the text programmatically (e.g. to undo a prohibited edit), these callbacks fire, so they need to know if they are being invoked due to a change made by this code, not by the user. Thus we have the flag makingManualEdit, which is set in afterTextChanged(), if it sees the flag needManualEdit.

Specified by:

onTextChanged in interface android.text.TextWatcher

beforeTextChanged

public void beforeTextChanged(java.lang.CharSequence s,
                              int start,
                              int count,
                              int after)

Specified by:

beforeTextChanged in interface android.text.TextWatcher

afterTextChanged

public void afterTextChanged(android.text.Editable s)

Specified by:

afterTextChanged in interface android.text.TextWatcher

checkAndSend

public void checkAndSend()

Used in the case when the user has chosen to send entire messages, not individual characters, i.e. en bloc mode. The text in the field is sent to the other party and removed from the field.