TransformationMethod.java revision 54b6cfa9a9e5b861a9930af873580d6dc20f773c 
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.text.method;
18
19import android.graphics.Rect;
20import android.view.View;
21import android.widget.TextView;
22
23/**
24 * TextView uses TransformationMethods to do things like replacing the
25 * characters of passwords with dots, or keeping the newline characters
26 * from causing line breaks in single-line text fields.
27 */
28public interface TransformationMethod
29{
30    /**
31     * Returns a CharSequence that is a transformation of the source text --
32     * for example, replacing each character with a dot in a password field.
33     * Beware that the returned text must be exactly the same length as
34     * the source text, and that if the source text is Editable, the returned
35     * text must mirror it dynamically instead of doing a one-time copy.
36     */
37    public CharSequence getTransformation(CharSequence source, View view);
38
39    /**
40     * This method is called when the TextView that uses this
41     * TransformationMethod gains or loses focus.
42     */
43    public void onFocusChanged(View view, CharSequence sourceText,
44                               boolean focused, int direction,
45                               Rect previouslyFocusedRect);
46}
47