xref: /aosp_15_r20/developers/build/prebuilts/gradle/TextLinkify/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid TextLinkify Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample illustrates how links can be added to a TextView. This can be done either
6*d353a188SXin Liautomatically by setting the "autoLink" property or explicitly.
7*d353a188SXin Li
8*d353a188SXin LiIntroduction
9*d353a188SXin Li------------
10*d353a188SXin Li
11*d353a188SXin LiThis sample demonstrates how clickable links can be added to a `TextView` in Android.
12*d353a188SXin Li
13*d353a188SXin LiThis can be done in three ways:
14*d353a188SXin Li
15*d353a188SXin Li- **Automatically:** Text added to a TextView can automatically be linkified by enabling
16*d353a188SXin LiautoLinking. In XML, use the `android:autoLink` property, programatically call
17*d353a188SXin Li[android.widget.TextView#setAutoLinkMask(int)][1] using an option from
18*d353a188SXin Li[android.text.util.Linkify][2].
19*d353a188SXin Li- **Parsing a String as HTML:** See [android.text.Html#fromHtml(String)][3].
20*d353a188SXin Li- **Manually by constructing a [android.text.SpannableString][4]:** Consisting of
21*d353a188SXin Li[android.text.style.StyleSpan][5] and [android.text.style.URLSpan][6] objects that
22*d353a188SXin Liare contained within a [android.text.SpannableString][7].
23*d353a188SXin Li
24*d353a188SXin Li[1]: http://developer.android.com/reference/android/widget/TextView.html#setAutoLinkMask(int)
25*d353a188SXin Li[2]: http://developer.android.com/reference/android/text/util/Linkify.html
26*d353a188SXin Li[3]: http://developer.android.com/reference/android/text/Html.html#fromHtml(java.lang.String)
27*d353a188SXin Li[4]: http://developer.android.com/reference/android/text/SpannableString.html
28*d353a188SXin Li[5]: http://developer.android.com/reference/android/text/style/StyleSpan.html
29*d353a188SXin Li[6]: http://developer.android.com/reference/android/text/style/URLSpan.html
30*d353a188SXin Li[7]: http://developer.android.com/reference/android/text/SpannableString.html
31*d353a188SXin Li
32*d353a188SXin LiPre-requisites
33*d353a188SXin Li--------------
34*d353a188SXin Li
35*d353a188SXin Li- Android SDK 27
36*d353a188SXin Li- Android Build Tools v27.0.2
37*d353a188SXin Li- Android Support Repository
38*d353a188SXin Li
39*d353a188SXin LiScreenshots
40*d353a188SXin Li-------------
41*d353a188SXin Li
42*d353a188SXin Li<img src="screenshots/main.png" height="400" alt="Screenshot"/>
43*d353a188SXin Li
44*d353a188SXin LiGetting Started
45*d353a188SXin Li---------------
46*d353a188SXin Li
47*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
48*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
49*d353a188SXin Li
50*d353a188SXin LiSupport
51*d353a188SXin Li-------
52*d353a188SXin Li
53*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
54*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
55*d353a188SXin Li
56*d353a188SXin LiIf you've found an error in this sample, please file an issue:
57*d353a188SXin Lihttps://github.com/googlesamples/android-TextLinkify
58*d353a188SXin Li
59*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
60*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
61*d353a188SXin Li
62*d353a188SXin LiLicense
63*d353a188SXin Li-------
64*d353a188SXin Li
65*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
66*d353a188SXin Li
67*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
68*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
69*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
70*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
71*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
72*d353a188SXin Lithe License at
73*d353a188SXin Li
74*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
75*d353a188SXin Li
76*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
77*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
78*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
79*d353a188SXin LiLicense for the specific language governing permissions and limitations under
80*d353a188SXin Lithe License.
81