Cleanup

Author: nhaarman

lib/src/main/java/com/nhaarman/supertooltips/ToolTip.java

@@ -26,35 +26,35 @@ public enum AnimationType {
         NONE
     }
 
-    private CharSequence text;
-    private int textResId;
-    private int color;
-    private int textColor;
-    private View contentView;
-    private AnimationType animationType;
-    private boolean shadow;
-    private Typeface typeface;
+    private CharSequence mText;
+    private int mTextResId;
+    private int mColor;
+    private int mTextColor;
+    private View mContentView;
+    private AnimationType mAnimationType;
+    private boolean mShouldShowShadow;
+    private Typeface mTypeface;
 
     /**
      * Creates a new ToolTip without any values.
      */
     public ToolTip() {
-        text = null;
-        typeface = null;
-        textResId = 0;
-        color = 0;
-        contentView = null;
-        animationType = AnimationType.FROM_MASTER_VIEW;
+        mText = null;
+        mTypeface = null;
+        mTextResId = 0;
+        mColor = 0;
+        mContentView = null;
+        mAnimationType = AnimationType.FROM_MASTER_VIEW;
     }
 
     /**
      * Set the text to show. Has no effect when a content View is set using setContentView().
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withText(CharSequence text) {
-        this.text = text;
-        this.textResId = 0;
+    public ToolTip withText(final CharSequence text) {
+        mText = text;
+        mTextResId = 0;
         return this;
     }
 
@@ -63,9 +63,9 @@ public ToolTip withText(CharSequence text) {
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withText(int resId) {
-        this.textResId = resId;
-        this.text = null;
+    public ToolTip withText(final int resId) {
+        mTextResId = resId;
+        mText = null;
         return this;
     }
 
@@ -74,10 +74,10 @@ public ToolTip withText(int resId) {
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withText(int resId, Typeface tf) {
-        this.textResId = resId;
-        this.text = null;
-        this.withTypeface(tf);
+    public ToolTip withText(final int resId, final Typeface tf) {
+        mTextResId = resId;
+        mText = null;
+        withTypeface(tf);
         return this;
     }
 
@@ -86,8 +86,8 @@ public ToolTip withText(int resId, Typeface tf) {
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withColor(int color) {
-        this.color = color;
+    public ToolTip withColor(final int color) {
+        mColor = color;
         return this;
     }
 
@@ -96,8 +96,8 @@ public ToolTip withColor(int color) {
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withTextColor(int color){
-        this.textColor = color;
+    public ToolTip withTextColor(final int color) {
+        mTextColor = color;
         return this;
     }
 
@@ -106,8 +106,8 @@ public ToolTip withTextColor(int color){
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withContentView(View view) {
-        this.contentView = view;
+    public ToolTip withContentView(final View view) {
+        mContentView = view;
         return this;
     }
 
@@ -116,60 +116,70 @@ public ToolTip withContentView(View view) {
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withAnimationType(AnimationType animationType) {
-        this.animationType = animationType;
+    public ToolTip withAnimationType(final AnimationType animationType) {
+        mAnimationType = animationType;
         return this;
     }
 
     /**
-     * Set whether to show a shadow below the ToolTip.
+     * Set to show a shadow below the ToolTip.
      *
      * @return this ToolTip to build upon.
      */
