summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHaoyu Zhang <haoyuchang@google.com>2019-03-15 17:52:41 -0700
committerHaoyu Zhang <haoyuchang@google.com>2019-03-18 16:49:50 -0700
commit10b1aeec1544e2c91f2dbaf7a5877e3e509bfd82 (patch)
tree2363eefb3af151e8f6125c36aada976140f27bf4
parentb54aa3d9aec501d1b423e95dee7e557d5916e798 (diff)
Add code sample and result image for LineHeightSpan
Bug: 112621694 Test: make offline-sdk-docs Change-Id: I6d8f022eb24d1d1b17a97999d15a798a04ec0df3
-rw-r--r--core/java/android/text/style/LineHeightSpan.java10
-rw-r--r--docs/html/reference/images/text/style/lineheightspan.pngbin0 -> 23937 bytes
2 files changed, 9 insertions, 1 deletions
diff --git a/core/java/android/text/style/LineHeightSpan.java b/core/java/android/text/style/LineHeightSpan.java
index 7fb0f950f583..610cf2c7c784 100644
--- a/core/java/android/text/style/LineHeightSpan.java
+++ b/core/java/android/text/style/LineHeightSpan.java
@@ -70,7 +70,15 @@ public interface LineHeightSpan extends ParagraphStyle, WrapTogetherSpan {
* Default implementation of the {@link LineHeightSpan}, which changes the line height of the
* attached paragraph.
* <p>
- * LineHeightSpan will change the line height of the entire paragraph, even though it
+ * For example, a paragraph with its line height equal to 100px can be set like this:
+ * <pre>
+ * SpannableString string = new SpannableString("This is a multiline paragraph. This is a multiline paragraph.");
+ * string.setSpan(new LineHeightSpan.Standard(100), 0, string.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
+ * </pre>
+ * <img src="{@docRoot}reference/android/images/text/style/lineheightspan.png" />
+ * <figcaption>Text with line height set to 100 pixels.</figcaption>
+ * <p>
+ * Notice that LineHeightSpan will change the line height of the entire paragraph, even though it
* covers only part of the paragraph.
* </p>
*/
diff --git a/docs/html/reference/images/text/style/lineheightspan.png b/docs/html/reference/images/text/style/lineheightspan.png
new file mode 100644
index 000000000000..18f575392b63
--- /dev/null
+++ b/docs/html/reference/images/text/style/lineheightspan.png
Binary files differ