task/scale-type-rename: Renamed the scaleType attribute to previewSca…

…leType. This clarifies more precisely what this attribute does. It also means KBarcode shouldn't clash with camerax lib should you have both installed.
brightec · Jun 17, 2021 · 793c2f3 · 793c2f3
1 parent 3ae08af
commit 793c2f3
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 23 deletions.
diff --git a/app/src/main/java/uk/co/brightec/kbarcode/app/ProgrammaticActivity.kt b/app/src/main/java/uk/co/brightec/kbarcode/app/ProgrammaticActivity.kt
@@ -40,7 +40,7 @@ internal class ProgrammaticActivity :
                     )
                 )
                 .barcodesSort(null)
-                .scaleType(BarcodeView.CENTER_INSIDE)
+                .previewScaleType(BarcodeView.CENTER_INSIDE)
                 .clearFocusDelay(BarcodeView.CLEAR_FOCUS_DELAY_DEFAULT)
                 .build()
         )

diff --git a/app/src/main/res/layout/activity_xml.xml b/app/src/main/res/layout/activity_xml.xml
@@ -18,7 +18,7 @@
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintTop_toTopOf="parent"
-        app:scaleType="centerInside"
+        app:previewScaleType="centerInside"
         app:sort="none"
         app:clearFocusDelay="2000"/>
 

diff --git a/app/src/main/res/layout/fragment_viewfinder.xml b/app/src/main/res/layout/fragment_viewfinder.xml
@@ -17,7 +17,7 @@
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintTop_toTopOf="parent"
-        app:scaleType="centerCrop"
+        app:previewScaleType="centerCrop"
         app:sort="central" />
 
     <View

diff --git a/kbarcode/src/main/java/uk/co/brightec/kbarcode/BarcodeScanner.kt b/kbarcode/src/main/java/uk/co/brightec/kbarcode/BarcodeScanner.kt
@@ -155,7 +155,7 @@ public class BarcodeScanner internal constructor(
         frameProcessor.barcodesSort = comparator
     }
 
