[Slider] Add new tick visibility modes

pubiqq · pubiqq · commit 8785ab754e12 · 2024-04-01T17:27:39.000+03:00
diff --git a/catalog/java/io/material/catalog/slider/res/layout/cat_slider_demo_discrete.xml b/catalog/java/io/material/catalog/slider/res/layout/cat_slider_demo_discrete.xml
@@ -163,7 +163,7 @@
         android:valueFrom="0"
         android:valueTo="10"
         android:stepSize="1"
-        app:tickVisible="false"/>
+        app:tickVisibilityMode="hidden" />
     </LinearLayout>
 
     <com.google.android.material.materialswitch.MaterialSwitch
diff --git a/docs/components/Slider.md b/docs/components/Slider.md
@@ -351,12 +351,15 @@ Element       | Attribute           | Related method(s)
 | **Color for tick's inactive part**  | `app:tickColorInactive`  | `setTickInactiveTintList`<br/>`getTickInactiveTintList` | `?attr/colorPrimary`                 |
 | **Radius for tick's active part**   | `app:tickRadiusActive`   | `setTickActiveRadius`<br/>`getTickActiveRadius`         | `null` (1/2 trackStopIndicatorSize)  |
 | **Radius for tick's inactive part** | `app:tickRadiusInactive` | `setTickInactiveRadius`<br/>`getTickInactiveRadius`     | `null` (1/2 trackStopIndicatorSize)  |
-| **Tick visible**                    | `app:tickVisible`        | `setTickVisible`<br/>`isTickVisible()`                  | `true`                               |
+| **Tick visible** (deprecated)       | `app:tickVisible`        | `setTickVisible`<br/>`isTickVisible()`                  | `true`                               |
+| **Tick visibility mode**            | `app:tickVisibilityMode` | `setTickVisibilityMode`<br/>`getTickVisibilityMode()`   | `autoLimit`                          |
 
 **Note:** `app:tickColor` takes precedence over `app:tickColorActive` and
-`app:tickColorInative`. It's a shorthand for setting both values to the same
+`app:tickColorInactive`. It's a shorthand for setting both values to the same
 thing.
 
+**Note:** `app:tickVisible` is deprecated in favor of `app:tickVisibilityMode`.
+
 #### Styles
 
 Element           | Style
diff --git a/lib/java/com/google/android/material/slider/BaseSlider.java b/lib/java/com/google/android/material/slider/BaseSlider.java
@@ -25,6 +25,10 @@
 import static com.google.android.material.slider.LabelFormatter.LABEL_GONE;
 import static com.google.android.material.slider.LabelFormatter.LABEL_VISIBLE;
 import static com.google.android.material.slider.LabelFormatter.LABEL_WITHIN_BOUNDS;
+import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_AUTO_HIDE;
+import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_AUTO_LIMIT;
+import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_HIDDEN;
+import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_VISIBLE_ALL;
 import static com.google.android.material.theme.overlay.MaterialThemeOverlay.wrap;
 import static java.lang.Float.compare;
 import static java.lang.Math.abs;
@@ -151,8 +155,10 @@
  *       discrete mode. This is a short hand for setting both the {@code tickColorActive} and {@code
  *       tickColorInactive} to the same thing. This takes precedence over {@code tickColorActive}
  *       and {@code tickColorInactive}.
- *   <li>{@code tickVisible}: Whether to show the tick marks. Only used when the slider is in
- *       discrete mode.
+ *   <li>{@code tickVisible} (deprecated, use {@code tickVisibilityMode} instead): Whether to show
+ *       the tick marks. Only used when the slider is in discrete mode.
+ *   <li>{@code tickVisibilityMode}: Mode to specify the visibility of tick marks. Only used when
+ *       the slider is in discrete mode.
  *   <li>{@code trackColorActive}: The color of the active part of the track.
  *   <li>{@code trackColorInactive}: The color of the inactive part of the track.
  *   <li>{@code trackColor}: The color of the whole track. This is a short hand for setting both the
@@ -202,6 +208,7 @@
  * @attr ref com.google.android.material.R.styleable#Slider_tickColorActive
  * @attr ref com.google.android.material.R.styleable#Slider_tickColorInactive
  * @attr ref com.google.android.material.R.styleable#Slider_tickVisible
