tree: f591cbb47f034b85668dc6b6ebfb661b8eeea8d6 [path history] [tgz]
  1. .gitignore
  2. README.md
  3. app/
  4. build.gradle
  5. gradle.properties
  6. gradle/
  7. gradlew
  8. gradlew.bat
  9. settings.gradle
ui/text/TextStyling-Java/README.md

Text Styling

This sample shows how to style text on Android using spans, in Java.

Introduction

Features

Parse some hardcoded text and do the following:

  • Paragraphs starting with “> ” are transformed into quotes.
  • Text enclosed in “```” will be transformed into inline code block.
  • Lines starting with “+ ” or “* ” will be transformed into bullet points. To update the text, modify the value of R.string.display_text. This project is not meant to fully cover the markdown capabilities and has several limitations; for example, quotes do not support nesting other elements.

Implementation

The text is parsed in the Parser.parse method and the spans are created in the MarkdownBuilder.markdownToSpans method. To see how to apply a span, check out MarkdownBuilder.buildCodeBlockSpan . To see how to apply multiple spans on the same string, see MarkdownBuilder.buildQuoteSpan. For examples of creating custom spans, see BulletPointSpan, CodeBlockSpan or FontSpan.

Testing

Text parsing is tested with JUnit tests in ParserTest. Span building is tested via Android JUnit tests, in MarkdownBuilderTest.

Getting Started

Clone this repository, enter the top level directory and run ./gradlew tasks to get an overview of all the tasks available for this project.

Some important tasks are:

assembleDebug - Assembles all Debug builds.
installDebug - Installs the Debug build.
connectedAndroidTest - Installs and runs the tests for Debug build on connected
devices.
test - Run all unit tests.

Screenshots

Support

If you've found an error in this sample, please file an issue: https://github.com/googlesamples/android-text/issues

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub.

License

Copyright 2018 The Android Open Source Project

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.