Home | History | Annotate | Download | only in method
      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 
     17 package android.text.method;
     18 
     19 import android.graphics.Rect;
     20 import android.view.View;
     21 
     22 /**
     23  * TextView uses TransformationMethods to do things like replacing the
     24  * characters of passwords with dots, or keeping the newline characters
     25  * from causing line breaks in single-line text fields.
     26  */
     27 public interface TransformationMethod
     28 {
     29     /**
     30      * Returns a CharSequence that is a transformation of the source text --
     31      * for example, replacing each character with a dot in a password field.
     32      * Beware that the returned text must be exactly the same length as
     33      * the source text, and that if the source text is Editable, the returned
     34      * text must mirror it dynamically instead of doing a one-time copy.
     35      */
     36     public CharSequence getTransformation(CharSequence source, View view);
     37 
     38     /**
     39      * This method is called when the TextView that uses this
     40      * TransformationMethod gains or loses focus.
     41      */
     42     public void onFocusChanged(View view, CharSequence sourceText,
     43                                boolean focused, int direction,
     44                                Rect previouslyFocusedRect);
     45 }
     46