blob: 6dd25a2ffcf50f0ea260186fec054d09c7474aa1 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
Copyright 2013 The Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
Basic sample to demonstrate clipping on a View.
<template src="base"/>
<template src="FragmentView"/>
<common src="logger"/>
<common src="activities"/>
<categories>UI Views</categories>
A basic app showing how to clip on a View using [ViewOutlineProvider][1] interface,
by which a View builds its outline, used for shadowing and clipping.
The [ViewOutlineProvider][1] interface offers you a method to populate the outline of a View.
You need to implement a getOutline(android.view.View,
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 {
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(;
You can toggle if the View is clipped by calling [setClipToOutline(boolean)][2]
like following code:
clippedView.setClipToOutline(true); // Setting false disable clipping