Merge pull request #322 from amlcurran/doc-updates

Tidy up

Author: amlcurran

.travis.yml

@@ -0,0 +1,10 @@
+language: android
+android:
+  components:
+    - android-23
+    - build-tools-22.0.1
+    - extra-google-m2repository
+    - extra-android-support
+    - extra-android-m2repository
+
+script: ./gradlew assemble test check

library/build.gradle

@@ -32,6 +32,7 @@ dependencies {
         mavenCentral()
     }
     compile 'com.android.support:support-annotations:23.1.0'
+    compile 'com.android.support:support-v4:23.1.0'
 }
 
 android {

library/src/main/java/com/github/amlcurran/showcaseview/AnimationFactory.java

@@ -26,11 +26,11 @@ interface AnimationFactory {
 
     void animateTargetToPoint(ShowcaseView showcaseView, Point point);
 
-    public interface AnimationStartListener {
+    interface AnimationStartListener {
         void onAnimationStart();
     }
 
-    public interface AnimationEndListener {
+    interface AnimationEndListener {
         void onAnimationEnd();
     }
 }

library/src/main/java/com/github/amlcurran/showcaseview/AnimatorAnimationFactory.java

@@ -16,6 +16,7 @@
 
 package com.github.amlcurran.showcaseview;
 
+import android.animation.AnimatorListenerAdapter;
 import android.os.Build.VERSION_CODES;
 import android.animation.Animator;
 import android.animation.AnimatorSet;
@@ -41,47 +42,27 @@ public AnimatorAnimationFactory() {
     @Override
     public void fadeInView(View target, long duration, final AnimationStartListener listener) {
         ObjectAnimator oa = ObjectAnimator.ofFloat(target, ALPHA, INVISIBLE, VISIBLE);
-        oa.setDuration(duration).addListener(new Animator.AnimatorListener() {
+        oa.setDuration(duration).addListener(new AnimatorListenerAdapter() {
+
             @Override
             public void onAnimationStart(Animator animator) {
                 listener.onAnimationStart();
             }
 
-            @Override
-            public void onAnimationEnd(Animator animator) {
-            }
-
-            @Override
-            public void onAnimationCancel(Animator animator) {
-            }
-
-            @Override
-            public void onAnimationRepeat(Animator animator) {
-            }
         });
         oa.start();
     }
 
     @Override
     public void fadeOutView(View target, long duration, final AnimationEndListener listener) {
         ObjectAnimator oa = ObjectAnimator.ofFloat(target, ALPHA, INVISIBLE);
-        oa.setDuration(duration).addListener(new Animator.AnimatorListener() {
-            @Override
-            public void onAnimationStart(Animator animator) {
-            }
+        oa.setDuration(duration).addListener(new AnimatorListenerAdapter() {
 
             @Override
             public void onAnimationEnd(Animator animator) {
                 listener.onAnimationEnd();
             }
 
-            @Override
-            public void onAnimationCancel(Animator animator) {
-            }
-
-            @Override
-            public void onAnimationRepeat(Animator animator) {
-            }
         });
         oa.start();
     }

library/src/main/java/com/github/amlcurran/showcaseview/ApiUtils.java

@@ -18,7 +18,7 @@
 
 import android.os.Build;
 
-public class ApiUtils {
+class ApiUtils {
 
     public boolean isCompatWith(int versionCode) {
         return Build.VERSION.SDK_INT >= versionCode;

library/src/main/java/com/github/amlcurran/showcaseview/NewShowcaseDrawer.java

@@ -20,17 +20,14 @@
 import android.graphics.Bitmap;
 import android.graphics.Canvas;
 
-/**
- * Created by curraa01 on 13/10/2013.
- */
 class NewShowcaseDrawer extends StandardShowcaseDrawer {
 
     private static final int ALPHA_60_PERCENT = 153;
     private final float outerRadius;
     private final float innerRadius;
 
-    public NewShowcaseDrawer(Resources resources) {
-        super(resources);
+    public NewShowcaseDrawer(Resources resources, Resources.Theme theme) {
+        super(resources, theme);
         outerRadius = resources.getDimension(R.dimen.showcase_radius_outer);
         innerRadius = resources.getDimension(R.dimen.showcase_radius_inner);
     }
@@ -64,8 +61,4 @@ public float getBlockedRadius() {
         return innerRadius;
     }
 
-    @Override
-    public void setBackgroundColour(int backgroundColor) {
-        this.backgroundColour = backgroundColor;
-    }
 }

library/src/main/java/com/github/amlcurran/showcaseview/NoAnimationFactory.java

@@ -3,7 +3,7 @@
 import android.graphics.Point;
 import android.view.View;
 
-public class NoAnimationFactory implements AnimationFactory {
+class NoAnimationFactory implements AnimationFactory {
 
     @Override
     public void fadeInView(View target, long duration, AnimationStartListener listener) {

library/src/main/java/com/github/amlcurran/showcaseview/OnShowcaseEventListener.java

@@ -25,23 +25,23 @@ public interface OnShowcaseEventListener {
      * Called when the ShowcaseView has been told to hide. Use {@link #onShowcaseViewDidHide(ShowcaseView)}
      * if you want to know when the ShowcaseView has been fully hidden.
      */
-    public void onShowcaseViewHide(ShowcaseView showcaseView);
+    void onShowcaseViewHide(ShowcaseView showcaseView);
 
     /**
      * Called when the animation hiding the ShowcaseView has finished, and it is no longer visible on the screen.
      */
-    public void onShowcaseViewDidHide(ShowcaseView showcaseView);
+    void onShowcaseViewDidHide(ShowcaseView showcaseView);
 
     /**
      * Called when the ShowcaseView is shown.
      */
-    public void onShowcaseViewShow(ShowcaseView showcaseView);
+    void onShowcaseViewShow(ShowcaseView showcaseView);
 
     /**
      * Empty implementation of OnShowcaseViewEventListener such that null
      * checks aren't needed
      */
-    public static final OnShowcaseEventListener NONE = new OnShowcaseEventListener() {
+    OnShowcaseEventListener NONE = new OnShowcaseEventListener() {
         @Override
         public void onShowcaseViewHide(ShowcaseView showcaseView) {
 

library/src/main/java/com/github/amlcurran/showcaseview/ShowcaseDrawer.java

@@ -18,22 +18,64 @@
 
 import android.graphics.Bitmap;
 import android.graphics.Canvas;
+import android.support.annotation.ColorInt;
 
+/**
+ * Class to implement your own drawing of a showcase view, should you want more
+ * control. See the other implementations for examples
+ */
 public interface ShowcaseDrawer {
 
-    void setShowcaseColour(int color);
+    /**
+     * Sets the value of the showcase color from themes. What this does is dependent on
+     * your implementation of {@link #drawShowcase(Bitmap, float, float, float)}
+     * @param color the color supplied in the theme
+     */
+    void setShowcaseColour(@ColorInt int color);
 
+    /**
+     * Draw the showcase. How this is performed is up to you!
+     * @param buffer the bitmap to draw onto
+     * @param x the x position of the point to showcase
+     * @param y the y position of the point to showcase
+     * @param scaleMultiplier a scale factor. Currently unused
+     */
     void drawShowcase(Bitmap buffer, float x, float y, float scaleMultiplier);
 
+    /**
+     * @return the width of the showcase, used to calculate where to place text
+     */
     int getShowcaseWidth();
 
+    /**
+     * @return the height of the showcase, used to calculate where to place text
+     */
     int getShowcaseHeight();
 
+    /**
+     * @return the radius to block touches outside of, if
+     * {@link ShowcaseView.Builder#setBlocksTouches(boolean)} is set
+     */
     float getBlockedRadius();
 
-    void setBackgroundColour(int backgroundColor);
+    /**
+     * Set the background color of the showcase. What this means is up to your implementation,
+     * but typically this should be the color used to draw in {@link #erase(Bitmap)}
+     */
+    void setBackgroundColour(@ColorInt int backgroundColor);
 
+    /**
+     * Remove all drawing on the bitmap. Typically, this would do a color fill of the background
+     * color. See {@link StandardShowcaseDrawer} for an example
+     * @param bitmapBuffer the Bitmap to erase drawing from
+     */
     void erase(Bitmap bitmapBuffer);
 
+    /**
+     * Draw the commands drawn to the canvas. Typically this is a single implementation, see
+     * {@link StandardShowcaseDrawer}.
+     * @param canvas canvas to draw to
+     * @param bitmapBuffer bitmap to draw
+     */
     void drawToCanvas(Canvas canvas, Bitmap bitmapBuffer);
 }

library/src/main/java/com/github/amlcurran/showcaseview/ShowcaseView.java

@@ -24,6 +24,7 @@
 import android.graphics.Color;
 import android.graphics.Point;
 import android.graphics.PorterDuff;
+import android.graphics.Rect;
 import android.support.annotation.IntDef;
 import android.text.Layout;
 import android.text.TextPaint;
@@ -125,11 +126,11 @@ protected ShowcaseView(Context context, AttributeSet attrs, int defStyle, boolea
 
         mEndButton = (Button) LayoutInflater.from(context).inflate(R.layout.showcase_button, null);
         if (newStyle) {
-            showcaseDrawer = new NewShowcaseDrawer(getResources());
+            showcaseDrawer = new NewShowcaseDrawer(getResources(), context.getTheme());
         } else {
-            showcaseDrawer = new StandardShowcaseDrawer(getResources());
+            showcaseDrawer = new StandardShowcaseDrawer(getResources(), context.getTheme());
         }
-        textDrawer = new TextDrawer(getResources(), showcaseAreaCalculator, getContext());
+        textDrawer = new TextDrawer(getResources(), getContext());
 
         updateStyle(styled, false);
 
@@ -277,7 +278,8 @@ private void recalculateText() {
         boolean recalculatedCling = showcaseAreaCalculator.calculateShowcaseRect(showcaseX, showcaseY, showcaseDrawer);
         boolean recalculateText = recalculatedCling || hasAlteredText;
         if (recalculateText) {
-            textDrawer.calculateTextPosition(getMeasuredWidth(), getMeasuredHeight(), this, shouldCentreText);
+            Rect rect = hasShowcaseView() ? showcaseAreaCalculator.getShowcaseRect() : new Rect();
+            textDrawer.calculateTextPosition(getMeasuredWidth(), getMeasuredHeight(), shouldCentreText, rect);
         }
         hasAlteredText = false;
     }
@@ -415,7 +417,7 @@ public void showButton() {
      */
     public static class Builder {
 
-        final ShowcaseView showcaseView;
+        private final ShowcaseView showcaseView;
         private final Activity activity;
 
         private ViewGroup parent;
@@ -454,15 +456,15 @@ public ShowcaseView build() {
          * <img alt="Holo showcase example" src="../../../../../../../../example2.png" />
          */
         public Builder withHoloShowcase() {
-            return setShowcaseDrawer(new StandardShowcaseDrawer(activity.getResources()));
+            return setShowcaseDrawer(new StandardShowcaseDrawer(activity.getResources(), activity.getTheme()));
         }
 
         /**
          * Draw a new-style showcase.<br/>
          * <img alt="Holo showcase example" src="../../../../../../../../example.png" />
          */
         public Builder withNewStyleShowcase() {
-            return setShowcaseDrawer(new NewShowcaseDrawer(activity.getResources()));
+            return setShowcaseDrawer(new NewShowcaseDrawer(activity.getResources(), activity.getTheme()));
         }
 
         /**