com.humandevice.maskwatcher

Class InputMask

java.lang.Object

com.humandevice.maskwatcher.InputMask

All Implemented Interfaces:

android.text.NoCopySpan, android.text.SpanWatcher, android.text.TextWatcher

public class InputMask
extends java.lang.Object
implements android.text.TextWatcher, android.text.SpanWatcher

Klasa umożliwaiająca dodanie do EditText maski.

Użycie:

 EditText editText = (EditText) findViewById(R.id.text1);
 InputMask mask = InputMask.applyTo(editText, "(00)-(000)");

Jako drugi parametr metody applyTo(EditText, String) należy podać maskę.

Znaki specjalne, które mogą zostać użyte w masce:

 A - litera
 a - litera (opcjonalna)
 0 - cyfra
 9 - cyfra (opcjonalna)
 * - dowolny znak
 ? - dowolny znak (opcjonalny)
 () - grupa zawierająca znaczący tekst który może zostać pobrany poprzez wywołanie metody #getText(true)
 \L - otwarcie grupy małych liter
 \U - otwarcie grupy dużych liter
 \E - zamknięcie grupy

Przykłady:

 - numer telefonu w formacie "777-77-77", maska: "000-00-00"
 - skrót państwa dużymi literami "PL", maska: "\\UAA\\E"
 - cena (2-3 cyfry całkowite) "50,00 zł", maska: "009,00 zł"

 Aby pobrać tylko wybrane znaki należy je zawrzeć w nawiasach "()"
 Przykład: dla maski: "(00)-(000)" i danych wejściowych "12-123"
 metoda: mask.getText(false) zwróci "12-123"
 metoda: mask.getText(true) zwróci "12123" 

 Uwaga: jeśli chce się wykorzystać znak specjalny jako stały to należy go poprzedzić znakiem "\\"
 Przykłady:
 dla "17a" gdzie "a" jest stałą należy wprowadzić, maska "00\\a"
 dla "17\36", maska "00\\\\00"
 dla "(029)777-77-77", maska: "\\(000\\)000-00-00"
 

Uwaga: Niektóre klawiatury powodują złe działanie ograniczeń w przypadku włączonych sugestii, aby wyłączyć należy dodać:

   editText.setInputType(InputType.TYPE_TEXT_FLAG_NO_SUGGESTIONS);

lub

   android:inputType="textNoSuggestions"

Uwaga 2: EditText musi mieć uprawnienie do dodawania wszystkich znaków z maski, w przeciwnym przypadku może zostać rzucony Exception

Przykład:

Jeśli maska zawiera inne znaki niż cyfry np. "00 zł" lub "00 000" oraz zostanie dodany android:inputType="number" to biblioteka rzuci błędem IndexOutOfBoundsException ponieważ znaki ' ', 'z' oraz 'ł' nie są cyframi. Aby rozwiązać ten problem należy zmienić inputType lub zdefiniować dozwolone znaki poprzez android:digits="1234567890łz "

Nested Class Summary

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

android.text.NoCopySpan.Concrete

Method Summary

Modifier and Type	Method and Description
void	afterTextChanged(android.text.Editable s)
static InputMask	applyTo(android.widget.EditText editText, java.lang.String mask)
void	beforeTextChanged(java.lang.CharSequence s, int start, int count, int after)
void	changeMask(java.lang.String mask)
java.lang.CharSequence	getText(boolean onlyValuable)
void	onSpanAdded(android.text.Spannable text, java.lang.Object what, int start, int end)
void	onSpanChanged(android.text.Spannable text, java.lang.Object what, int ostart, int oend, int nstart, int nend)
void	onSpanRemoved(android.text.Spannable text, java.lang.Object what, int start, int end)
void	onTextChanged(java.lang.CharSequence s, int start, int before, int count)
void	removeMask() Deprecated. Because TextView.removeTextChangedListener(TextWatcher) doesn't do this synchronized

Methods inherited from class java.lang.Object

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

Method Detail

applyTo

public static InputMask applyTo(android.widget.EditText editText,
                                java.lang.String mask)

changeMask

public void changeMask(java.lang.String mask)

removeMask

@Deprecated
public void removeMask()

Deprecated. Because TextView.removeTextChangedListener(TextWatcher) doesn't do this synchronized

beforeTextChanged

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

Specified by:

beforeTextChanged in interface android.text.TextWatcher

onTextChanged

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

Specified by:

onTextChanged in interface android.text.TextWatcher

afterTextChanged

public void afterTextChanged(android.text.Editable s)

Specified by:

afterTextChanged in interface android.text.TextWatcher

getText

public java.lang.CharSequence getText(boolean onlyValuable)

onSpanAdded

public void onSpanAdded(android.text.Spannable text,
                        java.lang.Object what,
                        int start,
                        int end)

Specified by:

onSpanAdded in interface android.text.SpanWatcher

onSpanRemoved

public void onSpanRemoved(android.text.Spannable text,
                          java.lang.Object what,
                          int start,
                          int end)

Specified by:

onSpanRemoved in interface android.text.SpanWatcher

onSpanChanged

public void onSpanChanged(android.text.Spannable text,
                          java.lang.Object what,
                          int ostart,
                          int oend,
                          int nstart,
                          int nend)

Specified by:

onSpanChanged in interface android.text.SpanWatcher