Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs for drawable tint and color filters

Browse Source 
bug:19564477
Change-Id: I7e11baae2d4dd245965904c85b8855de71f6b6ac
This commit is contained in:
Chris Craik
2015-03-02 10:43:29 -08:00
parent 3062e57072
commit bd3bfc5285
20 changed files with 111 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/java/android/app/WallpaperManager.java
View File

@@ -188,7 +188,7 @@ public class WallpaperManager {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
throw new UnsupportedOperationException("Not supported with this drawable");
}

12
core/java/android/widget/ScrollBarDrawable.java
View File

@@ -339,21 +339,21 @@ public class ScrollBarDrawable extends Drawable implements Drawable.Callback {
}
@Override
public void setColorFilter(ColorFilter cf) {
mColorFilter = cf;
public void setColorFilter(ColorFilter colorFilter) {
mColorFilter = colorFilter;
mHasSetColorFilter = true;
if (mVerticalTrack != null) {
mVerticalTrack.setColorFilter(cf);
mVerticalTrack.setColorFilter(colorFilter);
}
if (mVerticalThumb != null) {
mVerticalThumb.setColorFilter(cf);
mVerticalThumb.setColorFilter(colorFilter);
}
if (mHorizontalTrack != null) {
mHorizontalTrack.setColorFilter(cf);
mHorizontalTrack.setColorFilter(colorFilter);
}
if (mHorizontalThumb != null) {
mHorizontalThumb.setColorFilter(cf);
mHorizontalThumb.setColorFilter(colorFilter);
}
}

2
core/java/com/android/internal/widget/ActionBarContainer.java
View File

@@ -387,7 +387,7 @@ public class ActionBarContainer extends FrameLayout {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
}
@Override

6
graphics/java/android/graphics/PorterDuffColorFilter.java
View File

@@ -16,6 +16,8 @@
package android.graphics;
import android.annotation.NonNull;
/**
* A color filter that can be used to tint the source pixels using a single
* color and a specific {@link PorterDuff Porter-Duff composite mode}.
@@ -34,7 +36,7 @@ public class PorterDuffColorFilter extends ColorFilter {
* @see #setColor(int)
* @see #setMode(android.graphics.PorterDuff.Mode)
*/
public PorterDuffColorFilter(int color, PorterDuff.Mode mode) {
public PorterDuffColorFilter(int color, @NonNull PorterDuff.Mode mode) {
mColor = color;
mMode = mode;
update();
@@ -93,7 +95,7 @@ public class PorterDuffColorFilter extends ColorFilter {
*
* @hide
*/
public void setMode(PorterDuff.Mode mode) {
public void setMode(@NonNull PorterDuff.Mode mode) {
mMode = mode;
update();
}

4
graphics/java/android/graphics/drawable/BitmapDrawable.java
View File

@@ -628,8 +628,8 @@ public class BitmapDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
mBitmapState.mPaint.setColorFilter(cf);
public void setColorFilter(ColorFilter colorFilter) {
mBitmapState.mPaint.setColorFilter(colorFilter);
invalidateSelf();
}

95
graphics/java/android/graphics/drawable/Drawable.java
View File

@@ -17,6 +17,7 @@
package android.graphics.drawable;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.content.res.ColorStateList;
import android.content.res.Resources;
import android.content.res.Resources.Theme;
@@ -477,67 +478,111 @@ public abstract class Drawable {
}
/**
* @hide Consider for future API inclusion
* @hide
*
* Internal-only method for setting xfermode on certain supported drawables.
*
* Should not be made public since the layers and drawing area with which
* Drawables draw is private implementation detail, and not something apps
* should rely upon.
*/
public void setXfermode(Xfermode mode) {
// Base implementation drops it on the floor for compatibility. Whee!
// TODO: For this to be included in the API proper, all framework drawables need impls.
// For right now only BitmapDrawable has it.
}
/**
* Specify an optional color filter for the drawable. Pass {@code null} to
* remove any existing color filter.
* Specify an optional color filter for the drawable.
* <p>
* If a Drawable has a ColorFilter, each output pixel of the Drawable's
* drawing contents will be modified by the color filter before it is
* blended onto the render target of a Canvas.
* </p>
* <p>
* Pass {@code null} to remove any existing color filter.
* </p>
* <p class="note"><strong>Note:</strong> Setting a non-{@code null} color
* filter disables {@link #setTintList(ColorStateList) tint}.
* </p>
*
* @param cf the color filter to apply, or {@code null} to remove the
* @param colorFilter The color filter to apply, or {@code null} to remove the
* existing color filter
*/
public abstract void setColorFilter(ColorFilter cf);
public abstract void setColorFilter(@Nullable ColorFilter colorFilter);
/**
* Specify a color and Porter-Duff mode to be the color filter for this
* drawable.
* <p>
* Convenience for {@link #setColorFilter(ColorFilter)} which constructs a
* {@link PorterDuffColorFilter}.
* </p>
* <p class="note"><strong>Note:</strong> Setting a color filter disables
* {@link #setTintList(ColorStateList) tint}.
* </p>
*/
public void setColorFilter(int color, PorterDuff.Mode mode) {
public void setColorFilter(int color, @NonNull PorterDuff.Mode mode) {
setColorFilter(new PorterDuffColorFilter(color, mode));
}
/**
* Specifies a tint for this drawable.
* Specifies tint color for this drawable.
* <p>
* Setting a color filter via {@link #setColorFilter(ColorFilter)} overrides
* tint.
* A Drawable's drawing content will be blended together with its tint
* before it is drawn to the screen. This functions similarly to
* {@link #setColorFilter(int, PorterDuff.Mode)}.
* </p>
* <p>
* To clear the tint, pass {@code null} to
* {@link #setTintList(ColorStateList)}.
* </p>
* <p class="note"><strong>Note:</strong> Setting a color filter via
* {@link #setColorFilter(ColorFilter)} or
* {@link #setColorFilter(int, PorterDuff.Mode)} overrides tint.
* </p>
*
* @param tint Color to use for tinting this drawable
* @param tintColor Color to use for tinting this drawable
* @see #setTintList(ColorStateList)
* @see #setTintMode(PorterDuff.Mode)
*/
public void setTint(int tint) {
setTintList(ColorStateList.valueOf(tint));
public void setTint(int tintColor) {
setTintList(ColorStateList.valueOf(tintColor));
}
/**
* Specifies a tint for this drawable as a color state list.
* Specifies tint color for this drawable as a color state list.
* <p>
* Setting a color filter via {@link #setColorFilter(ColorFilter)} overrides
* tint.
* A Drawable's drawing content will be blended together with its tint
* before it is drawn to the screen. This functions similarly to
* {@link #setColorFilter(int, PorterDuff.Mode)}.
* </p>
* <p class="note"><strong>Note:</strong> Setting a color filter via
* {@link #setColorFilter(ColorFilter)} or
* {@link #setColorFilter(int, PorterDuff.Mode)} overrides tint.
* </p>
*
* @param tint Color state list to use for tinting this drawable, or null to
* clear the tint
* @param tint Color state list to use for tinting this drawable, or
* {@code null} to clear the tint
* @see #setTint(int)
* @see #setTintMode(PorterDuff.Mode)
*/
public void setTintList(ColorStateList tint) {}
public void setTintList(@Nullable ColorStateList tint) {}
/**
* Specifies a tint blending mode for this drawable.
* <p>
* Setting a color filter via {@link #setColorFilter(ColorFilter)} overrides
* tint.
* Defines how this drawable's tint color should be blended into the drawable
* before it is drawn to screen. Default tint mode is {@link PorterDuff.Mode#MULTIPLY}.
* </p>
* <p class="note"><strong>Note:</strong> Setting a color filter via
* {@link #setColorFilter(ColorFilter)} or
* {@link #setColorFilter(int, PorterDuff.Mode)} overrides tint.
* </p>
*
* @param tintMode Color state list to use for tinting this drawable, or null to
* clear the tint
* @param tintMode A Porter-Duff blending mode
* @see #setTint(int)
* @see #setTintList(ColorStateList)
*/
public void setTintMode(PorterDuff.Mode tintMode) {}
public void setTintMode(@NonNull PorterDuff.Mode tintMode) {}
/**
* Returns the current color filter, or {@code null} if none set.

8
graphics/java/android/graphics/drawable/DrawableContainer.java
View File

@@ -172,14 +172,14 @@ public class DrawableContainer extends Drawable implements Drawable.Callback {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
mDrawableContainerState.mHasColorFilter = true;
if (mDrawableContainerState.mColorFilter != cf) {
mDrawableContainerState.mColorFilter = cf;
if (mDrawableContainerState.mColorFilter != colorFilter) {
mDrawableContainerState.mColorFilter = colorFilter;
if (mCurrDrawable != null) {
mCurrDrawable.mutate().setColorFilter(cf);
mCurrDrawable.mutate().setColorFilter(colorFilter);
}
}
}

4
graphics/java/android/graphics/drawable/DrawableWrapper.java
View File

@@ -238,9 +238,9 @@ public abstract class DrawableWrapper extends Drawable implements Drawable.Callb
}
@Override
public void setColorFilter(@Nullable ColorFilter cf) {
public void setColorFilter(@Nullable ColorFilter colorFilter) {
if (mDrawable != null) {
mDrawable.setColorFilter(cf);
mDrawable.setColorFilter(colorFilter);
}
}

6
graphics/java/android/graphics/drawable/GradientDrawable.java
View File

@@ -832,9 +832,9 @@ public class GradientDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
if (cf != mColorFilter) {
mColorFilter = cf;
public void setColorFilter(ColorFilter colorFilter) {
if (colorFilter != mColorFilter) {
mColorFilter = colorFilter;
invalidateSelf();
}
}

4
graphics/java/android/graphics/drawable/LayerDrawable.java
View File

@@ -1035,11 +1035,11 @@ public class LayerDrawable extends Drawable implements Drawable.Callback {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
final ChildDrawable[] array = mLayerState.mChildren;
final int N = mLayerState.mNum;
for (int i = 0; i < N; i++) {
array[i].mDrawable.setColorFilter(cf);
array[i].mDrawable.setColorFilter(colorFilter);
}
}

6
graphics/java/android/graphics/drawable/NinePatchDrawable.java
View File

@@ -338,12 +338,12 @@ public class NinePatchDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
if (mPaint == null && cf == null) {
public void setColorFilter(ColorFilter colorFilter) {
if (mPaint == null && colorFilter == null) {
// Fast common case -- leave at no color filter.
return;
}
getPaint().setColorFilter(cf);
getPaint().setColorFilter(colorFilter);
invalidateSelf();
}

4
graphics/java/android/graphics/drawable/RippleDrawable.java
View File

@@ -241,8 +241,8 @@ public class RippleDrawable extends LayerDrawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
super.setColorFilter(cf);
public void setColorFilter(ColorFilter colorFilter) {
super.setColorFilter(colorFilter);
// TODO: Should we support this?
}

4
graphics/java/android/graphics/drawable/ShapeDrawable.java
View File

@@ -299,8 +299,8 @@ public class ShapeDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
mShapeState.mPaint.setColorFilter(cf);
public void setColorFilter(ColorFilter colorFilter) {
mShapeState.mPaint.setColorFilter(colorFilter);
invalidateSelf();
}

6
packages/SystemUI/src/com/android/systemui/recents/views/FakeShadowDrawable.java
View File

@@ -159,9 +159,9 @@ class FakeShadowDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
mCornerShadowPaint.setColorFilter(cf);
mEdgeShadowPaint.setColorFilter(cf);
public void setColorFilter(ColorFilter colorFilter) {
mCornerShadowPaint.setColorFilter(colorFilter);
mEdgeShadowPaint.setColorFilter(colorFilter);
}
@Override

2
packages/SystemUI/src/com/android/systemui/statusbar/phone/BarTransitions.java
View File

@@ -160,7 +160,7 @@ public class BarTransitions {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
// noop
}

2
packages/SystemUI/src/com/android/systemui/statusbar/phone/KeyguardPreviewContainer.java
View File

@@ -47,7 +47,7 @@ public class KeyguardPreviewContainer extends FrameLayout {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
// noop
}

2
packages/SystemUI/src/com/android/systemui/statusbar/phone/PhoneStatusBar.java
View File

@@ -2929,7 +2929,7 @@ public class PhoneStatusBar extends BaseStatusBar implements DemoMode,
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
}
@Override

2
packages/SystemUI/src/com/android/systemui/statusbar/phone/TrustDrawable.java
View File

@@ -120,7 +120,7 @@ public class TrustDrawable extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
throw new UnsupportedOperationException("not implemented");
}

2
packages/SystemUI/src/com/android/systemui/statusbar/policy/KeyButtonRipple.java
View File

@@ -118,7 +118,7 @@ public class KeyButtonRipple extends Drawable {
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
// Not supported.
}

2
packages/SystemUI/src/com/android/systemui/statusbar/policy/KeyguardUserSwitcherScrim.java
View File

@@ -77,7 +77,7 @@ public class KeyguardUserSwitcherScrim extends Drawable
}
@Override
public void setColorFilter(ColorFilter cf) {
public void setColorFilter(ColorFilter colorFilter) {
}
@Override