Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
.google
Application
gradle/wrapper
screenshots
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Android ClippingBasic Sample

A basic app showing how to clip on a View using ViewOutlineProvider interface, by which a View builds its outline, used for shadowing and clipping.

Introduction

The ViewOutlineProvider interface offers you a method to populate the outline of a View. You need to implement a getOutline(android.view.View, android.graphics.Outline) method to clip a View in a specific shape.

This example clips the outline of a View as a rounded rectangle by defining a class that implements ViewOutlineProvider by following code:

private class ClipOutlineProvider extends ViewOutlineProvider {
    @Override
    public void getOutline(View view, Outline outline) {
        final int margin = Math.min(view.getWidth(), view.getHeight()) / 10;
        outline.setRoundRect(margin, margin, view.getWidth() - margin,
                view.getHeight() - margin, margin / 2);
    }
}

To clip a View by the defined outline, setting a OutlineProvider to a View to be clipped is needed like following:

final View clippedView = view.findViewById(R.id.frame);
clippedView.setOutlineProvider(mOutlineProvider);

You can toggle if the View is clipped by calling setClipToOutline(boolean) like following code:

clippedView.setClipToOutline(true); // Setting false disable clipping

Pre-requisites

  • Android SDK 28
  • Android Build Tools v28.0.3
  • Android Support Repository

Screenshots

Screenshot Screenshot

Getting Started

This sample uses the Gradle build system. To build this project, use the "gradlew build" command or use "Import Project" in Android Studio.

Support

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

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.

You can’t perform that action at this time.