1*d353a188SXin Li 2*d353a188SXin LiAndroid ClippingBasic Sample 3*d353a188SXin Li=================================== 4*d353a188SXin Li 5*d353a188SXin LiA basic app showing how to clip on a View using [ViewOutlineProvider][1] interface, 6*d353a188SXin Liby which a View builds its outline, used for shadowing and clipping. 7*d353a188SXin Li 8*d353a188SXin LiIntroduction 9*d353a188SXin Li------------ 10*d353a188SXin Li 11*d353a188SXin LiThe [ViewOutlineProvider][1] interface offers you a method to populate the outline of a View. 12*d353a188SXin LiYou need to implement a getOutline(android.view.View, android.graphics.Outline) 13*d353a188SXin Limethod to clip a View in a specific shape. 14*d353a188SXin Li 15*d353a188SXin LiThis example clips the outline of a View as a rounded rectangle by defining a class that 16*d353a188SXin Li implements ViewOutlineProvider by following code: 17*d353a188SXin Li 18*d353a188SXin Li```java 19*d353a188SXin Liprivate class ClipOutlineProvider extends ViewOutlineProvider { 20*d353a188SXin Li @Override 21*d353a188SXin Li public void getOutline(View view, Outline outline) { 22*d353a188SXin Li final int margin = Math.min(view.getWidth(), view.getHeight()) / 10; 23*d353a188SXin Li outline.setRoundRect(margin, margin, view.getWidth() - margin, 24*d353a188SXin Li view.getHeight() - margin, margin / 2); 25*d353a188SXin Li } 26*d353a188SXin Li} 27*d353a188SXin Li``` 28*d353a188SXin Li 29*d353a188SXin LiTo clip a View by the defined outline, setting a OutlineProvider to a View 30*d353a188SXin Lito be clipped is needed like following: 31*d353a188SXin Li 32*d353a188SXin Li```java 33*d353a188SXin Lifinal View clippedView = view.findViewById(R.id.frame); 34*d353a188SXin LiclippedView.setOutlineProvider(mOutlineProvider); 35*d353a188SXin Li``` 36*d353a188SXin Li 37*d353a188SXin LiYou can toggle if the View is clipped by calling [setClipToOutline(boolean)][2] 38*d353a188SXin Lilike following code: 39*d353a188SXin Li 40*d353a188SXin Li```java 41*d353a188SXin LiclippedView.setClipToOutline(true); // Setting false disable clipping 42*d353a188SXin Li``` 43*d353a188SXin Li 44*d353a188SXin Li[1]: https://developer.android.com/reference/android/view/ViewOutlineProvider.html 45*d353a188SXin Li[2]: https://developer.android.com/reference/android/view/View.html#setClipToOutline(boolean) 46*d353a188SXin Li 47*d353a188SXin LiPre-requisites 48*d353a188SXin Li-------------- 49*d353a188SXin Li 50*d353a188SXin Li- Android SDK 27 51*d353a188SXin Li- Android Build Tools v27.0.2 52*d353a188SXin Li- Android Support Repository 53*d353a188SXin Li 54*d353a188SXin LiScreenshots 55*d353a188SXin Li------------- 56*d353a188SXin Li 57*d353a188SXin Li<img src="screenshots/screenshot-1.png" height="400" alt="Screenshot"/> <img src="screenshots/screenshot-2.png" height="400" alt="Screenshot"/> 58*d353a188SXin Li 59*d353a188SXin LiGetting Started 60*d353a188SXin Li--------------- 61*d353a188SXin Li 62*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the 63*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio. 64*d353a188SXin Li 65*d353a188SXin LiSupport 66*d353a188SXin Li------- 67*d353a188SXin Li 68*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968 69*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android 70*d353a188SXin Li 71*d353a188SXin LiIf you've found an error in this sample, please file an issue: 72*d353a188SXin Lihttps://github.com/googlesamples/android-ClippingBasic 73*d353a188SXin Li 74*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and 75*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. 76*d353a188SXin Li 77*d353a188SXin LiLicense 78*d353a188SXin Li------- 79*d353a188SXin Li 80*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc. 81*d353a188SXin Li 82*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor 83*d353a188SXin Lilicense agreements. See the NOTICE file distributed with this work for 84*d353a188SXin Liadditional information regarding copyright ownership. The ASF licenses this 85*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not 86*d353a188SXin Liuse this file except in compliance with the License. You may obtain a copy of 87*d353a188SXin Lithe License at 88*d353a188SXin Li 89*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0 90*d353a188SXin Li 91*d353a188SXin LiUnless required by applicable law or agreed to in writing, software 92*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT 93*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 94*d353a188SXin LiLicense for the specific language governing permissions and limitations under 95*d353a188SXin Lithe License. 96
