Deprecate fillColor and add some Javadoc explaining the current behav…

…iour
hdodenhof · May 16, 2016 · 3e60732 · 3e60732
1 parent 661381f
commit 3e60732
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/circleimageview/src/main/java/de/hdodenhof/circleimageview/CircleImageView.java b/circleimageview/src/main/java/de/hdodenhof/circleimageview/CircleImageView.java
@@ -173,10 +173,27 @@ public void setBorderColorResource(@ColorRes int borderColorRes) {
         setBorderColor(getContext().getResources().getColor(borderColorRes));
     }
 
+    /**
+     * Return the color drawn behind the circle-shaped drawable.
+     *
+     * @return The color drawn behind the drawable
+     *
+     * @deprecated Fill color support is going to be removed in the future
+     */
+    @Deprecated
     public int getFillColor() {
         return mFillColor;
     }
 
+    /**
+     * Set a color to be drawn behind the circle-shaped drawable. Note that
+     * this has no effect if the drawable is opaque or no drawable is set.
+     *
+     * @param fillColor The color to be drawn behind the drawable
+     *
+     * @deprecated Fill color support is going to be removed in the future
+     */
+    @Deprecated
     public void setFillColor(@ColorInt int fillColor) {
         if (fillColor == mFillColor) {
             return;
@@ -187,6 +204,16 @@ public void setFillColor(@ColorInt int fillColor) {
         invalidate();
     }
 
+    /**
+     * Set a color to be drawn behind the circle-shaped drawable. Note that
+     * this has no effect if the drawable is opaque or no drawable is set.
+     *
+     * @param fillColorRes The color resource to be resolved to a color and
+     *                     drawn behind the drawable
+     *
+     * @deprecated Fill color support is going to be removed in the future
+     */
+    @Deprecated
     public void setFillColorResource(@ColorRes int fillColorRes) {
         setFillColor(getContext().getResources().getColor(fillColorRes));
     }