Restore saveLayer APIs back into the public API.
The saveLayer APIs are restored from @removed but will treat input
as ALL_SAVE_FLAGS and generate exceptions on newer API levels.
We internally used these calls in one situation that now use a
different @hide API to support the previous behavior until we
refactor that code.
Partial revert of "Remove deprecated android.graphics.Canvas APIs"
This reverts commit 7b837616ae88cbdaf12600cee23b5188e5531937.
Bug: 77276963
Bug: 73777445
Test: CtsGraphicsTestCases
Change-Id: I7acd4ffd5ac41a58d2be8b48cf50119c2b896708
diff --git a/api/current.txt b/api/current.txt
index 0fcf929..a332398 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -13344,9 +13344,13 @@
method public void rotate(float);
method public final void rotate(float, float, float);
method public int save();
+ method public deprecated int saveLayer(android.graphics.RectF, android.graphics.Paint, int);
method public int saveLayer(android.graphics.RectF, android.graphics.Paint);
+ method public deprecated int saveLayer(float, float, float, float, android.graphics.Paint, int);
method public int saveLayer(float, float, float, float, android.graphics.Paint);
+ method public deprecated int saveLayerAlpha(android.graphics.RectF, int, int);
method public int saveLayerAlpha(android.graphics.RectF, int);
+ method public deprecated int saveLayerAlpha(float, float, float, float, int, int);
method public int saveLayerAlpha(float, float, float, float, int);
method public void scale(float, float);
method public final void scale(float, float, float, float);
@@ -13356,6 +13360,7 @@
method public void setMatrix(android.graphics.Matrix);
method public void skew(float, float);
method public void translate(float, float);
+ field public static final int ALL_SAVE_FLAG = 31; // 0x1f
}
public static final class Canvas.EdgeType extends java.lang.Enum {
diff --git a/api/removed.txt b/api/removed.txt
index 2d76c5a..af2b25e 100644
--- a/api/removed.txt
+++ b/api/removed.txt
@@ -169,11 +169,6 @@
method public deprecated boolean clipRegion(android.graphics.Region, android.graphics.Region.Op);
method public deprecated boolean clipRegion(android.graphics.Region);
method public deprecated int save(int);
- method public deprecated int saveLayer(android.graphics.RectF, android.graphics.Paint, int);
- method public deprecated int saveLayer(float, float, float, float, android.graphics.Paint, int);
- method public deprecated int saveLayerAlpha(android.graphics.RectF, int, int);
- method public deprecated int saveLayerAlpha(float, float, float, float, int, int);
- field public static final int ALL_SAVE_FLAG = 31; // 0x1f
field public static final deprecated int CLIP_SAVE_FLAG = 2; // 0x2
field public static final deprecated int CLIP_TO_LAYER_SAVE_FLAG = 16; // 0x10
field public static final deprecated int FULL_COLOR_LAYER_SAVE_FLAG = 8; // 0x8
diff --git a/config/hiddenapi-light-greylist.txt b/config/hiddenapi-light-greylist.txt
index 015c4b6..90308d7 100644
--- a/config/hiddenapi-light-greylist.txt
+++ b/config/hiddenapi-light-greylist.txt
@@ -690,10 +690,6 @@
Landroid/graphics/Canvas;-><init>(J)V
Landroid/graphics/Canvas;->release()V
Landroid/graphics/Canvas;->save(I)I
-Landroid/graphics/Canvas;->saveLayerAlpha(FFFFII)I
-Landroid/graphics/Canvas;->saveLayerAlpha(Landroid/graphics/RectF;II)I
-Landroid/graphics/Canvas;->saveLayer(FFFFLandroid/graphics/Paint;I)I
-Landroid/graphics/Canvas;->saveLayer(Landroid/graphics/RectF;Landroid/graphics/Paint;I)I
Landroid/graphics/ColorMatrixColorFilter;->setColorMatrix(Landroid/graphics/ColorMatrix;)V
Landroid/graphics/drawable/AnimatedImageDrawable;->onAnimationEnd()V
Landroid/graphics/drawable/AnimatedStateListDrawable$AnimatedStateListState;->mStateIds:Landroid/util/SparseIntArray;
diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java
index f6c669b..bf754d0 100644
--- a/core/java/android/view/View.java
+++ b/core/java/android/view/View.java
@@ -20223,22 +20223,20 @@
int solidColor = getSolidColor();
if (solidColor == 0) {
- final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
-
if (drawTop) {
- canvas.saveLayer(left, top, right, top + length, null, flags);
+ canvas.saveUnclippedLayer(left, top, right, top + length);
}
if (drawBottom) {
- canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
+ canvas.saveUnclippedLayer(left, bottom - length, right, bottom);
}
if (drawLeft) {
- canvas.saveLayer(left, top, left + length, bottom, null, flags);
+ canvas.saveUnclippedLayer(left, top, left + length, bottom);
}
if (drawRight) {
- canvas.saveLayer(right - length, top, right, bottom, null, flags);
+ canvas.saveUnclippedLayer(right - length, top, right, bottom);
}
} else {
scrollabilityCache.setFadeColor(solidColor);
diff --git a/graphics/java/android/graphics/Canvas.java b/graphics/java/android/graphics/Canvas.java
index 7080657..3cc92bc 100644
--- a/graphics/java/android/graphics/Canvas.java
+++ b/graphics/java/android/graphics/Canvas.java
@@ -367,12 +367,19 @@
* call to <code>saveLayer()</code> and <code>saveLayerAlpha()</code>
* variants.
*
- * @removed There are no visible methods remaining that use this flag
* <p class="note"><strong>Note:</strong> all methods that accept this flag
* have flagless versions that are equivalent to passing this flag.
*/
public static final int ALL_SAVE_FLAG = 0x1F;
+ private static void checkValidSaveFlags(int saveFlags) {
+ if (sCompatiblityVersion >= Build.VERSION_CODES.P
+ && saveFlags != ALL_SAVE_FLAG) {
+ throw new IllegalArgumentException(
+ "Invalid Layer Save Flag - only ALL_SAVE_FLAGS is allowed");
+ }
+ }
+
/**
* Saves the current matrix and clip onto a private stack.
* <p>
@@ -414,10 +421,8 @@
* redirects drawing to an offscreen bitmap.
* <p class="note"><strong>Note:</strong> this method is very expensive,
* incurring more than double rendering cost for contained content. Avoid
- * using this method, especially if the bounds provided are large, or if
- * the {@link #CLIP_TO_LAYER_SAVE_FLAG} is omitted from the
- * {@code saveFlags} parameter. It is recommended to use a
- * {@link android.view.View#LAYER_TYPE_HARDWARE hardware layer} on a View
+ * using this method, especially if the bounds provided are large. It is
+ * recommended to use a {@link android.view.View#LAYER_TYPE_HARDWARE hardware layer} on a View
* to apply an xfermode, color filter, or alpha, as it will perform much
* better than this method.
* <p>
@@ -431,7 +436,9 @@
* {@link Paint#getColorFilter() ColorFilter} are applied when the
* offscreen bitmap is drawn back when restore() is called.
*
- * @removed
+ * As of API Level API level {@value Build.VERSION_CODES#P} the only valid
+ * {@code saveFlags} is {@link #ALL_SAVE_FLAG}. All other flags are ignored.
+ *
* @deprecated Use {@link #saveLayer(RectF, Paint)} instead.
* @param bounds May be null. The maximum size the offscreen bitmap
* needs to be (in local coordinates)
@@ -445,7 +452,9 @@
if (bounds == null) {
bounds = new RectF(getClipBounds());
}
- return saveLayer(bounds.left, bounds.top, bounds.right, bounds.bottom, paint, saveFlags);
+ checkValidSaveFlags(saveFlags);
+ return saveLayer(bounds.left, bounds.top, bounds.right, bounds.bottom, paint,
+ ALL_SAVE_FLAG);
}
/**
@@ -479,17 +488,26 @@
}
/**
+ * @hide
+ */
+ public int saveUnclippedLayer(int left, int top, int right, int bottom) {
+ return nSaveLayer(mNativeCanvasWrapper, left, top, right, bottom, 0, 0);
+ }
+
+ /**
* Helper version of saveLayer() that takes 4 values rather than a RectF.
*
- * @removed
+ * As of API Level API level {@value Build.VERSION_CODES#P} the only valid
+ * {@code saveFlags} is {@link #ALL_SAVE_FLAG}. All other flags are ignored.
+ *
* @deprecated Use {@link #saveLayer(float, float, float, float, Paint)} instead.
*/
- @Deprecated
public int saveLayer(float left, float top, float right, float bottom, @Nullable Paint paint,
@Saveflags int saveFlags) {
+ checkValidSaveFlags(saveFlags);
return nSaveLayer(mNativeCanvasWrapper, left, top, right, bottom,
paint != null ? paint.getNativeInstance() : 0,
- saveFlags);
+ ALL_SAVE_FLAG);
}
/**
@@ -505,10 +523,8 @@
* redirects drawing to an offscreen bitmap.
* <p class="note"><strong>Note:</strong> this method is very expensive,
* incurring more than double rendering cost for contained content. Avoid
- * using this method, especially if the bounds provided are large, or if
- * the {@link #CLIP_TO_LAYER_SAVE_FLAG} is omitted from the
- * {@code saveFlags} parameter. It is recommended to use a
- * {@link android.view.View#LAYER_TYPE_HARDWARE hardware layer} on a View
+ * using this method, especially if the bounds provided are large. It is
+ * recommended to use a {@link android.view.View#LAYER_TYPE_HARDWARE hardware layer} on a View
* to apply an xfermode, color filter, or alpha, as it will perform much
* better than this method.
* <p>
@@ -520,7 +536,9 @@
* The {@code alpha} parameter is applied when the offscreen bitmap is
* drawn back when restore() is called.
*
- * @removed
+ * As of API Level API level {@value Build.VERSION_CODES#P} the only valid
+ * {@code saveFlags} is {@link #ALL_SAVE_FLAG}. All other flags are ignored.
+ *
* @deprecated Use {@link #saveLayerAlpha(RectF, int)} instead.
* @param bounds The maximum size the offscreen bitmap needs to be
* (in local coordinates)
@@ -534,7 +552,9 @@
if (bounds == null) {
bounds = new RectF(getClipBounds());
}
- return saveLayerAlpha(bounds.left, bounds.top, bounds.right, bounds.bottom, alpha, saveFlags);
+ checkValidSaveFlags(saveFlags);
+ return saveLayerAlpha(bounds.left, bounds.top, bounds.right, bounds.bottom, alpha,
+ ALL_SAVE_FLAG);
}
/**
@@ -553,15 +573,17 @@
/**
* Helper for saveLayerAlpha() that takes 4 values instead of a RectF.
*
- * @removed
+ * As of API Level API level {@value Build.VERSION_CODES#P} the only valid
+ * {@code saveFlags} is {@link #ALL_SAVE_FLAG}. All other flags are ignored.
+ *
* @deprecated Use {@link #saveLayerAlpha(float, float, float, float, int)} instead.
*/
- @Deprecated
public int saveLayerAlpha(float left, float top, float right, float bottom, int alpha,
@Saveflags int saveFlags) {
+ checkValidSaveFlags(saveFlags);
alpha = Math.min(255, Math.max(0, alpha));
return nSaveLayerAlpha(mNativeCanvasWrapper, left, top, right, bottom,
- alpha, saveFlags);
+ alpha, ALL_SAVE_FLAG);
}
/**