+ * @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
  * @attr ref com.google.android.material.R.styleable#Slider_trackColor
  * @attr ref com.google.android.material.R.styleable#Slider_trackColorActive
  * @attr ref com.google.android.material.R.styleable#Slider_trackColorInactive
@@ -322,7 +329,7 @@ abstract class BaseSlider<
   private int focusedThumbIdx = -1;
   private float stepSize = 0.0f;
   private float[] ticksCoordinates;
-  private boolean tickVisible = true;
+  private int tickVisibilityMode;
   private int tickActiveRadius;
   private int tickInactiveRadius;
   private int trackWidth;
@@ -501,7 +508,10 @@ private void processAttributes(Context context, AttributeSet attrs, int defStyle
             ? haloColor
             : AppCompatResources.getColorStateList(context, R.color.material_slider_halo_color));
 
-    tickVisible = a.getBoolean(R.styleable.Slider_tickVisible, true);
+    tickVisibilityMode = a.hasValue(R.styleable.Slider_tickVisibilityMode)
+        ? a.getInt(R.styleable.Slider_tickVisibilityMode, -1)
+        : convertToTickVisibilityMode(a.getBoolean(R.styleable.Slider_tickVisible, true));
+
     boolean hasTickColor = a.hasValue(R.styleable.Slider_tickColor);
     int tickColorInactiveRes =
         hasTickColor ? R.styleable.Slider_tickColor : R.styleable.Slider_tickColorInactive;
