From bf5d4d519035ddc6e680fe902cf000aca2cff474 Mon Sep 17 00:00:00 2001 From: joneckenrode Date: Thu, 18 Aug 2022 17:09:56 +0000 Subject: docs: Edited API documentation related to line-break and line-break word styles. Files patched from CL 19608033, https://googleplex-android-review.git.corp.google.com/c/platform/frameworks/base/+/19608033. Could not cherry-pick CL because LineBreakConfig.java on master contains Android U code. Staged to: https://android.devsite.corp.google.com/reference/android/widget/TextView https://android.devsite.corp.google.com/reference/android/R.attr https://android.devsite.corp.google.com/reference/kotlin/android/R.attr Test: Built API docs Change-Id: Ie322096ee2cc0ab3e24bb7d2ff8c398e8861726f --- core/java/android/widget/TextView.java | 63 ++++++++++++++++++++-------------- core/res/res/values/attrs.xml | 16 ++++----- 2 files changed, 46 insertions(+), 33 deletions(-) diff --git a/core/java/android/widget/TextView.java b/core/java/android/widget/TextView.java index 23393ffe885c..bdad9e366ba5 100644 --- a/core/java/android/widget/TextView.java +++ b/core/java/android/widget/TextView.java @@ -4877,20 +4877,28 @@ public class TextView extends View implements ViewTreeObserver.OnPreDrawListener } /** - * Set the line break style for text wrapping. + * Sets the line-break style for text wrapping. * - * The line break style to indicates the line break strategies can be used when - * calculating the text wrapping. The line break style affects rule-based breaking. It - * specifies the strictness of line-breaking rules. - * There are several types for the line break style: - * {@link LineBreakConfig#LINE_BREAK_STYLE_LOOSE}, - * {@link LineBreakConfig#LINE_BREAK_STYLE_NORMAL} and - * {@link LineBreakConfig#LINE_BREAK_STYLE_STRICT}. The default values of the line break style - * is {@link LineBreakConfig#LINE_BREAK_STYLE_NONE}, indicating no breaking rule is specified. - * See - * the line-break property + *

Line-break style specifies the line-break strategies that can be used + * for text wrapping. The line-break style affects rule-based line breaking + * by specifying the strictness of line-breaking rules. * - * @param lineBreakStyle the line break style for the text. + *

The following are types of line-break styles: + *

+ * + *

The default line-break style is + * {@link LineBreakConfig#LINE_BREAK_STYLE_NONE}, which specifies that no + * line-breaking rules are used. + * + *

See the + * + * line-break property for more information. + * + * @param lineBreakStyle The line-break style for the text. */ public void setLineBreakStyle(@LineBreakConfig.LineBreakStyle int lineBreakStyle) { if (mLineBreakStyle != lineBreakStyle) { @@ -4904,17 +4912,22 @@ public class TextView extends View implements ViewTreeObserver.OnPreDrawListener } /** - * Set the line break word style for text wrapping. + * Sets the line-break word style for text wrapping. + * + *

The line-break word style affects dictionary-based line breaking by + * providing phrase-based line-breaking opportunities. Use + * {@link LineBreakConfig#LINE_BREAK_WORD_STYLE_PHRASE} to specify + * phrase-based line breaking. + * + *

The default line-break word style is + * {@link LineBreakConfig#LINE_BREAK_WORD_STYLE_NONE}, which specifies that + * no line-breaking word style is used. * - * The line break word style affects dictionary-based breaking and provide phrase-based - * breaking opportunities. The type for the line break word style is - * {@link LineBreakConfig#LINE_BREAK_WORD_STYLE_PHRASE}. The default values of the line break - * word style is {@link LineBreakConfig#LINE_BREAK_WORD_STYLE_NONE}, indicating no breaking rule - * is specified. - * See - * the word-break property + *

See the + * + * word-break property for more information. * - * @param lineBreakWordStyle the line break word style for the tet + * @param lineBreakWordStyle The line-break word style for the text. */ public void setLineBreakWordStyle(@LineBreakConfig.LineBreakWordStyle int lineBreakWordStyle) { if (mLineBreakWordStyle != lineBreakWordStyle) { @@ -4928,18 +4941,18 @@ public class TextView extends View implements ViewTreeObserver.OnPreDrawListener } /** - * Get the current line break style for text wrapping. + * Gets the current line-break style for text wrapping. * - * @return the current line break style to be used for text wrapping. + * @return The line-break style to be used for text wrapping. */ public @LineBreakConfig.LineBreakStyle int getLineBreakStyle() { return mLineBreakStyle; } /** - * Get the current line word break style for text wrapping. + * Gets the current line-break word style for text wrapping. * - * @return the current line break word style to be used for text wrapping. + * @return The line-break word style to be used for text wrapping. */ public @LineBreakConfig.LineBreakWordStyle int getLineBreakWordStyle() { return mLineBreakWordStyle; diff --git a/core/res/res/values/attrs.xml b/core/res/res/values/attrs.xml index d2f31b05313d..d6686c48965d 100644 --- a/core/res/res/values/attrs.xml +++ b/core/res/res/values/attrs.xml @@ -5475,22 +5475,22 @@ ignores some hyphen character related typographic features, e.g. kerning. --> - + - + - + - + - + - + - + - +