├── .gitignore ├── .idea ├── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── encodings.xml ├── markdown-exported-files.xml ├── markdown-navigator.xml ├── markdown-navigator │ └── profiles_settings.xml ├── misc.xml └── runConfigurations.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── grivos │ │ └── spanomatic │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── grivos │ │ │ └── spanomatic │ │ │ └── app │ │ │ ├── MainActivity.kt │ │ │ └── SpanomaticApplication.kt │ └── res │ │ ├── drawable-v24 │ │ └── ic_launcher_foreground.xml │ │ ├── drawable │ │ ├── ic_cake_16dp.xml │ │ └── ic_launcher_background.xml │ │ ├── font │ │ ├── lato.xml │ │ ├── lato_bold.ttf │ │ ├── lato_light.ttf │ │ └── lato_regular.ttf │ │ ├── layout │ │ └── activity_main.xml │ │ ├── mipmap-anydpi-v26 │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ └── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── styles.xml │ └── test │ └── java │ └── com │ └── grivos │ └── spanomatic │ └── ExampleUnitTest.kt ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── media ├── example_absolute_size.png ├── example_bg.png ├── example_bullet.png ├── example_click_toast.gif ├── example_drawable.png ├── example_fg.png ├── example_format.png ├── example_leading_margin.png ├── example_quote.png ├── example_relative_size.png ├── example_typeface.png └── example_url.png ├── settings.gradle └── spanomatic ├── .gitignore ├── build.gradle ├── proguard-rules.pro ├── publish.gradle └── src ├── androidTest └── java │ └── com │ └── grivos │ └── spanomatic │ └── ExampleInstrumentedTest.java ├── main ├── AndroidManifest.xml └── java │ └── com │ └── grivos │ └── spanomatic │ ├── AnnotationSpanHandlers.kt │ ├── PlaceholderFormatter.kt │ ├── Spanomatic.kt │ ├── SpanomaticInterceptor.kt │ ├── TypefaceProvider.kt │ ├── spans │ ├── CustomTypefaceSpan.kt │ └── ListenableClickableSpan.kt │ └── utils │ ├── Extensions.kt │ └── Utils.kt └── test └── java └── com └── grivos └── spanomatic └── ExampleUnitTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.ap_ 4 | *.aab 5 | 6 | # Files for the ART/Dalvik VM 7 | *.dex 8 | 9 | # Java class files 10 | *.class 11 | 12 | # Generated files 13 | bin/ 14 | gen/ 15 | out/ 16 | 17 | # Gradle files 18 | .gradle/ 19 | build/ 20 | 21 | # Local configuration file (sdk path, etc) 22 | local.properties 23 | 24 | # Proguard folder generated by Eclipse 25 | proguard/ 26 | 27 | # Log Files 28 | *.log 29 | 30 | # Android Studio Navigation editor temp files 31 | .navigation/ 32 | 33 | # Android Studio captures folder 34 | captures/ 35 | 36 | # IntelliJ 37 | *.iml 38 | .idea/workspace.xml 39 | .idea/tasks.xml 40 | .idea/gradle.xml 41 | .idea/assetWizardSettings.xml 42 | .idea/dictionaries 43 | .idea/libraries 44 | .idea/caches 45 | # Android Studio 3 in .gitignore file. 46 | .idea/caches/build_file_checksums.ser 47 | .idea/modules.xml 48 | 49 | # Keystore files 50 | # Uncomment the following lines if you do not want to check your keystore files in. 51 | #*.jks 52 | #*.keystore 53 | 54 | # External native build folder generated in Android Studio 2.2 and later 55 | .externalNativeBuild 56 | 57 | # Google Services (e.g. APIs or Firebase) 58 | # google-services.json 59 | 60 | # Freeline 61 | freeline.py 62 | freeline/ 63 | freeline_project_description.json 64 | 65 | # fastlane 66 | fastlane/report.xml 67 | fastlane/Preview.html 68 | fastlane/screenshots 69 | fastlane/test_output 70 | fastlane/readme.md 71 | 72 | # Version control 73 | vcs.xml 74 | 75 | # lint 76 | lint/intermediates/ 77 | lint/generated/ 78 | lint/outputs/ 79 | lint/tmp/ 80 | # lint/reports/ -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 9 | 10 | 11 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | xmlns:android 20 | ^$ 21 | 22 | 23 | 24 |
25 |
26 | 27 | 28 | 29 | xmlns:.* 30 | ^$ 31 | 32 | 33 | BY_NAME 34 | 35 |
36 |
37 | 38 | 39 | 40 | .*:id 41 | http://schemas.android.com/apk/res/android 42 | 43 | 44 | 45 |
46 |
47 | 48 | 49 | 50 | .*:name 51 | http://schemas.android.com/apk/res/android 52 | 53 | 54 | 55 |
56 |
57 | 58 | 59 | 60 | name 61 | ^$ 62 | 63 | 64 | 65 |
66 |
67 | 68 | 69 | 70 | style 71 | ^$ 72 | 73 | 74 | 75 |
76 |
77 | 78 | 79 | 80 | .* 81 | ^$ 82 | 83 | 84 | BY_NAME 85 | 86 |
87 |
88 | 89 | 90 | 91 | .* 92 | http://schemas.android.com/apk/res/android 93 | 94 | 95 | ANDROID_ATTRIBUTE_ORDER 96 | 97 |
98 |
99 | 100 | 101 | 102 | .* 103 | .* 104 | 105 | 106 | BY_NAME 107 | 108 |
109 | 110 | 111 | 112 | 113 | 115 | 116 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/markdown-exported-files.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/markdown-navigator.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 36 | 37 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | -------------------------------------------------------------------------------- /.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 22 | 37 | 38 | 39 | 40 | 41 | 42 | 44 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spanomatic 2 | Spanomatic is an Android library that allows you to automatically add spans to text from resources strings. 3 | 4 | * [Getting Started](#getting-started) 5 | * [Dependencies](#dependencies) 6 | * [Initialization](#initialization) 7 | * [String Resources Annotations](#string-resources-annotations) 8 | * [Supported Annotation Keys](#supported-annotation-keys) 9 | * [fgColor](#fgcolor) 10 | * [bgColor](#bgcolor) 11 | * [relativeTextSize](#relativetextsize) 12 | * [absoluteTextSize](#absolutetextsize) 13 | * [drawable](#drawable) 14 | * [format](#format) 15 | * [quote](#quote) 16 | * [bullet](#bullet) 17 | * [url](#url) 18 | * [leadingMargin](#leadingmargin) 19 | * [typeface](#typeface) 20 | * [click](#click) 21 | * [Adding Support For Custom User Annotation Keys](#adding-support-for-custom-user-annotation-keys) 22 | * [Using Spanomatic Manually](#using-spanomatic-manually) 23 | * [Format Arguments](#format-arguments) 24 | * [Acknowledgements](#acknowledgements) 25 | 26 | ## Getting Started 27 | 28 | ### Dependencies 29 | Add Jitpack in your root build.gradle: 30 | ```groovy 31 | allprojects { 32 | repositories { 33 | ... 34 | maven { url 'https://jitpack.io' } 35 | } 36 | } 37 | ``` 38 | Spanomatic uses the [ViewPump](https://github.com/InflationX/ViewPump) library, that provides an API for pre/post-inflation interceptors. 39 | Add these dependencies to your app module's build.gradle file: 40 | ```groovy 41 | dependencies { 42 | ... 43 | implementation 'com.github.grivos:Spanomatic:1.2.1' 44 | implementation 'io.github.inflationx:viewpump:2.0.3' 45 | } 46 | ``` 47 | 48 | ### Initialization 49 | Init ViewPump and add the SpanomaticInterceptor in your app class: 50 | ```kotlin 51 | class MyApplication : Application() { 52 | 53 | override fun onCreate() { 54 | super.onCreate() 55 | ViewPump.init( 56 | ViewPump.builder() 57 | .addInterceptor( 58 | SpanomaticInterceptor() 59 | ) 60 | .build() 61 | ) 62 | } 63 | 64 | } 65 | ``` 66 | 67 | Wrap your activities context: 68 | ```kotlin 69 | class BaseActivity : AppCompatActivity() { 70 | 71 | override fun attachBaseContext(newBase: Context) { 72 | super.attachBaseContext(ViewPumpContextWrapper.wrap(newBase)) 73 | } 74 | 75 | } 76 | ``` 77 | 78 | ## String Resources Annotations 79 | 80 | In order for Spanomatic to translate string resources annotations into spans, you need to wrap your strings in special annotations. 81 | The mechanic is like so: 82 | ```xml 83 | This part isn\'t annotated, but this part is. 84 | ``` 85 | Spanomatic parses the string resource, looks for these annotations, and depending on the key and value, it adds the appropriate spans. 86 | You can also nest annotations like so: 87 | ```xml 88 | This part isn\'t annotated, but this part has two annotations. 89 | ``` 90 | 91 | Spanomatic supports several annotation keys out of the box, but you can also register handlers for custom annotation keys. 92 | 93 | ### Supported Annotation Keys 94 | 95 | #### fgColor 96 | **Description:** Adds a `ForegroundSpan`. 97 | **Possible Values:** Either a literal color hex (`"#9C27B0"`) or a color reference (`"@color/material_purple"`). 98 | **Example:** 99 | ```xml 100 | This text has purple foreground 101 | ``` 102 | ![example_fg](https://github.com/grivos/Spanomatic/blob/master/media/example_fg.png) 103 | 104 | #### bgColor 105 | **Description:** Adds a `BackgroundSpan`. 106 | **Possible Values:** Either a literal color hex or a color reference. 107 | **Example:** 108 | ```xml 109 | This text has green background 110 | ``` 111 | ![example_bg](https://github.com/grivos/Spanomatic/blob/master/media/example_bg.png) 112 | 113 | #### relativeTextSize 114 | **Description:** Adds a `RelativeSizeSpan`. 115 | **Possible Values:** The size multiplier. 116 | **Example:** 117 | ```xml 118 | This text is two times bigger 119 | ``` 120 | ![example_relative_size](https://github.com/grivos/Spanomatic/blob/master/media/example_relative_size.png) 121 | 122 | #### absoluteTextSize 123 | **Description:** Adds an `AbsoluteSizeSpan`. 124 | **Possible Values:** A size identifier. Either a literal (`18dp`, `16sp`, etc.) or a reference (`"@dimen/big_text_size"`). 125 | **Example:** 126 | ```xml 127 | This text size is 20dp 128 | ``` 129 | ![example_absolute_size](https://github.com/grivos/Spanomatic/blob/master/media/example_absolute_size.png) 130 | 131 | #### drawable 132 | **Description:** Adds an `ImageSpan`. 133 | **Possible Values:** A drawable reference and an optional alignment (either `baseline` or `bottom`). If the alignment is missing, the default is `baseline`.
The optional alignment is separated from the drawable reference using the pipe character (`|`). 134 | **Example:** 135 | ```xml 136 | This is a cake drawable span. 137 | ``` 138 | ![example_drawable](https://github.com/grivos/Spanomatic/blob/master/media/example_drawable.png) 139 | 140 | #### format 141 | **Description:** Adds one of `StrikethroughSpan`, `StyleSpan`, `SuperscriptSpan`, `SubscriptSpan`, `UnderlineSpan`. 142 | **Possible Values:** 143 | 144 | | Value | Span | 145 | |---|---| 146 | | strikethrough | `StrikethroughSpan()` | 147 | | bold | `StyleSpan(Typeface.BOLD)` | 148 | | italic | `StyleSpan(Typeface.ITALIC)` | 149 | | boldItalic | `StyleSpan(Typeface.BOLD_ITALIC)` | 150 | | superscript | `SuperscriptSpa()` | 151 | | subscript | `SubscriptSpan()` | 152 | | underline | `UnderlineSpan()` | 153 | 154 | **Example:** 155 | ```xml 156 | Spanomatic supports strikethrough, bold, italic, bold italic, superscript, subscript and underline spans. 157 | ``` 158 | ![example_format](https://github.com/grivos/Spanomatic/blob/master/media/example_format.png) 159 | 160 | #### quote 161 | **Description:** Adds a `QuoteSpan`. 162 | **Possible Values:** Either empty or an optional literal color hex or a color reference. 163 | **Example:** 164 | ```xml 165 | This is a quote 166 | ``` 167 | ```xml 168 | This is a quote 169 | ``` 170 | ![example_quote](https://github.com/grivos/Spanomatic/blob/master/media/example_quote.png) 171 | 172 | #### bullet 173 | **Description:** Adds a `BulletSpan`. 174 | **Possible Values:** Either empty or an optional gap width (literal dimension or a dimension reference), and an optional literal color hex or a color reference. 175 | **Example:** 176 | ```xml 177 | This is a bullet 178 | ``` 179 | ```xml 180 | This is a bullet 181 | ``` 182 | ```xml 183 | This is a bullet 184 | ``` 185 | ![example_bullet](https://github.com/grivos/Spanomatic/blob/master/media/example_bullet.png) 186 | 187 | #### url 188 | **Description:** Adds a `URLSpan`. 189 | **Possible Values:** A url. 190 | **Example:** 191 | ```xml 192 | This text has a UrlSpan 193 | ``` 194 | ![example_url](https://github.com/grivos/Spanomatic/blob/master/media/example_url.png) 195 | 196 | #### leadingMargin 197 | **Description:** Adds a `LeadingMarginSpan`. 198 | **Possible Values:** The size of the leading margin (either a literal dimension or a dimension reference). 199 | **Example:** 200 | ```xml 201 | This text has a leading margin 202 | ``` 203 | ![example_leading_margin](https://github.com/grivos/Spanomatic/blob/master/media/example_leading_margin.png) 204 | 205 | #### typeface 206 | **Description:** Adds a `CustomTypefaceSpan`. 207 | **Possible Values:** The name of this typeface (either a literal string or a string reference). 208 | **Example:** 209 | First, you need to register a `TypefaceProvider` (the best place to do so is in your Application `onCreate()` method): 210 | ```kotlin 211 | val latoRegular = ResourcesCompat.getFont(this, R.font.lato_regular) 212 | val latoLight = ResourcesCompat.getFont(this, R.font.lato_light) 213 | val latoBold = ResourcesCompat.getFont(this, R.font.lato_bold) 214 | Spanomatic.typefaceProvider = object : TypefaceProvider { 215 | 216 | override fun getTypeface(name: String): Typeface? { 217 | return when (name) { 218 | "latoRegular" -> latoRegular 219 | "latoLight" -> latoLight 220 | "latoBold" -> latoBold 221 | else -> null 222 | } 223 | } 224 | 225 | } 226 | ``` 227 | Then we can use these typefaces in a string resource: 228 | 229 | ```xml 230 | Here we have three different typefaces: Lato Regular, Lato Light and Lato Bold 231 | ``` 232 | ![example_typeface](https://github.com/grivos/Spanomatic/blob/master/media/example_typeface.png) 233 | 234 | #### click 235 | **Description:** Adds a `ListenableClickableSpan` (a custom `ClickableSpan` that can be registered with a click callback).
Note that this span doesn't add an `UnderlineSpan`, so if that's what you want, you should wrap it in another `format="underline"` annotation. 236 | **Possible Values:** The name of this click (so we can register a callback to the span from the code). 237 | **Example:** 238 | 239 | ```xml 240 | This span is clickable: click me 241 | ``` 242 | 243 | To catch the onClick event, you need to register a callback like so: 244 | ```kotlin 245 | clickableTextView.addSpanClickListener("click1") { 246 | Toast.makeText(this, "Span was clicked", Toast.LENGTH_SHORT).show() 247 | } 248 | ``` 249 | ![example_click_toast](https://github.com/grivos/Spanomatic/blob/master/media/example_click_toast.gif) 250 | 251 | ### Adding Support For Custom User Annotation Keys 252 | 253 | You can register your own annotation span handlers like so: 254 | ```kotlin 255 | Spanomatic.setAnnotationSpanHandler("myCustomKey") { annotationValue, context -> 256 | val myParsedValue = parseValue(annotationValue, context) 257 | MyCustomSpan(myParsedValue) 258 | } 259 | ``` 260 | 261 | Then you can use it in your string resources: 262 | ```xml 263 | This span is custom 264 | ``` 265 | 266 | ## Using Spanomatic Manually 267 | 268 | Spanomatic automatically adds spans in the layout inflation process, but you can also use it manually like so: 269 | ```kotlin 270 | val spanned = addSpansFromAnnotations(R.string.annotated_string) 271 | myTextView.text = spanned 272 | ``` 273 | 274 | ### Format Arguments 275 | 276 | Spanomatic also supports format arguments: 277 | ```xml 278 | This text has annotations with parameters: %1$s, %2$b, %3$d 279 | ``` 280 | 281 | ```kotlin 282 | val param1 = "text" 283 | val param2 = false 284 | val param3 = 5 285 | val spanned = addSpansFromAnnotations(R.string.annotated_string_with_parameters, param1, param2, param3) 286 | myTextView.text = spanned 287 | ``` 288 | ## Acknowledgements 289 | 290 | Spanomatic was inspired by [this blog post](https://medium.com/androiddevelopers/styling-internationalized-text-in-android-f99759fb7b8f) by Florina Muntenescu and the [Rialto](https://github.com/StylingAndroid/Rialto) library by Mark Allison. 291 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | apply plugin: 'kotlin-android' 4 | 5 | apply plugin: 'kotlin-android-extensions' 6 | 7 | android { 8 | compileSdkVersion 28 9 | defaultConfig { 10 | applicationId "com.grivos.spans.app" 11 | minSdkVersion 19 12 | targetSdkVersion 28 13 | versionCode 1 14 | versionName "1.0" 15 | testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner' 16 | } 17 | buildTypes { 18 | release { 19 | minifyEnabled false 20 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 21 | } 22 | } 23 | } 24 | 25 | dependencies { 26 | implementation fileTree(dir: 'libs', include: ['*.jar']) 27 | implementation project(':spanomatic') 28 | implementation 'io.github.inflationx:viewpump:2.0.3' 29 | implementation"org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" 30 | implementation 'androidx.appcompat:appcompat:1.2.0' 31 | testImplementation 'junit:junit:4.12' 32 | androidTestImplementation 'androidx.test.ext:junit:1.1.2' 33 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0' 34 | } 35 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/grivos/spanomatic/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import org.junit.Assert.assertEquals 4 | import org.junit.Test 5 | import org.junit.runner.RunWith 6 | 7 | /** 8 | * Instrumented test, which will execute on an Android device. 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | @RunWith(AndroidJUnit4::class) 13 | class ExampleInstrumentedTest { 14 | @Test 15 | fun useAppContext() { 16 | // Context of the app under test. 17 | val appContext = InstrumentationRegistry.getTargetContext() 18 | assertEquals("com.grivos.spans", appContext.packageName) 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 4 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /app/src/main/java/com/grivos/spanomatic/app/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.app 2 | 3 | import android.content.Context 4 | import android.os.Bundle 5 | import androidx.appcompat.app.AppCompatActivity 6 | import android.widget.Toast 7 | import com.grivos.spanomatic.utils.addSpanClickListener 8 | import io.github.inflationx.viewpump.ViewPumpContextWrapper 9 | import kotlinx.android.synthetic.main.activity_main.* 10 | 11 | 12 | class MainActivity : AppCompatActivity() { 13 | 14 | override fun onCreate(savedInstanceState: Bundle?) { 15 | super.onCreate(savedInstanceState) 16 | setContentView(R.layout.activity_main) 17 | clickableTextView.addSpanClickListener("exampleClick") { 18 | Toast.makeText(this, "Click", Toast.LENGTH_SHORT).show() 19 | } 20 | } 21 | 22 | override fun attachBaseContext(newBase: Context) { 23 | super.attachBaseContext(ViewPumpContextWrapper.wrap(newBase)) 24 | } 25 | 26 | } -------------------------------------------------------------------------------- /app/src/main/java/com/grivos/spanomatic/app/SpanomaticApplication.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.app 2 | 3 | import android.app.Application 4 | import android.graphics.Typeface 5 | import androidx.core.content.res.ResourcesCompat 6 | import com.grivos.spanomatic.Spanomatic 7 | import com.grivos.spanomatic.SpanomaticInterceptor 8 | import com.grivos.spanomatic.TypefaceProvider 9 | import io.github.inflationx.viewpump.ViewPump 10 | 11 | 12 | class SpanomaticApplication : Application() { 13 | 14 | override fun onCreate() { 15 | super.onCreate() 16 | ViewPump.init( 17 | ViewPump.builder() 18 | .addInterceptor( 19 | SpanomaticInterceptor() 20 | ) 21 | .build() 22 | ) 23 | val latoRegular = ResourcesCompat.getFont(this, R.font.lato_regular) 24 | val latoLight = ResourcesCompat.getFont(this, R.font.lato_light) 25 | val latoBold = ResourcesCompat.getFont(this, R.font.lato_bold) 26 | Spanomatic.typefaceProvider = object : TypefaceProvider { 27 | 28 | override fun getTypeface(name: String): Typeface? { 29 | return when (name) { 30 | KEY_TYPEFACE_LATO_REGULAR -> latoRegular 31 | KEY_TYPEFACE_LATO_LIGHT -> latoLight 32 | KEY_TYPEFACE_LATO_BOLD -> latoBold 33 | else -> null 34 | } 35 | } 36 | 37 | } 38 | } 39 | } 40 | 41 | private const val KEY_TYPEFACE_LATO_REGULAR = "latoRegular" 42 | private const val KEY_TYPEFACE_LATO_LIGHT = "latoLight" 43 | private const val KEY_TYPEFACE_LATO_BOLD = "latoBold" -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 12 | 13 | 19 | 22 | 25 | 26 | 27 | 28 | 34 | 35 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_cake_16dp.xml: -------------------------------------------------------------------------------- 1 | 7 | 10 | 11 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/font/lato.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 14 | 15 | 23 | 24 | 32 | 33 | -------------------------------------------------------------------------------- /app/src/main/res/font/lato_bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/font/lato_bold.ttf -------------------------------------------------------------------------------- /app/src/main/res/font/lato_light.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/font/lato_light.ttf -------------------------------------------------------------------------------- /app/src/main/res/font/lato_regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/font/lato_regular.ttf -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 12 | 13 | 17 | 18 | 22 | 23 | 27 | 28 | 32 | 33 | 37 | 38 | 42 | 43 | 49 | 50 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #008577 4 | #00574B 5 | #D81B60 6 | #4CAF50 7 | #9C27B0 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Spanomatic 3 | This is a green background color text, and this one is purple foreground. 4 | This is a cake drawable span. 5 | This is a relative text size span. 6 | Spanomatic supports strikethrough, bold, italic, bold italic, superscript, subscript and underline spans. 7 | This is a quote 8 | And this is a bullet 9 | Here we have three different typefaces: Lato Regular, Lato Light and Lato Bold 10 | This span clickable: click me 11 | 12 | -------------------------------------------------------------------------------- /app/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /app/src/test/java/com/grivos/spanomatic/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import org.junit.Assert.assertEquals 4 | import org.junit.Test 5 | 6 | /** 7 | * Example local unit test, which will execute on the development machine (host). 8 | * 9 | * See [testing documentation](http://d.android.com/tools/testing). 10 | */ 11 | class ExampleUnitTest { 12 | @Test 13 | fun addition_isCorrect() { 14 | assertEquals(4, 2 + 2) 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | // Top-level build file where you can add configuration options common to all sub-projects/modules. 2 | 3 | buildscript { 4 | ext.kotlin_version = '1.4.0' 5 | repositories { 6 | google() 7 | jcenter() 8 | } 9 | dependencies { 10 | classpath 'com.android.tools.build:gradle:4.0.1' 11 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" 12 | classpath 'com.github.dcendents:android-maven-gradle-plugin:1.4.1' 13 | classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3' 14 | 15 | // NOTE: Do not place your application dependencies here; they belong 16 | // in the individual module build.gradle files 17 | } 18 | } 19 | 20 | allprojects { 21 | repositories { 22 | google() 23 | jcenter() 24 | } 25 | } 26 | 27 | task clean(type: Delete) { 28 | delete rootProject.buildDir 29 | } 30 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx1536m 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # Kotlin code style for this project: "official" or "obsolete": 15 | kotlin.code.style=official 16 | android.useAndroidX=true 17 | android.enableJetifier=false 18 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sat Apr 27 18:22:34 IDT 2019 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /media/example_absolute_size.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_absolute_size.png -------------------------------------------------------------------------------- /media/example_bg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_bg.png -------------------------------------------------------------------------------- /media/example_bullet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_bullet.png -------------------------------------------------------------------------------- /media/example_click_toast.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_click_toast.gif -------------------------------------------------------------------------------- /media/example_drawable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_drawable.png -------------------------------------------------------------------------------- /media/example_fg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_fg.png -------------------------------------------------------------------------------- /media/example_format.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_format.png -------------------------------------------------------------------------------- /media/example_leading_margin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_leading_margin.png -------------------------------------------------------------------------------- /media/example_quote.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_quote.png -------------------------------------------------------------------------------- /media/example_relative_size.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_relative_size.png -------------------------------------------------------------------------------- /media/example_typeface.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_typeface.png -------------------------------------------------------------------------------- /media/example_url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grivos/Spanomatic/d682da05dc67eb0860e42e460b76471c6c82c510/media/example_url.png -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app', ':spanomatic' 2 | -------------------------------------------------------------------------------- /spanomatic/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /spanomatic/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.library' 2 | apply plugin: 'kotlin-android' 3 | 4 | android { 5 | compileSdkVersion 28 6 | 7 | defaultConfig { 8 | minSdkVersion 19 9 | targetSdkVersion 28 10 | versionCode 1 11 | versionName "1.0" 12 | 13 | testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner' 14 | 15 | } 16 | 17 | buildTypes { 18 | release { 19 | minifyEnabled false 20 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 21 | } 22 | } 23 | 24 | } 25 | 26 | dependencies { 27 | implementation fileTree(dir: 'libs', include: ['*.jar']) 28 | 29 | implementation 'androidx.appcompat:appcompat:1.2.0' 30 | implementation 'io.github.inflationx:viewpump:2.0.3' 31 | androidTestImplementation 'androidx.test.ext:junit:1.1.2' 32 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0' 33 | implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" 34 | testImplementation 'junit:junit:4.12' 35 | } 36 | repositories { 37 | mavenCentral() 38 | } 39 | 40 | apply from: 'publish.gradle' 41 | -------------------------------------------------------------------------------- /spanomatic/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class clickName to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file clickName. 21 | #-renamesourcefileattribute SourceFile 22 | -------------------------------------------------------------------------------- /spanomatic/publish.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.github.dcendents.android-maven' 2 | apply plugin: 'com.jfrog.bintray' 3 | 4 | Properties properties = new Properties() 5 | properties.load(project.rootProject.file('local.properties').newDataInputStream()) 6 | 7 | ext { 8 | bintrayRepo = 'Spanomatic' 9 | bintrayName = 'Spanomatic' 10 | 11 | publishedGroupId = 'com.grivos.spanomatic' 12 | libraryName = 'Spanomatic' 13 | artifact = 'spanomatic' 14 | 15 | libraryDescription = 'Automatically add spans to text from Android resources strings' 16 | 17 | siteUrl = 'https://github.com/grivos/Spanomatic' 18 | gitUrl = 'https://github.com/grivos/Spanomatic.git' 19 | 20 | libraryVersion = '1.1.0' 21 | 22 | developerId = 'grivos' 23 | developerName = 'Guy Griv' 24 | 25 | licenseName = 'The Apache Software License, Version 2.0' 26 | licenseUrl = 'http://www.apache.org/licenses/LICENSE-2.0.txt' 27 | allLicenses = ["Apache-2.0"] 28 | } 29 | 30 | group = publishedGroupId 31 | version = libraryVersion 32 | 33 | install { 34 | repositories.mavenInstaller { 35 | pom.project { 36 | packaging 'aar' 37 | groupId publishedGroupId 38 | artifactId artifact 39 | 40 | name libraryName 41 | description libraryDescription 42 | url siteUrl 43 | 44 | licenses { 45 | license { 46 | name licenseName 47 | url licenseUrl 48 | } 49 | } 50 | developers { 51 | developer { 52 | id developerId 53 | name developerName 54 | } 55 | } 56 | scm { 57 | connection gitUrl 58 | developerConnection gitUrl 59 | url siteUrl 60 | } 61 | } 62 | } 63 | } 64 | 65 | task sourcesJar(type: Jar) { 66 | classifier = 'sources' 67 | from android.sourceSets.main.java.srcDirs 68 | } 69 | 70 | tasks.withType(Javadoc) { 71 | enabled = false 72 | } 73 | 74 | task javadoc(type: Javadoc) { 75 | source = android.sourceSets.main.java.srcDirs 76 | classpath += project.files(android.getBootClasspath().join(File.pathSeparator)) 77 | android.libraryVariants.all { variant -> 78 | if (variant.name == 'release') { 79 | owner.classpath += variant.javaCompile.classpath 80 | } 81 | } 82 | exclude '**/R.html', '**/R.*.html', '**/index.html', '**/BuildConfig.java' 83 | } 84 | 85 | task javadocJar(type: Jar, dependsOn: javadoc) { 86 | classifier = 'javadoc' 87 | from javadoc.destinationDir 88 | } 89 | 90 | artifacts { 91 | archives javadocJar 92 | archives sourcesJar 93 | } 94 | 95 | 96 | 97 | bintray { 98 | user = properties.getProperty("bintray.user") 99 | key = properties.getProperty("bintray.apikey") 100 | configurations = ['archives'] 101 | pkg { 102 | repo = bintrayRepo 103 | name = bintrayName 104 | desc = libraryDescription 105 | websiteUrl = siteUrl 106 | vcsUrl = gitUrl 107 | licenses = allLicenses 108 | dryRun = false 109 | publish = true 110 | override = false 111 | publicDownloadNumbers = true 112 | version { 113 | desc = libraryDescription 114 | } 115 | } 116 | } -------------------------------------------------------------------------------- /spanomatic/src/androidTest/java/com/grivos/spanomatic/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic; 2 | 3 | import android.content.Context; 4 | import androidx.test.platform.app.InstrumentationRegistry; 5 | import androidx.test.ext.junit.runners.AndroidJUnit4; 6 | import org.junit.Test; 7 | import org.junit.runner.RunWith; 8 | 9 | import static org.junit.Assert.assertEquals; 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * @see Testing documentation 15 | */ 16 | @RunWith(AndroidJUnit4.class) 17 | public class ExampleInstrumentedTest { 18 | @Test 19 | public void useAppContext() { 20 | // Context of the app under test. 21 | Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext(); 22 | 23 | assertEquals("com.grivos.spans.test", appContext.getPackageName()); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /spanomatic/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/AnnotationSpanHandlers.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import android.content.Context 4 | import android.graphics.Typeface 5 | import android.text.style.* 6 | import com.grivos.spanomatic.spans.CustomTypefaceSpan 7 | import com.grivos.spanomatic.spans.ListenableClickableSpan 8 | import com.grivos.spanomatic.utils.parseAnnotationColor 9 | import com.grivos.spanomatic.utils.parseAnnotationDimension 10 | 11 | internal val clickHandler = { annotationValue: String, _: Context -> 12 | ListenableClickableSpan(annotationValue) 13 | } 14 | 15 | internal val fgColorHandler = { annotationValue: String, context: Context -> 16 | val color = parseAnnotationColor(annotationValue, context) 17 | ForegroundColorSpan(color) 18 | } 19 | 20 | internal val bgColorHandler = { annotationValue: String, context: Context -> 21 | val color = parseAnnotationColor(annotationValue, context) 22 | BackgroundColorSpan(color) 23 | } 24 | 25 | internal val drawableHandler = { annotationValue: String, context: Context -> 26 | val split = annotationValue.split(ANNOTATION_VALUE_DELIMITER) 27 | val verticalAlignment = if (split.size == 2) { 28 | when (val alignmentKey = split[1]) { 29 | KEY_DRAWABLE_ALIGN_BASELINE -> ImageSpan.ALIGN_BASELINE 30 | KEY_DRAWABLE_ALIGN_BOTTOM -> ImageSpan.ALIGN_BOTTOM 31 | else -> throw IllegalAccessException("Unknown vertical alignment: $alignmentKey") 32 | } 33 | } else { 34 | // default value 35 | ImageSpan.ALIGN_BASELINE 36 | } 37 | val drawableResId = context.resources.getIdentifier(split[0], null, context.packageName) 38 | ImageSpan( 39 | context, drawableResId, 40 | verticalAlignment 41 | ) 42 | } 43 | 44 | internal val relativeTextSizeHandler = { annotationValue: String, _: Context -> 45 | RelativeSizeSpan(annotationValue.toFloat()) 46 | } 47 | 48 | internal val absoluteTextSizeHandler = { annotationValue: String, context: Context -> 49 | val pixelSize = parseAnnotationDimension(annotationValue, context) 50 | AbsoluteSizeSpan(pixelSize) 51 | } 52 | 53 | @Suppress("IMPLICIT_CAST_TO_ANY") 54 | internal val formatHandler = { annotationValue: String, _: Context -> 55 | when (annotationValue) { 56 | KEY_FORMAT_STRIKETHROUGH -> StrikethroughSpan() 57 | KEY_FORMAT_BOLD -> StyleSpan(Typeface.BOLD) 58 | KEY_FORMAT_ITALIC -> StyleSpan(Typeface.ITALIC) 59 | KEY_FORMAT_BOLD_ITALIC -> StyleSpan(Typeface.BOLD_ITALIC) 60 | KEY_FORMAT_SUPERSCRIPT -> SuperscriptSpan() 61 | KEY_FORMAT_SUBSCRIPT -> SubscriptSpan() 62 | KEY_FORMAT_UNDERLINE -> UnderlineSpan() 63 | else -> throw IllegalAccessException("Unknown format: $annotationValue") 64 | } 65 | } 66 | 67 | internal val quoteHandler = { annotationValue: String, context: Context -> 68 | if (annotationValue.isEmpty()) { 69 | QuoteSpan() 70 | } else { 71 | val color = parseAnnotationColor(annotationValue, context) 72 | QuoteSpan(color) 73 | } 74 | } 75 | 76 | internal val bulletHandler = { annotationValue: String, context: Context -> 77 | if (annotationValue.isEmpty()) { 78 | BulletSpan() 79 | } else { 80 | val split = annotationValue.split(ANNOTATION_VALUE_DELIMITER) 81 | val gapWidth = parseAnnotationDimension(split[0], context) 82 | if (split.size == 2) { 83 | val color = parseAnnotationColor(split[1], context) 84 | BulletSpan(gapWidth, color) 85 | } else { 86 | BulletSpan(gapWidth) 87 | } 88 | } 89 | } 90 | 91 | internal val urlHandler = { annotationValue: String, _: Context -> 92 | URLSpan(annotationValue) 93 | } 94 | 95 | internal val typefaceHandler = { annotationValue: String, context: Context -> 96 | val provider = Spanomatic.typefaceProvider 97 | if (provider == null) { 98 | throw IllegalAccessException("No typeface provider found") 99 | } else { 100 | val typefaceKey = if (annotationValue.startsWith(ANNOTATION_VALUE_STRING_RES_PREFIX)) { 101 | val id = context.resources.getIdentifier(annotationValue, null, context.packageName) 102 | context.getString(id) 103 | } else { 104 | annotationValue 105 | } 106 | val typeface = provider.getTypeface(typefaceKey) 107 | if (typeface == null) { 108 | throw IllegalAccessException("Unknown typeface: $annotationValue") 109 | } else { 110 | CustomTypefaceSpan(typeface) 111 | } 112 | } 113 | } 114 | 115 | internal val leadingMarginHandler = { annotationValue: String, context: Context -> 116 | val pixelSize = parseAnnotationDimension(annotationValue, context) 117 | LeadingMarginSpan.Standard(pixelSize) 118 | } 119 | 120 | private const val ANNOTATION_VALUE_DELIMITER = "|" 121 | private const val ANNOTATION_VALUE_STRING_RES_PREFIX = "@string" 122 | 123 | private const val KEY_FORMAT_STRIKETHROUGH = "strikethrough" 124 | private const val KEY_FORMAT_BOLD = "bold" 125 | private const val KEY_FORMAT_ITALIC = "italic" 126 | private const val KEY_FORMAT_BOLD_ITALIC = "boldItalic" 127 | private const val KEY_FORMAT_SUPERSCRIPT = "superscript" 128 | private const val KEY_FORMAT_SUBSCRIPT = "subscript" 129 | private const val KEY_FORMAT_UNDERLINE = "underline" 130 | 131 | private const val KEY_DRAWABLE_ALIGN_BASELINE = "baseline" 132 | private const val KEY_DRAWABLE_ALIGN_BOTTOM = "bottom" -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/PlaceholderFormatter.kt: -------------------------------------------------------------------------------- 1 | /** 2 | * This class was adapted from a library by Mark Allison: 3 | * https://github.com/StylingAndroid/Rialto/ 4 | */ 5 | package com.grivos.spanomatic 6 | 7 | import android.text.SpannableStringBuilder 8 | import android.text.SpannedString 9 | import java.util.regex.Pattern 10 | 11 | /** 12 | * A utility class that helps formatting string resources while preserving annotations 13 | */ 14 | internal object PlaceholderFormatter { 15 | private const val index = "(\\d+\\\$)" 16 | private const val width = "(\\d+)?" 17 | private const val precision = "(\\.\\d+)?" 18 | private const val general = "(-)?($width[bBhHsScC])" 19 | private const val character = "(-)?($width[cC])" 20 | private const val decimal = "(([-+ 0,(]*)?${width}d)" 21 | private const val integral = "(([-#+ 0(]*)?$width[oxX])" 22 | private const val floatingPoint = "(([-#+ 0(]*)?$width$precision[eEfgG])" 23 | private const val floatingPointHex = "(([-#+ ]*)?$width$precision[aA])" 24 | private const val dateTime = "(([-]*)?$width[tT][HIklMSLNpzZsQBbhAaCYyjmdeRTrDFc])" 25 | private const val percent = "(-?$width%)" 26 | private const val lineSeparator = "(n)" 27 | private val pattern = Pattern.compile( 28 | @Suppress("MaxLineLength") 29 | "%$index($general|$character|$decimal|$integral|$floatingPoint|$floatingPointHex|$dateTime|$percent|$lineSeparator)" 30 | ) 31 | 32 | fun format(spanned: SpannedString, vararg formatArgs: Any?): CharSequence { 33 | val builder = SpannableStringBuilder(spanned) 34 | pattern.matcher(builder).apply { 35 | while (find()) { 36 | String.format(builder.substring(start() until end()), *formatArgs) 37 | .also { replacement -> 38 | builder.replace(start(), end(), replacement) 39 | } 40 | reset(builder) 41 | } 42 | } 43 | return builder 44 | } 45 | } -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/Spanomatic.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import android.content.Context 4 | import android.text.Spannable 5 | import android.text.SpannableString 6 | import android.text.Spanned 7 | 8 | 9 | object Spanomatic { 10 | 11 | private val annotationHandlers = mutableMapOf Any>() 12 | @JvmStatic 13 | var typefaceProvider: TypefaceProvider? = null 14 | 15 | init { 16 | setAnnotationSpanHandler(ANNOTATION_KEY_CLICK, clickHandler) 17 | setAnnotationSpanHandler(ANNOTATION_KEY_FOREGROUND_COLOR, fgColorHandler) 18 | setAnnotationSpanHandler(ANNOTATION_KEY_BACKGROUND_COLOR, bgColorHandler) 19 | setAnnotationSpanHandler(ANNOTATION_KEY_DRAWABLE, drawableHandler) 20 | setAnnotationSpanHandler(ANNOTATION_KEY_TEXT_SIZE_RELATIVE, relativeTextSizeHandler) 21 | setAnnotationSpanHandler(ANNOTATION_KEY_TEXT_SIZE_ABSOLUTE, absoluteTextSizeHandler) 22 | setAnnotationSpanHandler(ANNOTATION_KEY_FORMAT, formatHandler) 23 | setAnnotationSpanHandler(ANNOTATION_KEY_QUOTE, quoteHandler) 24 | setAnnotationSpanHandler(ANNOTATION_KEY_BULLET, bulletHandler) 25 | setAnnotationSpanHandler(ANNOTATION_KEY_URL, urlHandler) 26 | setAnnotationSpanHandler(ANNOTATION_KEY_TYPEFACE, typefaceHandler) 27 | setAnnotationSpanHandler(ANNOTATION_KEY_LEADING_MARGIN, leadingMarginHandler) 28 | } 29 | 30 | @JvmStatic 31 | fun addSpansFromAnnotations(charSequence: CharSequence?, context: Context): CharSequence? { 32 | if (charSequence !is Spanned) return charSequence 33 | val annotations = charSequence.getSpans(0, charSequence.length, android.text.Annotation::class.java) 34 | val spannableString = SpannableString(charSequence) 35 | for (annotation in annotations) { 36 | annotationHandlers[annotation.key] 37 | ?.invoke(annotation.value, context) 38 | ?.let { span -> 39 | spannableString.setSpan( 40 | span, 41 | charSequence.getSpanStart(annotation), 42 | charSequence.getSpanEnd(annotation), 43 | Spannable.SPAN_EXCLUSIVE_EXCLUSIVE 44 | ) 45 | } 46 | } 47 | return spannableString 48 | } 49 | 50 | @JvmStatic 51 | fun setAnnotationSpanHandler( 52 | annotationKey: String, 53 | handler: (annotationValue: String, context: Context) -> Any 54 | ): Spanomatic { 55 | return apply { 56 | annotationHandlers[annotationKey] = handler 57 | } 58 | } 59 | } 60 | 61 | private const val ANNOTATION_KEY_CLICK = "click" 62 | private const val ANNOTATION_KEY_FOREGROUND_COLOR = "fgColor" 63 | private const val ANNOTATION_KEY_BACKGROUND_COLOR = "bgColor" 64 | private const val ANNOTATION_KEY_DRAWABLE = "drawable" 65 | private const val ANNOTATION_KEY_TEXT_SIZE_RELATIVE = "relativeTextSize" 66 | private const val ANNOTATION_KEY_TEXT_SIZE_ABSOLUTE = "absoluteTextSize" 67 | private const val ANNOTATION_KEY_FORMAT = "format" 68 | private const val ANNOTATION_KEY_QUOTE = "quote" 69 | private const val ANNOTATION_KEY_BULLET = "bullet" 70 | private const val ANNOTATION_KEY_URL = "url" 71 | private const val ANNOTATION_KEY_TYPEFACE = "typeface" 72 | private const val ANNOTATION_KEY_LEADING_MARGIN = "leadingMargin" 73 | 74 | -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/SpanomaticInterceptor.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import android.widget.TextView 4 | import io.github.inflationx.viewpump.InflateResult 5 | import io.github.inflationx.viewpump.Interceptor 6 | 7 | class SpanomaticInterceptor : Interceptor { 8 | override fun intercept(chain: Interceptor.Chain): InflateResult { 9 | val result = chain.proceed(chain.request()) 10 | val view = result.view 11 | if (view is TextView) { 12 | view.text = Spanomatic.addSpansFromAnnotations(view.text, view.context) 13 | } 14 | return result 15 | } 16 | 17 | } -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/TypefaceProvider.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic 2 | 3 | import android.graphics.Typeface 4 | 5 | interface TypefaceProvider { 6 | fun getTypeface(name: String): Typeface? 7 | } -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/spans/CustomTypefaceSpan.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.spans 2 | 3 | import android.graphics.Paint 4 | import android.graphics.Typeface 5 | import android.text.TextPaint 6 | import android.text.style.MetricAffectingSpan 7 | 8 | class CustomTypefaceSpan(private val typeface: Typeface) : MetricAffectingSpan() { 9 | 10 | override fun updateDrawState(ds: TextPaint) { 11 | applyCustomTypeFace(ds, typeface) 12 | } 13 | 14 | override fun updateMeasureState(paint: TextPaint) { 15 | applyCustomTypeFace(paint, typeface) 16 | } 17 | 18 | private fun applyCustomTypeFace(paint: Paint, tf: Typeface) { 19 | paint.typeface = tf 20 | } 21 | } -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/spans/ListenableClickableSpan.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.spans 2 | 3 | import android.text.TextPaint 4 | import android.text.style.ClickableSpan 5 | import android.view.View 6 | 7 | class ListenableClickableSpan(val clickName: String) : ClickableSpan() { 8 | 9 | var listener: Listener? = null 10 | 11 | override fun onClick(widget: View) { 12 | listener?.onClick(clickName) 13 | } 14 | 15 | override fun updateDrawState(ds: TextPaint) { 16 | // don't decorate the link 17 | // if a user wants to add underline he can wrap the "click" annotation with a "format" annotation 18 | } 19 | 20 | interface Listener { 21 | fun onClick(clickName: String) 22 | } 23 | 24 | } -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/utils/Extensions.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.utils 2 | 3 | import android.content.Context 4 | import android.text.SpannableString 5 | import android.text.SpannedString 6 | import android.text.method.LinkMovementMethod 7 | import android.widget.TextView 8 | import androidx.annotation.StringRes 9 | import androidx.fragment.app.Fragment 10 | import com.grivos.spanomatic.PlaceholderFormatter 11 | import com.grivos.spanomatic.Spanomatic 12 | import com.grivos.spanomatic.spans.ListenableClickableSpan 13 | 14 | fun TextView.addSpanClickListener( 15 | clickName: String, 16 | addLinkMovementMethod: Boolean = true, 17 | callback: (clickName: String) -> Unit 18 | ): TextView { 19 | return apply { 20 | if (movementMethod == null && addLinkMovementMethod) { 21 | movementMethod = LinkMovementMethod.getInstance() 22 | } 23 | val text = text 24 | if (text is SpannableString) { 25 | text.getSpans(0, text.length, ListenableClickableSpan::class.java) 26 | .first { clickableSpan -> clickableSpan.clickName == clickName } 27 | .let { clickableSpan -> 28 | clickableSpan.listener = object : ListenableClickableSpan.Listener { 29 | override fun onClick(clickName: String) { 30 | callback(clickName) 31 | } 32 | 33 | } 34 | } 35 | } 36 | } 37 | } 38 | 39 | fun Context.addSpansFromAnnotations(@StringRes id: Int): CharSequence? = addSpansFromAnnotations(getText(id), this) 40 | 41 | fun Fragment.addSpansFromAnnotations(@StringRes id: Int): CharSequence? = context?.addSpansFromAnnotations(id) 42 | 43 | fun Context.addSpansFromAnnotations(@StringRes id: Int, vararg formatArgs: Any): CharSequence? { 44 | val text = getText(id) 45 | return if (text is SpannedString) { 46 | val replaced = PlaceholderFormatter.format(text, *formatArgs) 47 | Spanomatic.addSpansFromAnnotations(replaced, this) 48 | } else { 49 | getString(id, formatArgs) 50 | } 51 | } 52 | 53 | fun Context.addSpansFromAnnotations(text: CharSequence, vararg formatArgs: Any): CharSequence? { 54 | return if (text is SpannedString) { 55 | val replaced = PlaceholderFormatter.format(text, *formatArgs) 56 | Spanomatic.addSpansFromAnnotations(replaced, this) 57 | } else { 58 | text.toString().format(*formatArgs) 59 | } 60 | } 61 | 62 | fun Fragment.addSpansFromAnnotations(@StringRes id: Int, vararg formatArgs: Any): CharSequence? = 63 | context?.addSpansFromAnnotations(id, *formatArgs) 64 | 65 | fun Fragment.addSpansFromAnnotations(text: CharSequence, vararg formatArgs: Any): CharSequence? = 66 | context?.addSpansFromAnnotations(text, *formatArgs) -------------------------------------------------------------------------------- /spanomatic/src/main/java/com/grivos/spanomatic/utils/Utils.kt: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic.utils 2 | 3 | import android.content.Context 4 | import android.graphics.Color 5 | import androidx.core.content.ContextCompat 6 | import android.util.TypedValue 7 | 8 | fun parseAnnotationColor(colorValue: String, context: Context): Int { 9 | return when { 10 | colorValue.startsWith(ANNOTATION_VALUE_COLOR_RES_PREFIX) -> { 11 | val id = context.resources.getIdentifier(colorValue, null, context.packageName) 12 | ContextCompat.getColor(context, id) 13 | } 14 | else -> Color.parseColor(colorValue) 15 | } 16 | } 17 | 18 | fun parseAnnotationDimension(rawSize: String, context: Context): Int { 19 | return when { 20 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_DP_SUFFIX) -> { 21 | val size = rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_DP_SUFFIX).toFloat() 22 | TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, size, context.resources.displayMetrics).toInt() 23 | } 24 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_SP_SUFFIX) -> { 25 | val size = rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_SP_SUFFIX).toFloat() 26 | TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP, size, context.resources.displayMetrics).toInt() 27 | } 28 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_PT_SUFFIX) -> { 29 | val size = rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_PT_SUFFIX).toFloat() 30 | TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_PT, size, context.resources.displayMetrics).toInt() 31 | } 32 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_PX_SUFFIX) -> { 33 | rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_PX_SUFFIX).toInt() 34 | } 35 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_MM_SUFFIX) -> { 36 | val size = rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_MM_SUFFIX).toFloat() 37 | TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_MM, size, context.resources.displayMetrics).toInt() 38 | } 39 | rawSize.endsWith(ANNOTATION_VALUE_DIMEN_IN_SUFFIX) -> { 40 | val size = rawSize.substringBefore(ANNOTATION_VALUE_DIMEN_IN_SUFFIX).toFloat() 41 | TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_IN, size, context.resources.displayMetrics).toInt() 42 | } 43 | rawSize.startsWith(ANNOTATION_VALUE_DIMEN_RES_PREFIX) -> { 44 | val id = context.resources.getIdentifier(rawSize, null, context.packageName) 45 | context.resources.getDimensionPixelSize(id) 46 | } 47 | else -> throw IllegalAccessException("Unknown size: $rawSize") 48 | } 49 | } 50 | 51 | private const val ANNOTATION_VALUE_COLOR_RES_PREFIX = "@color" 52 | private const val ANNOTATION_VALUE_DIMEN_RES_PREFIX = "@dimen" 53 | 54 | private const val ANNOTATION_VALUE_DIMEN_DP_SUFFIX = "dp" 55 | private const val ANNOTATION_VALUE_DIMEN_SP_SUFFIX = "sp" 56 | private const val ANNOTATION_VALUE_DIMEN_PT_SUFFIX = "pt" 57 | private const val ANNOTATION_VALUE_DIMEN_PX_SUFFIX = "px" 58 | private const val ANNOTATION_VALUE_DIMEN_MM_SUFFIX = "mm" 59 | private const val ANNOTATION_VALUE_DIMEN_IN_SUFFIX = "in" -------------------------------------------------------------------------------- /spanomatic/src/test/java/com/grivos/spanomatic/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package com.grivos.spanomatic; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.assertEquals; 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * @see Testing documentation 11 | */ 12 | public class ExampleUnitTest { 13 | @Test 14 | public void addition_isCorrect() { 15 | assertEquals(4, 2 + 2); 16 | } 17 | } --------------------------------------------------------------------------------