@@ -1669,22 +1679,61 @@ public void setTickInactiveTintList(@NonNull ColorStateList tickColor) {
   /**
    * Returns whether the tick marks are visible. Only used when the slider is in discrete mode.
    *
-   * @see #setTickVisible(boolean)
    * @attr ref com.google.android.material.R.styleable#Slider_tickVisible
    */
   public boolean isTickVisible() {
-    return tickVisible;
+    switch (tickVisibilityMode) {
+      case TICK_VISIBILITY_VISIBLE_ALL:
+      case TICK_VISIBILITY_AUTO_LIMIT:
+        return true;
+      case TICK_VISIBILITY_AUTO_HIDE:
+        return getDesiredTickCount() <= getMaxTickCount();
+      case TICK_VISIBILITY_HIDDEN:
+        return false;
+      default:
+        throw new RuntimeException("Unexpected tickVisibilityMode: " + tickVisibilityMode);
+    }
   }
 
   /**
    * Sets whether the tick marks are visible. Only used when the slider is in discrete mode.
    *
    * @param tickVisible The visibility of tick marks.
    * @attr ref com.google.android.material.R.styleable#Slider_tickVisible
+   * @deprecated Use {@link #setTickVisibilityMode(int)} instead.
    */
+  @Deprecated
   public void setTickVisible(boolean tickVisible) {
-    if (this.tickVisible != tickVisible) {
-      this.tickVisible = tickVisible;
+    setTickVisibilityMode(convertToTickVisibilityMode(tickVisible));
+  }
+
+  @TickVisibilityMode
+  private int convertToTickVisibilityMode(boolean tickVisible) {
+    return tickVisible
+        ? TICK_VISIBILITY_AUTO_LIMIT
+        : TICK_VISIBILITY_HIDDEN;
+  }
+
+  /**
+   * Returns the current tick visibility mode.
+   *
+   * @see #setTickVisibilityMode(int)
+   * @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
+   */
+  @TickVisibilityMode
+  public int getTickVisibilityMode() {
+    return tickVisibilityMode;
+  }
+
+  /**
+   * Sets the tick visibility mode. Only used when the slider is in discrete mode.
+   *
+   * @see #getTickVisibilityMode()
+   * @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
+   */
+  public void setTickVisibilityMode(@TickVisibilityMode int tickVisibilityMode) {
+    if (this.tickVisibilityMode != tickVisibilityMode) {
+      this.tickVisibilityMode = tickVisibilityMode;
       postInvalidate();
     }
   }
@@ -1934,24 +1983,60 @@ protected void onSizeChanged(int w, int h, int oldw, int oldh) {
     updateHaloHotspot();
   }
 
-  private void maybeCalculateTicksCoordinates() {
+  private void updateTicksCoordinates() {
+    validateConfigurationIfDirty();
+
     if (stepSize <= 0.0f) {
+      updateTicksCoordinates(/* tickCount= */ 0);
       return;
     }
 
-    validateConfigurationIfDirty();
+    final int tickCount;
+    switch (tickVisibilityMode) {
+      case TICK_VISIBILITY_VISIBLE_ALL:
+        tickCount = getDesiredTickCount();
+        break;
+      case TICK_VISIBILITY_AUTO_LIMIT:
+        tickCount = min(getDesiredTickCount(), getMaxTickCount());
+        break;
+      case TICK_VISIBILITY_AUTO_HIDE:
+        int desiredTickCount = getDesiredTickCount();
+        tickCount = desiredTickCount <= getMaxTickCount() ? desiredTickCount : 0;
+        break;
+      case TICK_VISIBILITY_HIDDEN:
+        tickCount = 0;
+        break;
+      default:
+        throw new RuntimeException("Unexpected tickVisibilityMode: " + tickVisibilityMode);
+    }
+
+    updateTicksCoordinates(tickCount);
+  }
+
+  private int getDesiredTickCount() {
+    return (int) ((valueTo - valueFrom) / stepSize + 1);
+  }
+
+  private int getMaxTickCount() {
+    return trackWidth / minTickSpacing + 1;
+  }
+
+  private void updateTicksCoordinates(int tickCount) {
+    if (tickCount == 0) {
+      ticksCoordinates = null;
+      return;
+    }
 
-    int tickCount = (int) ((valueTo - valueFrom) / stepSize + 1);
-    // Limit the tickCount if they will be too dense.
-    tickCount = min(tickCount, trackWidth / minTickSpacing + 1);
     if (ticksCoordinates == null || ticksCoordinates.length != tickCount * 2) {
       ticksCoordinates = new float[tickCount * 2];
     }
 
     float interval = trackWidth / (float) (tickCount - 1);
+    float trackCenterY = calculateTrackCenter();
+
     for (int i = 0; i < tickCount * 2; i += 2) {
       ticksCoordinates[i] = trackSidePadding + i / 2f * interval;
-      ticksCoordinates[i + 1] = calculateTrackCenter();
+      ticksCoordinates[i + 1] = trackCenterY;
     }
   }
 
@@ -1960,7 +2045,7 @@ private void updateTrackWidth(int width) {
     trackWidth = max(width - trackSidePadding * 2, 0);
 
     // Update the visible tick coordinates.
-    maybeCalculateTicksCoordinates();
+    updateTicksCoordinates();
   }
 
   private void updateHaloHotspot() {
@@ -1989,7 +2074,7 @@ protected void onDraw(@NonNull Canvas canvas) {
       validateConfigurationIfDirty();
 
       // Update the visible tick coordinates.
-      maybeCalculateTicksCoordinates();
+      updateTicksCoordinates();
     }
 
     super.onDraw(canvas);
@@ -2214,7 +2299,7 @@ private float[] getCornerRadii(float leftSide, float rightSide) {
   }
 
   private void maybeDrawTicks(@NonNull Canvas canvas) {
-    if (!tickVisible || stepSize <= 0.0f) {
+    if (ticksCoordinates == null || ticksCoordinates.length == 0) {
       return;
     }
 
diff --git a/lib/java/com/google/android/material/slider/TickVisibilityMode.java b/lib/java/com/google/android/material/slider/TickVisibilityMode.java
@@ -0,0 +1,42 @@
+package com.google.android.material.slider;
+
+import androidx.annotation.IntDef;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Mode to specify the visibility of tick marks.
+ */
+@IntDef({
+    TickVisibilityMode.TICK_VISIBILITY_VISIBLE_ALL,
+    TickVisibilityMode.TICK_VISIBILITY_AUTO_LIMIT,
+    TickVisibilityMode.TICK_VISIBILITY_AUTO_HIDE,
+    TickVisibilityMode.TICK_VISIBILITY_HIDDEN
+})
+@Retention(RetentionPolicy.SOURCE)
+public @interface TickVisibilityMode {
+
+  /**
+   * All tick marks will be drawn, even if they are spaced too densely.
+   */
+  int TICK_VISIBILITY_VISIBLE_ALL = 0;
+
+  /**
+   * All tick marks will be drawn if they are not spaced too densely. Otherwise, the maximum
+   * allowed number of tick marks will be drawn.
+   * Note that in this case, the drawn ticks may not match the actual snap values.
+   */
+  int TICK_VISIBILITY_AUTO_LIMIT = 1;
+
+  /**
+   * All tick marks will be drawn if they are not spaced too densely. Otherwise, the tick marks
+   * will not be drawn.
+   */
+  int TICK_VISIBILITY_AUTO_HIDE = 2;
+
+  /**
+   * Tick marks will not be drawn.
+   */
+  int TICK_VISIBILITY_HIDDEN = 3;
+}
diff --git a/lib/java/com/google/android/material/slider/res-public/values/public.xml b/lib/java/com/google/android/material/slider/res-public/values/public.xml
@@ -35,6 +35,7 @@
   <public name="tickRadiusActive" type="attr" />
   <public name="tickRadiusInactive" type="attr" />
   <public name="tickVisible" type="attr" />
+  <public name="tickVisibilityMode" type="attr" />
   <public name="trackColorActive" type="attr" />
   <public name="trackColorInactive" type="attr" />
   <public name="trackHeight" type="attr" />
diff --git a/lib/java/com/google/android/material/slider/res/values/attrs.xml b/lib/java/com/google/android/material/slider/res/values/attrs.xml
@@ -69,8 +69,24 @@
     <attr name="tickRadiusActive" format="dimension" />
     <!-- The radius of the inactive tick. Only used when the slider is in discrete mode.-->
     <attr name="tickRadiusInactive" format="dimension" />
-    <!-- Whether to show the tick marks. Only used when the slider is in discrete mode. -->
+    <!-- Whether to show the tick marks. Only used when the slider is in discrete mode.
+         {@deprecated Use tickVisibilityMode instead.} -->
     <attr name="tickVisible" format="boolean" />
+    <!-- Mode to specify the visibility of tick marks. Only used when the slider is in
+         discrete mode. -->
+    <attr name="tickVisibilityMode" format="enum">
+      <!-- All tick marks will be drawn, even if they are spaced too densely. -->
+      <enum name="visibleAll" value="0" />
+      <!-- All tick marks will be drawn if they are not spaced too densely. Otherwise,
+           the maximum allowed number of tick marks will be drawn.
+           Note that in this case, the drawn ticks may not match the actual snap values. -->
+      <enum name="autoLimit" value="1" />
+      <!-- All tick marks will be drawn if they are not spaced too densely. Otherwise,
+           the tick marks will not be drawn. -->
+      <enum name="autoHide" value="2" />
+      <!-- Tick marks will not be drawn. -->
+      <enum name="hidden" value="3" />
+    </attr>
     <!-- The color of the track. -->
     <attr name="trackColor" />
     <!-- The color of active portion of the track. -->
diff --git a/lib/javatests/com/google/android/material/slider/SliderConfigTest.java b/lib/javatests/com/google/android/material/slider/SliderConfigTest.java
@@ -89,20 +89,20 @@ public static Iterable<Object[]> data() {
         new Object[] {
           /* valueFrom = */ 10f,
           /* valueTo = */ 3f,
-          /* stepValue = */ 2f,
+          /* stepValue = */ 0f,
           /* value = */ 10f,
           IllegalStateException.class,
         },
-        new Object[] {
-          /* valueFrom = */ 0f, /* valueTo = */ 1f, /* stepValue = */ 0, /* value = */ 0f, null,
-        },
         new Object[] {
           /* valueFrom = */ 10f,
           /* valueTo = */ 3f,
           /* stepValue = */ 2f,
           /* value = */ 10f,
           IllegalStateException.class,
         },
+        new Object[] {
+          /* valueFrom = */ 0f, /* valueTo = */ 1f, /* stepValue = */ 0, /* value = */ 0f, null,
+        },
         new Object[] {
           /* valueFrom = */ 0f,
           /* valueTo = */ 5f,
