├── .gitignore ├── .idea ├── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── encodings.xml ├── misc.xml ├── runConfigurations.xml └── vcs.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── jimmysun │ │ └── guide │ │ └── ExampleInstrumentedTest.java │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── jimmysun │ │ │ └── guidedemo │ │ │ ├── MainActivity.java │ │ │ ├── MyAdapter.java │ │ │ ├── MyFragment.java │ │ │ ├── MyFragmentActivity.java │ │ │ ├── RecyclerActivity.java │ │ │ └── Utils.java │ └── res │ │ ├── drawable-v24 │ │ └── ic_launcher_foreground.xml │ │ ├── drawable-xxhdpi │ │ └── right_arrow.png │ │ ├── drawable │ │ ├── ic_launcher_background.xml │ │ └── solid_white_bg.xml │ │ ├── layout │ │ ├── activity_main.xml │ │ ├── activity_my_fragment.xml │ │ ├── activity_recycler.xml │ │ ├── fragment_my.xml │ │ ├── layout_info.xml │ │ └── recycler_item.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 │ └── jimmysun │ └── guide │ └── ExampleUnitTest.java ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── guide ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── jimmysun │ │ └── guide │ │ └── ExampleInstrumentedTest.java │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── jimmysun │ │ │ └── guide │ │ │ ├── CircleHighlightView.java │ │ │ ├── GuideManager.java │ │ │ ├── GuideView.java │ │ │ ├── HighlightView.java │ │ │ ├── OvalHighlightView.java │ │ │ ├── RectHighlightView.java │ │ │ └── ScreenUtils.java │ └── res │ │ └── values │ │ ├── strings.xml │ │ └── styles.xml │ └── test │ └── java │ └── com │ └── jimmysun │ └── guide │ └── ExampleUnitTest.java ├── image ├── align_type.png ├── device-2019-01-22-193943.png ├── device-2019-01-22-194114.png ├── device-2019-01-22-194201.png ├── device-2019-01-22-194235.png └── device-2019-01-22-194311.png └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea/modules.xml 2 | .DS_Store 3 | # Built application files 4 | *.apk 5 | *.ap_ 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | 18 | # Gradle files 19 | .gradle/ 20 | build/ 21 | 22 | # Local configuration file (sdk path, etc) 23 | local.properties 24 | 25 | # Proguard folder generated by Eclipse 26 | proguard/ 27 | 28 | # Log Files 29 | *.log 30 | 31 | # Android Studio Navigation editor temp files 32 | .navigation/ 33 | 34 | # Android Studio captures folder 35 | captures/ 36 | 37 | # IntelliJ 38 | *.iml 39 | .idea/workspace.xml 40 | .idea/tasks.xml 41 | .idea/gradle.xml 42 | .idea/assetWizardSettings.xml 43 | .idea/dictionaries 44 | .idea/libraries 45 | .idea/caches 46 | 47 | # Keystore files 48 | # Uncomment the following line if you do not want to check your keystore files in. 49 | #*.jks 50 | 51 | # External native build folder generated in Android Studio 2.2 and later 52 | .externalNativeBuild 53 | 54 | # Google Services (e.g. APIs or Firebase) 55 | google-services.json 56 | 57 | # Freeline 58 | freeline.py 59 | freeline/ 60 | freeline_project_description.json 61 | 62 | # fastlane 63 | fastlane/report.xml 64 | fastlane/Preview.html 65 | fastlane/screenshots 66 | fastlane/test_output 67 | fastlane/readme.md -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 15 | 16 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/encodings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 22 | 37 | 38 | 39 | 40 | 41 | 42 | 44 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 12 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /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 | 新手引导浮层 2 | ===== 3 | 4 | 本引导浮层框架支持如下功能：
5 | （1）添加高亮的区域，该区域可以为矩形、椭圆和圆形，并且可以为该区域增加padding。
6 | （2）在浮层上添加组件，该组件可以相对于当前已显示的某个组件的位置添加，也可以自定义显示的位置。
7 | （3）浮层的显示与消失。
8 | （4）清除高亮的区域和添加的组件，更新浮层的视图（通常为多步骤引导使用）。
9 | （5）其它功能：设置浮层是否点击可消失、点击的事件和返回键是否可取消等等。
10 |
11 | 12 | 引用方式 13 | ------- 14 | maven： 15 | ```xml 16 | 17 | com.jimmysun 18 | guide 19 | 2.0.1 20 | pom 21 | 22 | ``` 23 | gradle： 24 | ``` 25 | compile 'com.jimmysun:guide:2.0.1' 26 | ``` 27 | 28 | 示例 29 | ---- 30 | 代码参见[https://github.com/jimmysuncpt/Guide/tree/master/app](https://github.com/jimmysuncpt/Guide/tree/master/app)
31 | 截图：
32 |
33 | 34 | 使用方式 35 | ------- 36 | ```java 37 | GuideManager guideManager = new GuideManager(context) 38 | .highlightViewInRect(view) // 以矩形的方式高亮显示视图 39 | .highlightViewInRect(view, padding) // 以矩形的方式高亮显示视图，带间距 40 | .highlightViewInRect(view, paddingLeft, paddingTop, paddingRight, paddingBottom) // 以矩形的方式高亮显示视图，带间距 41 | .highlightViewInOval(view) // 以椭圆形的方式高亮显示视图 42 | .highlightViewInOval(view, padding) // 以椭圆形的方式高亮显示视图，带间距 43 | .highlightViewInOval(view, paddingLeft, paddingTop, paddingRight, paddingBottom) // 以椭圆形的方式高亮显示视图，带间距 44 | .highlightViewInCircle(view) // 以圆形的方式高亮显示视图 45 | .highlightViewInCircle(view, paddingRadius) // 以圆形的方式高亮显示视图，带间距 46 | .addViewRelativeTo(view, relativeTo, alignType, xMargin, yMargin) // 相对于某个视图添加一个视图，见注意事项（3） 47 | .addView(view, params) // 以指定的布局参数添加一个视图 48 | .updateViewLayout(view, params) // 更新视图的布局参数 49 | .removeView(view) // 删除一个视图 50 | .clear() // 清除所有高亮的区域和添加的视图 51 | .setCancelable(true) // 设置是否可以按返回键消失 52 | .setCanceledOnTouch(true) // 设置是否可以点击消失 53 | .setOnClickListener(onClickListener) // 设置点击事件监听器 54 | .setAlpha(0.7f) // 设置透明度，0~1，默认0.7 55 | .requestLayout(); // 更新布局 56 | guideManager.isShowing(); // 是否正在显示 57 | guideManager.show(); // 显示 58 | guideManager.dismiss(); // 消失 59 | ``` 60 | ### 注意事项 61 | （1）如果要获取某个视图的具体显示位置，通常在这个视图的addOnGlobalLayoutListener()方法中使用GuideManager，代码如下： 62 | ```java 63 | view.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver.OnGlobalLayoutListener() { 64 | @Override 65 | public void onGlobalLayout() { 66 | view.getViewTreeObserver().removeOnGlobalLayoutListener(this); 67 | // show guide 68 | } 69 | }); 70 | 71 | ``` 72 | （2）如果想做多步骤引导，可以嵌套使用，代码如下： 73 | ```java 74 | // 第一步... 75 | guideManager.setOnClickListener(new View.OnClickListener() { 76 | @Override 77 | public void onClick(View v) { 78 | guideManager.clear(); 79 | // 第二步... 80 | guideManager.setOnClickListener(new View.OnClickListener() { 81 | @Override 82 | public void onClick(View v) { 83 | guideManager.clear(); 84 | // 第三步... 85 | } 86 | }); 87 | } 88 | }); 89 | guideManager.show(); 90 | ``` 91 | （3）addViewRelativeTo(view, relativeTo, alignType, xMargin, yMargin)方法参数说明
92 | - view：要添加的视图。
93 | - relativeTo：相对的视图。
94 | - alignType：对齐方式，可使用GuideManager的LEFT_OF、RIGHT_OF、ABOVE、BELOW、ALIGN_LEFT、ALIGN_TOP、ALIGN_RIGHT和ALIGN_BOTTOM，如果要使用多种对齐方式，可以采用“或”的方式，例如“GuideManager.RIGHT_OF | GuideManager.BELOW”。
95 | - xMargin：横向的距离，单位px。
96 | - yMargin：纵向的距离，单位px。
97 | 对齐方式及相对距离如图所示：
98 | 99 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build 2 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 27 5 | defaultConfig { 6 | applicationId "com.jimmysun.guidedemo" 7 | minSdkVersion 18 8 | targetSdkVersion 27 9 | versionCode VERSION_CODE as int 10 | versionName VERSION_NAME 11 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 12 | multiDexEnabled true 13 | } 14 | buildTypes { 15 | release { 16 | minifyEnabled false 17 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 18 | } 19 | } 20 | } 21 | 22 | dependencies { 23 | implementation fileTree(dir: 'libs', include: ['*.jar']) 24 | implementation 'com.android.support:appcompat-v7:27.0.2' 25 | testImplementation 'junit:junit:4.12' 26 | androidTestImplementation 'com.android.support.test:runner:1.0.1' 27 | androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1' 28 | implementation 'com.android.support:recyclerview-v7:27.0.2' 29 | implementation project(':guide') 30 | } 31 | -------------------------------------------------------------------------------- /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/jimmysun/guide/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guide; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumented test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) 18 | public class ExampleInstrumentedTest { 19 | @Test 20 | public void useAppContext() { 21 | // Context of the app under test. 22 | Context appContext = InstrumentationRegistry.getTargetContext(); 23 | 24 | assertEquals("com.jimmysun.guide", appContext.getPackageName()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 12 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 25 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/MainActivity.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | import android.content.Intent; 4 | import android.graphics.Color; 5 | import android.os.Bundle; 6 | import android.support.v7.app.AppCompatActivity; 7 | import android.view.View; 8 | import android.view.ViewGroup; 9 | import android.view.ViewTreeObserver; 10 | import android.widget.ImageView; 11 | import android.widget.LinearLayout; 12 | import android.widget.RelativeLayout; 13 | import android.widget.TextView; 14 | 15 | import com.jimmysun.guide.GuideManager; 16 | 17 | public class MainActivity extends AppCompatActivity { 18 | private TextView mHelloTextView; 19 | private View mGuideButton, mListButton, mFragmentButton; 20 | 21 | @Override 22 | protected void onCreate(Bundle savedInstanceState) { 23 | super.onCreate(savedInstanceState); 24 | setContentView(R.layout.activity_main); 25 | mHelloTextView = findViewById(R.id.tv_hello); 26 | mGuideButton = findViewById(R.id.btn_guide); 27 | mListButton = findViewById(R.id.btn_list); 28 | mFragmentButton = findViewById(R.id.btn_fragment); 29 | mGuideButton.setOnClickListener(new View.OnClickListener() { 30 | @Override 31 | public void onClick(View v) { 32 | showGuide(); 33 | } 34 | }); 35 | mHelloTextView.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver 36 | .OnGlobalLayoutListener() { 37 | @Override 38 | public void onGlobalLayout() { 39 | mHelloTextView.getViewTreeObserver().removeOnGlobalLayoutListener(this); 40 | showGuide(); 41 | } 42 | }); 43 | mListButton.setOnClickListener(new View.OnClickListener() { 44 | @Override 45 | public void onClick(View v) { 46 | startActivity(new Intent(MainActivity.this, RecyclerActivity.class)); 47 | } 48 | }); 49 | mFragmentButton.setOnClickListener(new View.OnClickListener() { 50 | @Override 51 | public void onClick(View v) { 52 | startActivity(new Intent(MainActivity.this, MyFragmentActivity.class)); 53 | } 54 | }); 55 | } 56 | 57 | private void showGuide() { 58 | final GuideManager guideManager = new GuideManager(this); 59 | guideManager.highlightViewInRect(mHelloTextView, Utils.dip2px(this, 20), 60 | Utils.dip2px(this, 10), Utils.dip2px(this, 20), Utils.dip2px(this, 10)); 61 | 62 | ImageView imageView = new ImageView(this); 63 | imageView.setId(View.generateViewId()); 64 | imageView.setImageResource(R.drawable.right_arrow); 65 | guideManager.addViewRelativeTo(imageView, mHelloTextView, GuideManager.BELOW, 66 | Utils.dip2px(this, -10), Utils.dip2px(this, 20)); 67 | TextView textView = new TextView(this); 68 | textView.setText("这是一个TextView"); 69 | textView.setTextColor(Color.WHITE); 70 | textView.setTextSize(16); 71 | RelativeLayout.LayoutParams layoutParams = 72 | new RelativeLayout.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, 73 | ViewGroup.LayoutParams.WRAP_CONTENT); 74 | layoutParams.addRule(RelativeLayout.BELOW, imageView.getId()); 75 | layoutParams.addRule(RelativeLayout.ALIGN_LEFT, imageView.getId()); 76 | layoutParams.topMargin = Utils.dip2px(this, 10); 77 | layoutParams.leftMargin = Utils.dip2px(this, -20); 78 | guideManager.addView(textView, layoutParams); 79 | guideManager.setCancelable(false); 80 | guideManager.show(); 81 | guideManager.setOnClickListener(new View.OnClickListener() { 82 | @Override 83 | public void onClick(View v) { 84 | guideManager.clear(); 85 | guideManager.highlightViewInOval(mGuideButton, Utils.dip2px(MainActivity.this, 86 | 10), Utils.dip2px(MainActivity.this, 10), Utils.dip2px(MainActivity.this, 87 | 10), Utils.dip2px(MainActivity.this, 10)); 88 | LinearLayout linearLayout = (LinearLayout) getLayoutInflater().inflate(R.layout 89 | .layout_info, null); 90 | guideManager.addViewRelativeTo(linearLayout, mGuideButton, 91 | GuideManager.BELOW | GuideManager.ALIGN_RIGHT, 92 | Utils.dip2px(MainActivity.this, 20), Utils.dip2px(MainActivity.this, 20)); 93 | guideManager.setOnClickListener(new View.OnClickListener() { 94 | @Override 95 | public void onClick(View v) { 96 | guideManager.clear(); 97 | guideManager.highlightViewInCircle(mListButton); 98 | TextView textView = new TextView(MainActivity.this); 99 | textView.setText("我知道了"); 100 | textView.setTextColor(Color.WHITE); 101 | textView.setTextSize(16); 102 | textView.setPadding(Utils.dip2px(MainActivity.this, 10), 103 | Utils.dip2px(MainActivity.this, 5), 104 | Utils.dip2px(MainActivity.this, 10), 105 | Utils.dip2px(MainActivity.this, 5)); 106 | textView.setBackgroundResource(R.drawable.solid_white_bg); 107 | textView.setOnClickListener(new View.OnClickListener() { 108 | @Override 109 | public void onClick(View v) { 110 | guideManager.dismiss(); 111 | } 112 | }); 113 | RelativeLayout.LayoutParams layoutParams = new RelativeLayout 114 | .LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup 115 | .LayoutParams.WRAP_CONTENT); 116 | layoutParams.addRule(RelativeLayout.ALIGN_PARENT_BOTTOM); 117 | layoutParams.addRule(RelativeLayout.CENTER_HORIZONTAL); 118 | layoutParams.bottomMargin = Utils.dip2px(MainActivity.this, 50); 119 | guideManager.addView(textView, layoutParams); 120 | 121 | guideManager.setCanceledOnTouch(false); 122 | } 123 | }); 124 | } 125 | }); 126 | } 127 | } 128 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/MyAdapter.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | import android.content.Context; 4 | import android.graphics.Color; 5 | import android.support.v7.widget.RecyclerView; 6 | import android.view.LayoutInflater; 7 | import android.view.View; 8 | import android.view.ViewGroup; 9 | import android.view.ViewTreeObserver; 10 | import android.widget.Button; 11 | import android.widget.LinearLayout; 12 | import android.widget.TextView; 13 | 14 | import com.jimmysun.guide.GuideManager; 15 | 16 | /** 17 | * @author SunQiang 18 | * @since 2018/3/13 19 | */ 20 | 21 | public class MyAdapter extends RecyclerView.Adapter { 22 | private Context mContext; 23 | 24 | public MyAdapter(Context context) { 25 | mContext = context; 26 | } 27 | 28 | @Override 29 | public MyViewHolder onCreateViewHolder(ViewGroup parent, int viewType) { 30 | return new MyViewHolder(LayoutInflater.from(mContext).inflate(R.layout.recycler_item, 31 | parent, false)); 32 | } 33 | 34 | @Override 35 | public void onBindViewHolder(final MyViewHolder holder, int position) { 36 | holder.mTextView.setText("位置：" + position); 37 | if (position == 5) { 38 | holder.mLayout.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver 39 | .OnGlobalLayoutListener() { 40 | @Override 41 | public void onGlobalLayout() { 42 | holder.mLayout.getViewTreeObserver().removeOnGlobalLayoutListener(this); 43 | showGuide(holder); 44 | } 45 | }); 46 | } 47 | holder.mButton.setOnClickListener(new View.OnClickListener() { 48 | @Override 49 | public void onClick(View v) { 50 | showGuide(holder); 51 | } 52 | }); 53 | } 54 | 55 | @Override 56 | public int getItemCount() { 57 | return 20; 58 | } 59 | 60 | private void showGuide(MyViewHolder holder) { 61 | GuideManager guideManager = new GuideManager(mContext).highlightViewInRect(holder.mLayout); 62 | TextView textView = new TextView(mContext); 63 | textView.setText("↓这是高亮区域"); 64 | textView.setTextColor(Color.WHITE); 65 | guideManager.addViewRelativeTo(textView, holder.mLayout, GuideManager.ABOVE, 66 | Utils.dip2px(mContext, 3), Utils.dip2px(mContext, 5)); 67 | guideManager.show(); 68 | } 69 | 70 | class MyViewHolder extends RecyclerView.ViewHolder { 71 | TextView mTextView; 72 | Button mButton; 73 | LinearLayout mLayout; 74 | 75 | MyViewHolder(View itemView) { 76 | super(itemView); 77 | mTextView = itemView.findViewById(R.id.text_view); 78 | mButton = itemView.findViewById(R.id.button); 79 | mLayout = itemView.findViewById(R.id.layout_item); 80 | } 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/MyFragment.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | 4 | import android.graphics.Color; 5 | import android.os.Bundle; 6 | import android.support.annotation.NonNull; 7 | import android.support.annotation.Nullable; 8 | import android.support.v4.app.Fragment; 9 | import android.view.LayoutInflater; 10 | import android.view.View; 11 | import android.view.ViewGroup; 12 | import android.view.ViewTreeObserver; 13 | import android.widget.TextView; 14 | 15 | import com.jimmysun.guide.GuideManager; 16 | 17 | /** 18 | * A simple {@link Fragment} subclass. 19 | */ 20 | public class MyFragment extends Fragment { 21 | private TextView mFragmentTextView; 22 | 23 | public MyFragment() { 24 | // Required empty public constructor 25 | } 26 | 27 | 28 | @Override 29 | public View onCreateView(@NonNull LayoutInflater inflater, ViewGroup container, 30 | Bundle savedInstanceState) { 31 | View view = inflater.inflate(R.layout.fragment_my, container, false); 32 | mFragmentTextView = view.findViewById(R.id.tv_fragment); 33 | return view; 34 | } 35 | 36 | @Override 37 | public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) { 38 | super.onViewCreated(view, savedInstanceState); 39 | mFragmentTextView.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver 40 | .OnGlobalLayoutListener() { 41 | @Override 42 | public void onGlobalLayout() { 43 | mFragmentTextView.getViewTreeObserver().removeOnGlobalLayoutListener(this); 44 | GuideManager guideManager = 45 | new GuideManager(getContext()).setAlpha(0.5f).highlightViewInRect(mFragmentTextView); 46 | TextView textView = new TextView(getContext()); 47 | textView.setText("文案内容文案内容文案内容文案内容文案内容文案内容"); 48 | textView.setTextColor(Color.WHITE); 49 | textView.setWidth(Utils.dip2px(getContext(), 200)); 50 | guideManager.addViewRelativeTo(textView, mFragmentTextView, GuideManager.BELOW, 0 51 | , Utils.dip2px(getContext(), 5)).show(); 52 | } 53 | }); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/MyFragmentActivity.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | import android.os.Bundle; 4 | import android.support.v7.app.AppCompatActivity; 5 | 6 | public class MyFragmentActivity extends AppCompatActivity { 7 | 8 | @Override 9 | protected void onCreate(Bundle savedInstanceState) { 10 | super.onCreate(savedInstanceState); 11 | setContentView(R.layout.activity_my_fragment); 12 | getSupportFragmentManager().beginTransaction().add(R.id.frame_layout, new MyFragment()).commit(); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/RecyclerActivity.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | import android.os.Bundle; 4 | import android.support.v7.app.AppCompatActivity; 5 | import android.support.v7.widget.LinearLayoutManager; 6 | import android.support.v7.widget.RecyclerView; 7 | 8 | public class RecyclerActivity extends AppCompatActivity { 9 | 10 | @Override 11 | protected void onCreate(Bundle savedInstanceState) { 12 | super.onCreate(savedInstanceState); 13 | setContentView(R.layout.activity_recycler); 14 | RecyclerView recyclerView = findViewById(R.id.recycler_view); 15 | recyclerView.setLayoutManager(new LinearLayoutManager(this, LinearLayoutManager.VERTICAL, 16 | false)); 17 | recyclerView.setAdapter(new MyAdapter(this)); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /app/src/main/java/com/jimmysun/guidedemo/Utils.java: -------------------------------------------------------------------------------- 1 | package com.jimmysun.guidedemo; 2 | 3 | import android.content.Context; 4 | 5 | /** 6 | * 工具类 7 | * 8 | * @author SunQiang 9 | * @since 2019/1/22 10 | */ 11 | public class Utils { 12 | /** 13 | * 根据手机的分辨率从 dp 的单位 转成为 px(像素) 14 | * 15 | * @param context context 16 | * @param dipValue dip或dp大小 17 | * @return 像素值 18 | */ 19 | public static int dip2px(Context context, float dipValue) { 20 | try { 21 | return (int) (dipValue * context.getResources().getDisplayMetrics().density + 0.5f); 22 | } catch (Exception e) { 23 | e.printStackTrace(); 24 | } 25 | return 0; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /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-xxhdpi/right_arrow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimmysuncpt/AndroidGuide/51d3f830e7e8439e2d556612c9f0b402db12e5b3/app/src/main/res/drawable-xxhdpi/right_arrow.png -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 11 | 16 | 21 | 26 | 31 | 36 | 41 | 46 | 51 | 56 | 61 | 66 | 71 | 76 | 81 | 86 | 91 | 96 | 101 | 106 | 111 | 116 | 121 | 126 | 131 | 136 | 141 | 146 | 151 | 156 | 161 | 166 | 171 | 172 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/solid_white_bg.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 9 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 15 | 16 |