-    override fun setScaleType(@BarcodeView.ScaleType scaleType: Int) {
+    override fun setPreviewScaleType(@BarcodeView.ScaleType scaleType: Int) {
         Timber.v("ScaleType has no affect on ${BarcodeScanner::class.java.simpleName}")
     }
 

diff --git a/kbarcode/src/main/java/uk/co/brightec/kbarcode/BarcodeView.kt b/kbarcode/src/main/java/uk/co/brightec/kbarcode/BarcodeView.kt
@@ -56,7 +56,7 @@ public class BarcodeView @JvmOverloads constructor(
     private val surfaceView = SurfaceView(context)
 
     @ScaleType
-    private var previewScaleType: Int = CENTER_INSIDE
+    private var _previewScaleType: Int = CENTER_INSIDE
         set(value) {
             field = value
             requestLayout()
@@ -97,8 +97,8 @@ public class BarcodeView @JvmOverloads constructor(
                 setMinBarcodeWidth(attrMinBarcodeWidth)
                 val attrSort = getInteger(R.styleable.BarcodeView_sort, 0)
                 setBarcodesSort(sortAttrConvert(attrSort))
-                val attrScaleType = getInteger(R.styleable.BarcodeView_scaleType, 0)
-                setScaleType(scaleTypeAttrConvert(attrScaleType))
+                val attrScaleType = getInteger(R.styleable.BarcodeView_previewScaleType, 0)
+                setPreviewScaleType(previewScaleTypeAttrConvert(attrScaleType))
                 val attrClearFocusDelay = getInteger(
                     R.styleable.BarcodeView_clearFocusDelay,
                     CLEAR_FOCUS_DELAY_DEFAULT.toInt()
@@ -187,8 +187,8 @@ public class BarcodeView @JvmOverloads constructor(
         barcodeScanner.setBarcodesSort(comparator)
     }
 
-    override fun setScaleType(scaleType: Int) {
-        previewScaleType = scaleType
+    override fun setPreviewScaleType(scaleType: Int) {
+        _previewScaleType = scaleType
     }
 
     override fun setClearFocusDelay(delay: Long) {
@@ -197,7 +197,7 @@ public class BarcodeView @JvmOverloads constructor(
 
     override fun onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int) {
         val childRect = calculateRectForChild(
-            scaleType = previewScaleType, left = left, top = top, right = right, bottom = bottom
+            scaleType = _previewScaleType, left = left, top = top, right = right, bottom = bottom
         )
 
         for (i in 0 until childCount) {
@@ -254,7 +254,7 @@ public class BarcodeView @JvmOverloads constructor(
     }
 
     @VisibleForTesting
-    internal fun scaleTypeAttrConvert(attr: Int) = when (attr) {
+    internal fun previewScaleTypeAttrConvert(attr: Int) = when (attr) {
         0 -> CENTER_INSIDE
         1 -> CENTER_CROP
         else -> CENTER_INSIDE

diff --git a/kbarcode/src/main/java/uk/co/brightec/kbarcode/KBarcode.kt b/kbarcode/src/main/java/uk/co/brightec/kbarcode/KBarcode.kt
@@ -43,7 +43,7 @@ public class KBarcode {
 
         public fun setBarcodesSort(comparator: Comparator<Barcode>?)
 
-        public fun setScaleType(@BarcodeView.ScaleType scaleType: Int)
+        public fun setPreviewScaleType(@BarcodeView.ScaleType scaleType: Int)
 
         public fun setClearFocusDelay(delay: Long)
 
@@ -53,7 +53,7 @@ public class KBarcode {
             setBarcodeFormats(options.barcodeFormats)
             setMinBarcodeWidth(options.minBarcodeWidth)
             setBarcodesSort(options.barcodesSort)
-            setScaleType(options.scaleType)
+            setPreviewScaleType(options.previewScaleType)
             setClearFocusDelay(options.clearFocusDelay)
         }
     }

diff --git a/kbarcode/src/main/java/uk/co/brightec/kbarcode/Options.kt b/kbarcode/src/main/java/uk/co/brightec/kbarcode/Options.kt
@@ -12,7 +12,7 @@ public data class Options(
     val barcodeFormats: IntArray = intArrayOf(Barcode.FORMAT_ALL_FORMATS),
     @Px val minBarcodeWidth: Int? = null,
     val barcodesSort: BarcodeComparator? = null,
-    @BarcodeView.ScaleType val scaleType: Int,
+    @BarcodeView.ScaleType val previewScaleType: Int,
     val clearFocusDelay: Long
 ) {
 
@@ -22,7 +22,7 @@ public data class Options(
         private var barcodeFormats: IntArray = intArrayOf(Barcode.FORMAT_ALL_FORMATS),
         @Px private var minBarcodeWidth: Int? = null,
         private var barcodesSort: BarcodeComparator? = null,
-        @BarcodeView.ScaleType private var scaleType: Int = BarcodeView.CENTER_INSIDE,
+        @BarcodeView.ScaleType private var previewScaleType: Int = BarcodeView.CENTER_INSIDE,
         private var clearFocusDelay: Long = BarcodeView.CLEAR_FOCUS_DELAY_DEFAULT
     ) {
 
@@ -50,8 +50,8 @@ public data class Options(
             this.barcodesSort = barcodesSort
         }
 
-        public fun scaleType(@BarcodeView.ScaleType scaleType: Int): Builder = apply {
-            this.scaleType = scaleType
+        public fun previewScaleType(@BarcodeView.ScaleType scaleType: Int): Builder = apply {
+            this.previewScaleType = scaleType
         }
 
         public fun clearFocusDelay(clearFocusDelay: Long): Builder = apply {
@@ -64,7 +64,7 @@ public data class Options(
             barcodeFormats = barcodeFormats,
             minBarcodeWidth = minBarcodeWidth,
             barcodesSort = barcodesSort,
-            scaleType = scaleType,
+            previewScaleType = previewScaleType,
             clearFocusDelay = clearFocusDelay
         )
     }
@@ -80,7 +80,7 @@ public data class Options(
         if (!barcodeFormats.contentEquals(other.barcodeFormats)) return false
         if (minBarcodeWidth != other.minBarcodeWidth) return false
         if (barcodesSort != other.barcodesSort) return false
-        if (scaleType != other.scaleType) return false
+        if (previewScaleType != other.previewScaleType) return false
         if (clearFocusDelay != other.clearFocusDelay) return false
 
         return true
@@ -92,7 +92,7 @@ public data class Options(
         result = 31 * result + barcodeFormats.contentHashCode()
         result = 31 * result + minBarcodeWidth.hashCode()
         result = 31 * result + (barcodesSort?.hashCode() ?: 0)
-        result = 31 * result + scaleType.hashCode()
+        result = 31 * result + previewScaleType.hashCode()
         result = 31 * result + clearFocusDelay.hashCode()
         return result
     }

diff --git a/kbarcode/src/main/res/values/attrs.xml b/kbarcode/src/main/res/values/attrs.xml
@@ -27,7 +27,7 @@
             <enum name="none" value="0" />
             <enum name="central" value="1" />
         </attr>
-        <attr name="scaleType" format="enum">
+        <attr name="previewScaleType" format="enum">
             <enum name="centerInside" value="0" />
             <enum name="centerCrop" value="1" />
         </attr>

diff --git a/kbarcode/src/test/java/uk/co/brightec/kbarcode/KBarcodeScannerTest.kt b/kbarcode/src/test/java/uk/co/brightec/kbarcode/KBarcodeScannerTest.kt
@@ -31,7 +31,7 @@ internal class KBarcodeScannerTest {
             on { barcodeFormats } doReturn intArrayOf(1, 2, 3)
             on { minBarcodeWidth } doReturn -2
             on { barcodesSort } doReturn mock()
-            on { scaleType } doReturn -3
+            on { previewScaleType } doReturn -3
             on { clearFocusDelay } doReturn 1234L
         }
 
@@ -44,7 +44,7 @@ internal class KBarcodeScannerTest {
         verify(barcodeScanner).setBarcodeFormats(options.barcodeFormats)
         verify(barcodeScanner).setMinBarcodeWidth(options.minBarcodeWidth)
         verify(barcodeScanner).setBarcodesSort(options.barcodesSort)
-        verify(barcodeScanner).setScaleType(options.scaleType)
+        verify(barcodeScanner).setScaleType(options.previewScaleType)
         verify(barcodeScanner).setClearFocusDelay(options.clearFocusDelay)
     }