Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "some extra docs for TextDirectionHeuristic" into jb-mr2-dev

Browse Source
This commit is contained in:
Scott Main
2013-06-18 05:10:32 +00:00
committed by Android (Google) Code Review
parent 1a0a50e7c2 e442662330
commit de04dfb62d
2 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
core/java/android/text/BidiFormatter.java
View File

@@ -25,8 +25,12 @@ import java.util.Locale;
/** /**
* Utility class for formatting text for display in a potentially opposite-directionality context * Utility class for formatting text for display in a potentially opposite-directionality context
* without garbling. The directionality of the context is set at formatter creation and the * without garbling. The directionality of the context is set at formatter creation and the
* directionality of the text can be either estimated or passed in when known. Provides the * directionality of the text can be either estimated or passed in when known.
* following functionality: *
* <p>To support versions lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2},
* you can use the support library's {@link android.support.v4.text.BidiFormatter} class.
*
* <p>These APIs provides the following functionality:
* <p> * <p>
* 1. Bidi Wrapping * 1. Bidi Wrapping
* When text in one language is mixed into a document in another, opposite-directionality language, * When text in one language is mixed into a document in another, opposite-directionality language,
@@ -370,6 +374,7 @@ public final class BidiFormatter {
* *
* @param str The input string. * @param str The input string.
* @param heuristic The algorithm to be used to estimate the string's overall direction. * @param heuristic The algorithm to be used to estimate the string's overall direction.
* See {@link TextDirectionHeuristics} for pre-defined heuristics.
* @param isolate Whether to directionally isolate the string to prevent it from garbling the * @param isolate Whether to directionally isolate the string to prevent it from garbling the
* content around it * content around it
* @return Input string after applying the above processing. * @return Input string after applying the above processing.
@@ -401,6 +406,7 @@ public final class BidiFormatter {
* *
* @param str The input string. * @param str The input string.
* @param heuristic The algorithm to be used to estimate the string's overall direction. * @param heuristic The algorithm to be used to estimate the string's overall direction.
* See {@link TextDirectionHeuristics} for pre-defined heuristics.
* @return Input string after applying the above processing. * @return Input string after applying the above processing.
*/ */
public String unicodeWrap(String str, TextDirectionHeuristic heuristic) { public String unicodeWrap(String str, TextDirectionHeuristic heuristic) {

9
core/java/android/text/TextDirectionHeuristics.java
View File

@@ -22,7 +22,14 @@ import android.view.View;
import java.nio.CharBuffer; import java.nio.CharBuffer;
/** /**
* Some objects that implement TextDirectionHeuristic. * Some objects that implement {@link TextDirectionHeuristic}. Use these with
* the {@link BidiFormatter#unicodeWrap unicodeWrap()} methods in {@link BidiFormatter}.
* Also notice that these direction heuristics correspond to the same types of constants
* provided in the {@link android.view.View} class for {@link android.view.View#setTextDirection
* setTextDirection()}, such as {@link android.view.View#TEXT_DIRECTION_RTL}.
* <p>To support versions lower than {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2},
* you can use the support library's {@link android.support.v4.text.TextDirectionHeuristicsCompat}
* class.
* *
*/ */
public class TextDirectionHeuristics { public class TextDirectionHeuristics {