Home | History | Annotate | Download | only in text
      1 /*
      2  * Copyright (C) 2013 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 androidx.core.text;
     18 
     19 /**
     20  * Interface for objects that use a heuristic for guessing at the paragraph direction by examining text.
     21  */
     22 public interface TextDirectionHeuristicCompat {
     23     /**
     24      * Guess if a chars array is in the RTL direction or not.
     25      *
     26      * @param array the char array.
     27      * @param start start index, inclusive.
     28      * @param count the length to check, must not be negative and not greater than
     29      *          {@code array.length - start}.
     30      * @return true if all chars in the range are to be considered in a RTL direction,
     31      *          false otherwise.
     32      */
     33     boolean isRtl(char[] array, int start, int count);
     34 
     35     /**
     36      * Guess if a {@code CharSequence} is in the RTL direction or not.
     37      *
     38      * @param cs the CharSequence.
     39      * @param start start index, inclusive.
     40      * @param count the length to check, must not be negative and not greater than
     41      *            {@code CharSequence.length() - start}.
     42      * @return true if all chars in the range are to be considered in a RTL direction,
     43      *          false otherwise.
     44      */
     45     boolean isRtl(CharSequence cs, int start, int count);
     46 }
     47