api tidy up

fractalwrench · fractalwrench · commit ebfb0d475339 · 2015-10-06T21:46:16.000+01:00
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/AwesomeTextView.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/AwesomeTextView.java
@@ -21,7 +21,6 @@
 import com.beardedhen.androidbootstrap.font.FontAwesome;
 import com.beardedhen.androidbootstrap.font.IconSet;
 import com.beardedhen.androidbootstrap.font.Typicon;
-import com.beardedhen.androidbootstrap.support.BootstrapText;
 
 import java.io.Serializable;
 
@@ -159,7 +158,7 @@ public void startFlashing(boolean forever, AnimationSpeed speed) {
     }
 
     /**
-     * Starts a rotating animation on the AwesomeTetView
+     * Starts a rotating animation on the AwesomeTextView
      *
      * @param clockwise true for clockwise, false for anti clockwise spinning
      * @param speed     how fast the item should rotate
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapBaseThumbnail.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapBaseThumbnail.java
@@ -1,5 +1,6 @@
 package com.beardedhen.androidbootstrap;
 
+import android.annotation.TargetApi;
 import android.content.Context;
 import android.graphics.Bitmap;
 import android.graphics.Canvas;
@@ -199,7 +200,7 @@ private void setupPaints() {
         return bootstrapBrand;
     }
 
-    @Override public void setBorderDisplayed(boolean displayed) {
+    @TargetApi(16) @Override public void setBorderDisplayed(boolean displayed) {
         this.hasBorder = displayed;
         updateImageState();
     }
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapButton.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapButton.java
@@ -20,7 +20,7 @@
 import com.beardedhen.androidbootstrap.api.view.ButtonModeView;
 import com.beardedhen.androidbootstrap.api.view.OutlineableView;
 import com.beardedhen.androidbootstrap.api.view.RoundableView;
-import com.beardedhen.androidbootstrap.support.DimenUtils;
+import com.beardedhen.androidbootstrap.utils.DimenUtils;
 
 import java.io.Serializable;
 
@@ -81,7 +81,7 @@ private void initialise(AttributeSet attrs) {
             buttonMode = ButtonMode.fromAttributeValue(modeOrdinal);
 
             final Resources res = getResources();
-            baselineFontSize = DimenUtils.textSizeFromDimenResource(getContext(), R.dimen.bootstrap_button_default_font_size);
+            baselineFontSize = DimenUtils.pixelsFromSpResource(getContext(), R.dimen.bootstrap_button_default_font_size);
             baselineVertPadding = res.getDimension(R.dimen.bootstrap_button_default_vert_padding);
             baselineHoriPadding = res.getDimension(R.dimen.bootstrap_button_default_hori_padding);
             baselineStrokeWidth = res.getDimension(R.dimen.bootstrap_button_default_edge_width);
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapCard.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapCard.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapDrawableFactory.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapDrawableFactory.java
@@ -12,7 +12,7 @@
 import com.beardedhen.androidbootstrap.api.attributes.BootstrapBrand;
 import com.beardedhen.androidbootstrap.api.attributes.ViewGroupPosition;
 import com.beardedhen.androidbootstrap.api.defaults.DefaultBootstrapBrand;
-import com.beardedhen.androidbootstrap.support.ColorUtils;
+import com.beardedhen.androidbootstrap.utils.ColorUtils;
 
 /**
  * Provides a factory for generating Drawables which are used as the backgrounds for Bootstrap Views.
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapEditText.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapEditText.java
@@ -18,7 +18,7 @@
 import com.beardedhen.androidbootstrap.api.view.BootstrapBrandView;
 import com.beardedhen.androidbootstrap.api.view.BootstrapSizeView;
 import com.beardedhen.androidbootstrap.api.view.RoundableView;
-import com.beardedhen.androidbootstrap.support.DimenUtils;
+import com.beardedhen.androidbootstrap.utils.DimenUtils;
 
 import java.io.Serializable;
 
@@ -73,7 +73,7 @@ private void initialise(AttributeSet attrs) {
         }
 
         final Resources res = getResources();
-        baselineFontSize = DimenUtils.textSizeFromDimenResource(getContext(), R.dimen.bootstrap_edit_text_default_font_size);
+        baselineFontSize = DimenUtils.pixelsFromSpResource(getContext(), R.dimen.bootstrap_edit_text_default_font_size);
         baselineVertPadding = res.getDimension(R.dimen.bootstrap_edit_text_vert_padding);
         baselineHoriPadding = res.getDimension(R.dimen.bootstrap_edit_text_hori_padding);
         baselineStrokeWidth = res.getDimension(R.dimen.bootstrap_edit_text_edge_width);
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapText.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapText.java
@@ -1,10 +1,9 @@
-package com.beardedhen.androidbootstrap.support;
+package com.beardedhen.androidbootstrap;
 
 import android.content.Context;
 import android.text.SpannableString;
 import android.text.Spanned;
 
-import com.beardedhen.androidbootstrap.TypefaceProvider;
 import com.beardedhen.androidbootstrap.font.AwesomeTypefaceSpan;
 import com.beardedhen.androidbootstrap.font.FontAwesome;
 import com.beardedhen.androidbootstrap.font.IconSet;
@@ -16,7 +15,7 @@
 
 /**
  * Bootstrap Text provides a Builder class, which allows convenient construction of SpannableStrings.
- * Currently regular text and FontAwesome icons can be added.
+ * Currently regular text, FontAwesome icons, and Typicons can be added.
  */
 public class BootstrapText extends SpannableString implements Serializable {
 
@@ -52,9 +51,8 @@ public Builder addText(CharSequence text) {
             return this;
         }
 
-
         /**
-         * Appends a FontIcon to the BootstrapText under construction
+         * Appends a FontAwesomeIcon to the BootstrapText under construction
          * @return the updated builder instance
          */
         public Builder addFontAwesomeIcon(@FontAwesome.Icon CharSequence iconCode) {
@@ -65,7 +63,7 @@ public Builder addFontAwesomeIcon(@FontAwesome.Icon CharSequence iconCode) {
         }
 
         /**
-         * Appends a FontIcon to the BootstrapText under construction
+         * Appends a Typicon to the BootstrapText under construction
          * @return the updated builder instance
          */
         public Builder addTypicon(@Typicon.Icon CharSequence iconCode) {
@@ -76,7 +74,7 @@ public Builder addTypicon(@Typicon.Icon CharSequence iconCode) {
         }
 
         /**
-         * Appends a FontIcon to the BootstrapText under construction
+         * Appends a font icon to the BootstrapText under construction
          * @param iconSet a font icon
          * @return the updated builder instance
          */
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapThumbnail.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/BootstrapThumbnail.java
@@ -1,6 +1,5 @@
 package com.beardedhen.androidbootstrap;
 
-import android.annotation.TargetApi;
 import android.content.Context;
 import android.content.res.TypedArray;
 import android.graphics.Canvas;
@@ -154,10 +153,6 @@ private void updatePadding() {
      * Getters/setters
      */
 
-    @TargetApi(16) @Override public void setBorderDisplayed(boolean displayed) {
-        super.setBorderDisplayed(displayed);
-    }
-
     @Override public void setRounded(boolean rounded) {
         this.roundedCorners = rounded;
         updateImageState();
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/IconResolver.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/IconResolver.java
@@ -5,7 +5,6 @@
 import com.beardedhen.androidbootstrap.font.FontAwesome;
 import com.beardedhen.androidbootstrap.font.IconSet;
 import com.beardedhen.androidbootstrap.font.Typicon;
-import com.beardedhen.androidbootstrap.support.BootstrapText;
 
 /**
  * Resolves markdown strings using FA codes and produces BootstrapText instances.
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/TypefaceProvider.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/TypefaceProvider.java
@@ -12,7 +12,8 @@
 import java.util.Map;
 
 /**
- * Holds static instances of Typefaces, and FontIcon sets.
+ * Holds static instances of Typefaces, and IconSets, allowing views to use them across the application
+ * without expensive initialisation.
  */
 public class TypefaceProvider {
 
@@ -37,8 +38,8 @@ public static Typeface getTypeface(Context context, IconSet iconSet) {
     }
 
     /**
-     * Performs setup of the Default FontIconSets so that they are available throughout the whole
-     * application. Currently the default icon set includes FontAwesome.
+     * Registers instances of the Default IconSets so that they are available throughout the whole
+     * application. Currently the default icon sets include FontAwesome and Typicon.
      */
     public static void registerDefaultIconSets() {
         final FontAwesome fontAwesome = new FontAwesome();
@@ -49,14 +50,19 @@ public static void registerDefaultIconSets() {
     }
 
     /**
-     * Performs setup of a custom FontIconSet, so that it is available throughout the whole application.
+     * Registers a custom IconSet, so that it is available for use throughout the whole application.
      *
-     * @param iconSet a custom FontIcon
+     * @param iconSet a custom IconSet
      */
     public static void registerCustomIconSet(IconSet iconSet) {
         REGISTERED_ICON_SETS.put(iconSet.fontPath(), iconSet);
     }
 
+    /**
+     * Retrieves a registered IconSet whose font can be found in the asset directory at the given path
+     * @param fontPath the given path
+     * @return the registered IconSet instance
+     */
     public static IconSet retrieveRegisteredIconSet(String fontPath) {
         final IconSet iconSet = REGISTERED_ICON_SETS.get(fontPath);
 
@@ -67,7 +73,8 @@ public static IconSet retrieveRegisteredIconSet(String fontPath) {
     }
 
     /**
-     * @return a collection of registered FontIconSets.
+     * Retrieves a collection of all registered IconSets in the application
+     * @return a collection of registered IconSets.
      */
     public static Collection<IconSet> getRegisteredIconSets() {
         return REGISTERED_ICON_SETS.values();
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapBrand.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapBrand.java
@@ -6,13 +6,13 @@
 import com.beardedhen.androidbootstrap.R;
 import com.beardedhen.androidbootstrap.api.attributes.BootstrapBrand;
 
-import static com.beardedhen.androidbootstrap.support.ColorUtils.ACTIVE_OPACITY_FACTOR_EDGE;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.ACTIVE_OPACITY_FACTOR_FILL;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.DISABLED_ALPHA_EDGE;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.DISABLED_ALPHA_FILL;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.decreaseRgbChannels;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.increaseOpacity;
-import static com.beardedhen.androidbootstrap.support.ColorUtils.resolveColor;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.ACTIVE_OPACITY_FACTOR_EDGE;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.ACTIVE_OPACITY_FACTOR_FILL;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.DISABLED_ALPHA_EDGE;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.DISABLED_ALPHA_FILL;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.decreaseRgbChannels;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.increaseOpacity;
+import static com.beardedhen.androidbootstrap.utils.ColorUtils.resolveColor;
 
 /**
  * Bootstrap provides 6 brands by default - Primary, Success, Info, Warning, Danger, and Default.
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapHeading.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapHeading.java
@@ -5,13 +5,13 @@
 
 import com.beardedhen.androidbootstrap.R;
 import com.beardedhen.androidbootstrap.api.attributes.BootstrapHeading;
-import com.beardedhen.androidbootstrap.support.DimenUtils;
+import com.beardedhen.androidbootstrap.utils.DimenUtils;
 
 /**
  * Bootstrap provides styling for elements H1-H6, and sets their text size & padding using the
  * values supplied here.
  */
-public enum DefaultBootstrapHeading implements BootstrapHeading { // FIXME change values
+public enum DefaultBootstrapHeading implements BootstrapHeading {
 
     H1(R.dimen.bootstrap_h1_text_size,
        R.dimen.bootstrap_h1_vert_padding,
@@ -67,15 +67,15 @@ public static DefaultBootstrapHeading fromAttributeValue(int attrValue) {
     }
 
     @Override public float getTextSize(Context context) {
-        return DimenUtils.textSizeFromDimenResource(context, textSize);
+        return DimenUtils.pixelsFromSpResource(context, textSize);
     }
 
     @Override public float verticalPadding(Context context) {
-        return context.getResources().getDimension(vertPadding);
+        return DimenUtils.pixelsFromDpResource(context, vertPadding);
     }
 
     @Override public float horizontalPadding(Context context) {
-        return context.getResources().getDimension(horiPadding);
+        return DimenUtils.pixelsFromDpResource(context, horiPadding);
     }
 
 }
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapSize.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/defaults/DefaultBootstrapSize.java
@@ -2,7 +2,7 @@
 
 /**
  * Bootstrap provides 5 sizes - XS, SM, MD, LG, and XL. In the Android implementation the scale
- * factors used are 0.75, 0.83, 1.00, 1.50, and 2.00 respectively.
+ * factors used are 0.70, 0.85, 1.00, 1.30, and 1.60 respectively.
  */
 public enum DefaultBootstrapSize {
 
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/BootstrapSizeView.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/BootstrapSizeView.java
@@ -15,7 +15,6 @@ public interface BootstrapSizeView {
      * For example, specifying that a Button should use a scale factor of 2.0 may increase its
      * padding and font size by that factor.
      *
-     * @param context the current context
      * @return the scale factor
      */
     float getBootstrapSize();
@@ -25,15 +24,14 @@ public interface BootstrapSizeView {
      * For example, specifying that a Button should use a scale factor of 2.0 may increase its
      * padding and font size by that factor.
      *
-     * @param bootstrapSize
-     * @return the scale factor
+     * @param bootstrapSize the scale factor
      */
     void setBootstrapSize(float bootstrapSize);
 
     /**
      * Convenience method that sets the scale factor using a default bootstrap size enum value.
      *
-     * @param bootstrapSize
+     * @param bootstrapSize a default scale factor
      */
     void setBootstrapSize(DefaultBootstrapSize bootstrapSize);
 
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/BootstrapTextView.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/BootstrapTextView.java
@@ -2,14 +2,14 @@
 
 import android.support.annotation.Nullable;
 
-import com.beardedhen.androidbootstrap.support.BootstrapText;
+import com.beardedhen.androidbootstrap.BootstrapText;
 
 /**
  * Views which implement this interface can set their text using BootstrapText
  */
 public interface BootstrapTextView {
 
-    String KEY = "com.beardedhen.androidbootstrap.support.BootstrapText";
+    String KEY = "com.beardedhen.androidbootstrap.BootstrapText";
 
     /**
      * Sets the view to display the given BootstrapText
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/OutlineableView.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/api/view/OutlineableView.java
@@ -1,12 +1,23 @@
 package com.beardedhen.androidbootstrap.api.view;
 
-// TODO document/finalise
+/**
+ * Views which implement this interface allow the user to specify whether the view should be
+ * displayed as an outline or not.
+ */
 public interface OutlineableView {
 
     String KEY = "Outlineable";
 
+    /**
+     * Sets whether the view should display itself as an outline or not.
+     *
+     * @param showOutline true to display as an outline, otherwise false
+     */
     void setShowOutline(boolean showOutline);
 
+    /**
+     * @return true if the view is currently displaying itself as an outline
+     */
     boolean isShowOutline();
 
 }
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/AwesomeTypefaceSpan.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/AwesomeTypefaceSpan.java
@@ -7,10 +7,8 @@
 
 import com.beardedhen.androidbootstrap.TypefaceProvider;
 
-// TODO see Iconify Span https://goo.gl/sdUwwm
-
 /**
- * A custom span which changes the text to the supplied typeface
+ * A custom span which paints text using the typeface specified by the IconSet passed to the constructor
  */
 public class AwesomeTypefaceSpan extends TypefaceSpan {
 
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/FontAwesome.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/FontAwesome.java
@@ -18,7 +18,6 @@ public class FontAwesome implements IconSet {
 
     public static final String FONT_PATH = "fontawesome-webfont-v440.ttf";
 
-
     @Override public CharSequence unicodeForKey(@Icon CharSequence key) {
         return ICON_MAP.get(key);
     }
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/IconSet.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/IconSet.java
@@ -29,5 +29,4 @@ public interface IconSet {
      */
     CharSequence fontPath();
 
-
 }
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/Typicon.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/font/Typicon.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/AutoResizeTextView.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/AutoResizeTextView.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/DimenUtils.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/DimenUtils.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/ImageUtils.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/support/ImageUtils.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/utils/ColorUtils.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/utils/ColorUtils.java
diff --git a/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/utils/DimenUtils.java b/AndroidBootstrap/src/main/java/com/beardedhen/androidbootstrap/utils/DimenUtils.java
diff --git a/TODO.md b/TODO.md
diff --git a/sample/src/main/java/com/fractalwrench/androidbootstrap/sample/AwesomeTextViewExample.java b/sample/src/main/java/com/fractalwrench/androidbootstrap/sample/AwesomeTextViewExample.java

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,6 @@`
`21`	`21`	`import com.beardedhen.androidbootstrap.font.FontAwesome;`
`22`	`22`	`import com.beardedhen.androidbootstrap.font.IconSet;`
`23`	`23`	`import com.beardedhen.androidbootstrap.font.Typicon;`
`24`		`-import com.beardedhen.androidbootstrap.support.BootstrapText;`
`25`	`24`
`26`	`25`	`import java.io.Serializable;`
`27`	`26`
`@@ -159,7 +158,7 @@ public void startFlashing(boolean forever, AnimationSpeed speed) {`
`159`	`158`	`}`
`160`	`159`
`161`	`160`	`/**`
`162`		`- * Starts a rotating animation on the AwesomeTetView`
	`161`	`+ * Starts a rotating animation on the AwesomeTextView`
`163`	`162`	`*`
`164`	`163`	`* @param clockwise true for clockwise, false for anti clockwise spinning`
`165`	`164`	`* @param speed how fast the item should rotate`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package com.beardedhen.androidbootstrap;`
`2`	`2`
	`3`	`+import android.annotation.TargetApi;`
`3`	`4`	`import android.content.Context;`
`4`	`5`	`import android.graphics.Bitmap;`
`5`	`6`	`import android.graphics.Canvas;`
`@@ -199,7 +200,7 @@ private void setupPaints() {`
`199`	`200`	`return bootstrapBrand;`
`200`	`201`	`}`
`201`	`202`
`202`		`- @Override public void setBorderDisplayed(boolean displayed) {`
	`203`	`+ @TargetApi(16) @Override public void setBorderDisplayed(boolean displayed) {`
`203`	`204`	`this.hasBorder = displayed;`
`204`	`205`	`updateImageState();`
`205`	`206`	`}`