More documentation for handling RippleDrawable mask at run time

The docs are now really explicit about the layer's ID and how to set
or update the mask layer from code.

Bug: 20493831
Change-Id: I801f10cd08fd1b4bb226c63a1bdf3271229928ea
This commit is contained in:
Alan Viverette
2015-05-04 12:51:54 -07:00
parent 5551aca2b8
commit d21be49975

View File

@@ -53,8 +53,11 @@ import java.util.Arrays;
* attribute identifier.
* <p>
* A touch feedback drawable may contain multiple child layers, including a
* special mask layer that is not drawn to the screen. A single layer may be set
* as the mask by specifying its android:id value as {@link android.R.id#mask}.
* special mask layer that is not drawn to the screen. A single layer may be
* set as the mask from XML by specifying its {@code android:id} value as
* {@link android.R.id#mask}. At run time, a single layer may be set as the
* mask using {@code setId(..., android.R.id.mask)} or an existing mask layer
* may be replaced using {@code setDrawableByLayerId(android.R.id.mask, ...)}.
* <pre>
* <code>&lt!-- A red ripple masked against an opaque rectangle. --/>
* &ltripple android:color="#ffff0000">