-    public ToolTip withShadow(boolean shadow) {
-        this.shadow = shadow;
+    public ToolTip withShadow() {
+        mShouldShowShadow = true;
+        return this;
+    }
+
+    /**
+     * Set to NOT show a shadow below the ToolTip.
+     *
+     * @return this ToolTip to build upon.
+     */
+    public ToolTip withoutShadow() {
+        mShouldShowShadow = false;
         return this;
     }
 
     /**
      * @param typeface the typeface to set
      */
-    public void withTypeface(Typeface typeface) {
-        this.typeface = typeface;
+    public void withTypeface(final Typeface typeface) {
+        mTypeface = typeface;
     }
 
     public CharSequence getText() {
-        return text;
+        return mText;
     }
 
     public int getTextResId() {
-        return textResId;
+        return mTextResId;
     }
 
     public int getColor() {
-        return color;
+        return mColor;
     }
 
     public int getTextColor() {
-        return textColor;
+        return mTextColor;
     }
 
     public View getContentView() {
-        return contentView;
+        return mContentView;
     }
 
     public AnimationType getAnimationType() {
-        return animationType;
+        return mAnimationType;
     }
 
-    public boolean getShadow() {
-        return shadow;
+    public boolean shouldShowShadow() {
+        return mShouldShowShadow;
     }
 
     /**
      * @return the typeface
      */
     public Typeface getTypeface() {
-        return typeface;
+        return mTypeface;
     }
 }

lib/src/main/java/com/nhaarman/supertooltips/ToolTipRelativeLayout.java

@@ -25,17 +25,28 @@
 import android.view.ViewGroup;
 import android.widget.RelativeLayout;
 
+import com.nhaarman.supertooltips.exception.NoOverflowMenuRuntimeException;
+import com.nhaarman.supertooltips.exception.NoTitleViewRuntimeException;
+import com.nhaarman.supertooltips.exception.ViewNotFoundRuntimeException;
+
 public class ToolTipRelativeLayout extends RelativeLayout {
 
-    public ToolTipRelativeLayout(Context context) {
+    public static final String ACTION_BAR_TITLE = "action_bar_title";
+    public static final String ID = "id";
+    public static final String ANDROID = "android";
+    public static final String ACTION_BAR = "action_bar";
+    public static final String ACTION_MENU_VIEW = "ActionMenuView";
+    public static final String OVERFLOW_MENU_BUTTON = "OverflowMenuButton";
+
+    public ToolTipRelativeLayout(final Context context) {
         super(context);
     }
 
-    public ToolTipRelativeLayout(Context context, AttributeSet attrs) {
+    public ToolTipRelativeLayout(final Context context, final AttributeSet attrs) {
         super(context, attrs);
     }
 
-    public ToolTipRelativeLayout(Context context, AttributeSet attrs, int defStyle) {
+    public ToolTipRelativeLayout(final Context context, final AttributeSet attrs, final int defStyle) {
         super(context, attrs, defStyle);
     }
 
@@ -123,7 +134,7 @@ public ToolTipView showToolTipForActionBarHome(final Activity activity, final To
      */
     @TargetApi(11)
     public ToolTipView showToolTipForActionBarTitle(final Activity activity, final ToolTip toolTip) {
-        final int titleResId = Resources.getSystem().getIdentifier("action_bar_title", "id", "android");
+        final int titleResId = Resources.getSystem().getIdentifier(ACTION_BAR_TITLE, ID, ANDROID);
         if (titleResId == 0) {
             throw new NoTitleViewRuntimeException();
         }
@@ -153,15 +164,16 @@ public ToolTipView showToolTipForActionBarOverflowMenu(final Activity activity,
     }
 
     @TargetApi(11)
-    private View findActionBarOverflowMenuView(final Activity activity) {
+    private static View findActionBarOverflowMenuView(final Activity activity) {
         final ViewGroup decorView = (ViewGroup) activity.getWindow().getDecorView();
 
-        final int actionBarViewResId = Resources.getSystem().getIdentifier("action_bar", "id", "android");
+        final int actionBarViewResId = Resources.getSystem().getIdentifier(ACTION_BAR, ID, ANDROID);
         final ViewGroup actionBarView = (ViewGroup) decorView.findViewById(actionBarViewResId);
 
         ViewGroup actionMenuView = null;
-        for (int i = 0; i < actionBarView.getChildCount(); ++i) {
-            if (actionBarView.getChildAt(i).getClass().getSimpleName().equals("ActionMenuView")) {
+        int actionBarViewChildCount = actionBarView.getChildCount();
+        for (int i = 0; i < actionBarViewChildCount; ++i) {
+            if (actionBarView.getChildAt(i).getClass().getSimpleName().equals(ACTION_MENU_VIEW)) {
                 actionMenuView = (ViewGroup) actionBarView.getChildAt(i);
             }
         }
@@ -170,9 +182,10 @@ private View findActionBarOverflowMenuView(final Activity activity) {
             throw new NoOverflowMenuRuntimeException();
         }
 
+        int actionMenuChildCount = actionMenuView.getChildCount();
         View overflowMenuButton = null;
-        for (int i = 0; i < actionMenuView.getChildCount(); ++i) {
-            if (actionMenuView.getChildAt(i).getClass().getSimpleName().equals("OverflowMenuButton")) {
+        for (int i = 0; i < actionMenuChildCount; ++i) {
+            if (actionMenuView.getChildAt(i).getClass().getSimpleName().equals(OVERFLOW_MENU_BUTTON)) {
                 overflowMenuButton = actionMenuView.getChildAt(i);
             }
         }
@@ -183,38 +196,4 @@ private View findActionBarOverflowMenuView(final Activity activity) {
 
         return overflowMenuButton;
     }
-
-    /**
-     * A {@link RuntimeException} that is thrown if there is no {@link View}
-     * found with given resource id. You can choose to ignore this by catching
-     * the ViewNotFoundRuntimeException.
-     */
-    public class ViewNotFoundRuntimeException extends RuntimeException {
-        public ViewNotFoundRuntimeException() {
-            super("View not found for this resource id. Are you sure it exists?");
-        }
-    }
-
-    /**
-     * A {@link RuntimeException} that is thrown if the title view in the
-     * {@link ActionBar} is not found. You can choose to ignore this by catching
-     * the NoTitleViewRuntimeException.
-     */
-    public class NoTitleViewRuntimeException extends RuntimeException {
-        public NoTitleViewRuntimeException() {
-            super("No title View found. Are you sure it exists?");
-        }
-    }
-
-    /**
-     * A {@link RuntimeException} that is thrown if the overflow menu is not
-     * found. This happens when there simply is no overflow menu button, or the
-     * menu isn't initialised yet. You can choose to ignore this by catching the
-     * NoOverflowMenuRuntimeException.
-     */
-    public class NoOverflowMenuRuntimeException extends RuntimeException {
-        public NoOverflowMenuRuntimeException() {
-            super("No overflow menu found. Are you sure the overflow menu button is visible? Check the docs for showToolTipForActionBarOverflowMenu(Activity, ToolTip) again!");
-        }
-    }
 }