From 96a443b58d9c9849c846750657f959e3743bc5ed Mon Sep 17 00:00:00 2001 From: Chet Haase Date: Fri, 12 Jun 2015 10:27:44 +0100 Subject: Clarify Drawable.getOpacity() docs Docs for translucent-vs-transparent-vs-opaque were confusing, especially since the definition for those constants in PixelFormat are not the same as how they're actually used in Drawable. This fix simply adds clarifying text to the method comment for getOpacity(). Issue #21158891 Better document Drawable#getOpacity Change-Id: I94725592f85e5d7874e3a3ac1c5bab969163fbf0 --- graphics/java/android/graphics/drawable/Drawable.java | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'graphics') diff --git a/graphics/java/android/graphics/drawable/Drawable.java b/graphics/java/android/graphics/drawable/Drawable.java index e8e4664..532c888 100644 --- a/graphics/java/android/graphics/drawable/Drawable.java +++ b/graphics/java/android/graphics/drawable/Drawable.java @@ -809,6 +809,14 @@ public abstract class Drawable { * {@link android.graphics.PixelFormat#TRANSPARENT}, or * {@link android.graphics.PixelFormat#OPAQUE}. * + *

An OPAQUE drawable is one that draws all all content within its bounds, completely + * covering anything behind the drawable. A TRANSPARENT drawable is one that draws nothing + * within its bounds, allowing everything behind it to show through. A TRANSLUCENT drawable + * is a drawable in any other state, where the drawable will draw some, but not all, + * of the content within its bounds and at least some content behind the drawable will + * be visible. If the visibility of the drawable's contents cannot be determined, the + * safest/best return value is TRANSLUCENT. + * *

Generally a Drawable should be as conservative as possible with the * value it returns. For example, if it contains multiple child drawables * and only shows one of them at a time, if only one of the children is -- cgit v1.1