Skip to content

Commit 5984d88

Browse files
pubiqqpubiqq
committed
[Slider] Add new tick visibility modes
1 parent a2309ce commit 5984d88

File tree

7 files changed

+173
-26
lines changed

7 files changed

+173
-26
lines changed

‎catalog/java/io/material/catalog/slider/res/layout/cat_slider_demo_discrete.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163
android:valueFrom="0"
164164
android:valueTo="10"
165165
android:stepSize="1"
166-
app:tickVisible="false"/>
166+
app:tickVisibilityMode="hidden" />
167167
</LinearLayout>
168168

169169
<com.google.android.material.materialswitch.MaterialSwitch

‎docs/components/Slider.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ selections from a range of values.
1616

1717
**Contents**
1818

19-
* [Design & API Documentation](#design-api-documentation)
19+
* [Design & API Documentation](#design--api-documentation)
2020
* [Using sliders](#using-sliders)
2121
* [Continuous slider](#continuous-slider)
2222
* [Discrete slider](#discrete-slider)
@@ -348,12 +348,15 @@ Element | Attribute | Related method(s)
348348
| **Color for tick's inactive part** | `app:tickColorInactive` | `setTickInactiveTintList`<br/>`getTickInactiveTintList` | `?attr/colorPrimary` |
349349
| **Radius for tick's active part** | `app:tickRadiusActive` | `setTickActiveRadius`<br/>`getTickActiveRadius` | `1dp` |
350350
| **Radius for tick's inactive part** | `app:tickRadiusInactive` | `setTickInactiveRadius`<br/>`getTickInactiveRadius` | `1dp` |
351-
| **Tick visible** | `app:tickVisible` | `setTickVisible`<br/>`isTickVisible()` | `true` |
351+
| **Tick visible** (deprecated) | `app:tickVisible` | `setTickVisible`<br/>`isTickVisible()` | `true` |
352+
| **Tick visibility mode** | `app:tickVisibilityMode` | `setTickVisibilityMode`<br/>`getTickVisibilityMode()` | `autoLimit` |
352353

353354
**Note:** `app:tickColor` takes precedence over `app:tickColorActive` and
354-
`app:tickColorInative`. It's a shorthand for setting both values to the same
355+
`app:tickColorInactive`. It's a shorthand for setting both values to the same
355356
thing.
356357

358+
**Note:** `app:tickVisible` is deprecated in favor of `app:tickVisibilityMode`.
359+
357360
#### Styles
358361

359362
Element | Style

‎lib/java/com/google/android/material/slider/BaseSlider.java

Lines changed: 102 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
import static com.google.android.material.slider.LabelFormatter.LABEL_GONE;
2626
import static com.google.android.material.slider.LabelFormatter.LABEL_VISIBLE;
2727
import static com.google.android.material.slider.LabelFormatter.LABEL_WITHIN_BOUNDS;
28+
import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_AUTO_HIDE;
29+
import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_AUTO_LIMIT;
30+
import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_HIDDEN;
31+
import static com.google.android.material.slider.TickVisibilityMode.TICK_VISIBILITY_VISIBLE_ALL;
2832
import static com.google.android.material.theme.overlay.MaterialThemeOverlay.wrap;
2933
import static java.lang.Float.compare;
3034
import static java.lang.Math.abs;
@@ -151,8 +155,10 @@
151155
* discrete mode. This is a short hand for setting both the {@code tickColorActive} and {@code
152156
* tickColorInactive} to the same thing. This takes precedence over {@code tickColorActive}
153157
* and {@code tickColorInactive}.
154-
* <li>{@code tickVisible}: Whether to show the tick marks. Only used when the slider is in
155-
* discrete mode.
158+
* <li>{@code tickVisible} (deprecated, use {@code tickVisibilityMode} instead): Whether to show
159+
* the tick marks. Only used when the slider is in discrete mode.
160+
* <li>{@code tickVisibilityMode}: Mode to specify the visibility of tick marks. Only used when
161+
* the slider is in discrete mode.
156162
* <li>{@code trackColorActive}: The color of the active part of the track.
157163
* <li>{@code trackColorInactive}: The color of the inactive part of the track.
158164
* <li>{@code trackColor}: The color of the whole track. This is a short hand for setting both the
@@ -202,6 +208,7 @@
202208
* @attr ref com.google.android.material.R.styleable#Slider_tickColorActive
203209
* @attr ref com.google.android.material.R.styleable#Slider_tickColorInactive
204210
* @attr ref com.google.android.material.R.styleable#Slider_tickVisible
211+
* @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
205212
* @attr ref com.google.android.material.R.styleable#Slider_trackColor
206213
* @attr ref com.google.android.material.R.styleable#Slider_trackColorActive
207214
* @attr ref com.google.android.material.R.styleable#Slider_trackColorInactive
@@ -322,7 +329,7 @@ abstract class BaseSlider<
322329
private int focusedThumbIdx = -1;
323330
private float stepSize = 0.0f;
324331
private float[] ticksCoordinates;
325-
private boolean tickVisible = true;
332+
private int tickVisibilityMode;
326333
private int tickActiveRadius;
327334
private int tickInactiveRadius;
328335
private int trackWidth;
@@ -519,7 +526,10 @@ private void processAttributes(Context context, AttributeSet attrs, int defStyle
519526
? haloColor
520527
: AppCompatResources.getColorStateList(context, R.color.material_slider_halo_color));
521528

522-
tickVisible = a.getBoolean(R.styleable.Slider_tickVisible, true);
529+
tickVisibilityMode = a.hasValue(R.styleable.Slider_tickVisibilityMode)
530+
? a.getInt(R.styleable.Slider_tickVisibilityMode, -1)
531+
: convertToTickVisibilityMode(a.getBoolean(R.styleable.Slider_tickVisible, true));
532+
523533
boolean hasTickColor = a.hasValue(R.styleable.Slider_tickColor);
524534
int tickColorInactiveRes =
525535
hasTickColor ? R.styleable.Slider_tickColor : R.styleable.Slider_tickColorInactive;
@@ -1682,22 +1692,61 @@ public void setTickInactiveTintList(@NonNull ColorStateList tickColor) {
16821692
/**
16831693
* Returns whether the tick marks are visible. Only used when the slider is in discrete mode.
16841694
*
1685-
* @see #setTickVisible(boolean)
16861695
* @attr ref com.google.android.material.R.styleable#Slider_tickVisible
16871696
*/
16881697
public boolean isTickVisible() {
1689-
return tickVisible;
1698+
switch (tickVisibilityMode) {
1699+
case TICK_VISIBILITY_VISIBLE_ALL:
1700+
case TICK_VISIBILITY_AUTO_LIMIT:
1701+
return true;
1702+
case TICK_VISIBILITY_AUTO_HIDE:
1703+
return getDesiredTickCount() <= getMaxTickCount();
1704+
case TICK_VISIBILITY_HIDDEN:
1705+
return false;
1706+
default:
1707+
throw new RuntimeException("isTickVisible() is not implemented for tickVisibilityMode=" + tickVisibilityMode);
1708+
}
16901709
}
16911710

16921711
/**
16931712
* Sets whether the tick marks are visible. Only used when the slider is in discrete mode.
16941713
*
16951714
* @param tickVisible The visibility of tick marks.
16961715
* @attr ref com.google.android.material.R.styleable#Slider_tickVisible
1716+
* @deprecated Use {@link #setTickVisibilityMode(int)} instead.
16971717
*/
1718+
@Deprecated
16981719
public void setTickVisible(boolean tickVisible) {
1699-
if (this.tickVisible != tickVisible) {
1700-
this.tickVisible = tickVisible;
1720+
setTickVisibilityMode(convertToTickVisibilityMode(tickVisible));
1721+
}
1722+
1723+
@TickVisibilityMode
1724+
private int convertToTickVisibilityMode(boolean tickVisible) {
1725+
return tickVisible
1726+
? TICK_VISIBILITY_AUTO_LIMIT
1727+
: TICK_VISIBILITY_HIDDEN;
1728+
}
1729+
1730+
/**
1731+
* Returns the current tick visibility mode.
1732+
*
1733+
* @see #setTickVisibilityMode(int)
1734+
* @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
1735+
*/
1736+
@TickVisibilityMode
1737+
public int getTickVisibilityMode() {
1738+
return tickVisibilityMode;
1739+
}
1740+
1741+
/**
1742+
* Sets the tick visibility mode. Only used when the slider is in discrete mode.
1743+
*
1744+
* @see #getTickVisibilityMode()
1745+
* @attr ref com.google.android.material.R.styleable#Slider_tickVisibilityMode
1746+
*/
1747+
public void setTickVisibilityMode(@TickVisibilityMode int tickVisibilityMode) {
1748+
if (this.tickVisibilityMode != tickVisibilityMode) {
1749+
this.tickVisibilityMode = tickVisibilityMode;
17011750
postInvalidate();
17021751
}
17031752
}
@@ -1947,24 +1996,60 @@ protected void onSizeChanged(int w, int h, int oldw, int oldh) {
19471996
updateHaloHotspot();
19481997
}
19491998

1950-
private void maybeCalculateTicksCoordinates() {
1999+
private void updateTicksCoordinates() {
2000+
validateConfigurationIfDirty();
2001+
19512002
if (stepSize <= 0.0f) {
2003+
updateTicksCoordinates(/* tickCount= */ 0);
19522004
return;
19532005
}
19542006

1955-
validateConfigurationIfDirty();
2007+
final int tickCount;
2008+
switch (tickVisibilityMode) {
2009+
case TICK_VISIBILITY_VISIBLE_ALL:
2010+
tickCount = getDesiredTickCount();
2011+
break;
2012+
case TICK_VISIBILITY_AUTO_LIMIT:
2013+
tickCount = min(getDesiredTickCount(), getMaxTickCount());
2014+
break;
2015+
case TICK_VISIBILITY_AUTO_HIDE:
2016+
int desiredTickCount = getDesiredTickCount();
2017+
tickCount = desiredTickCount <= getMaxTickCount() ? desiredTickCount : 0;
2018+
break;
2019+
case TICK_VISIBILITY_HIDDEN:
2020+
tickCount = 0;
2021+
break;
2022+
default:
2023+
throw new RuntimeException("Calculation of tick coordinates is not implemented for tickVisibilityMode=" + tickVisibilityMode);
2024+
}
2025+
2026+
updateTicksCoordinates(tickCount);
2027+
}
2028+
2029+
private int getDesiredTickCount() {
2030+
return (int) ((valueTo - valueFrom) / stepSize + 1);
2031+
}
2032+
2033+
private int getMaxTickCount() {
2034+
return trackWidth / minTickSpacing + 1;
2035+
}
2036+
2037+
private void updateTicksCoordinates(int tickCount) {
2038+
if (tickCount == 0) {
2039+
ticksCoordinates = null;
2040+
return;
2041+
}
19562042

1957-
int tickCount = (int) ((valueTo - valueFrom) / stepSize + 1);
1958-
// Limit the tickCount if they will be too dense.
1959-
tickCount = min(tickCount, trackWidth / minTickSpacing + 1);
19602043
if (ticksCoordinates == null || ticksCoordinates.length != tickCount * 2) {
19612044
ticksCoordinates = new float[tickCount * 2];
19622045
}
19632046

19642047
float interval = trackWidth / (float) (tickCount - 1);
2048+
float trackCenterY = calculateTrackCenter();
2049+
19652050
for (int i = 0; i < tickCount * 2; i += 2) {
19662051
ticksCoordinates[i] = trackSidePadding + i / 2f * interval;
1967-
ticksCoordinates[i + 1] = calculateTrackCenter();
2052+
ticksCoordinates[i + 1] = trackCenterY;
19682053
}
19692054
}
19702055

@@ -1973,7 +2058,7 @@ private void updateTrackWidth(int width) {
19732058
trackWidth = max(width - trackSidePadding * 2, 0);
19742059

19752060
// Update the visible tick coordinates.
1976-
maybeCalculateTicksCoordinates();
2061+
updateTicksCoordinates();
19772062
}
19782063

19792064
private void updateHaloHotspot() {
@@ -2002,7 +2087,7 @@ protected void onDraw(@NonNull Canvas canvas) {
20022087
validateConfigurationIfDirty();
20032088

20042089
// Update the visible tick coordinates.
2005-
maybeCalculateTicksCoordinates();
2090+
updateTicksCoordinates();
20062091
}
20072092

20082093
super.onDraw(canvas);
@@ -2213,7 +2298,7 @@ private void addRoundedCorners(
22132298
}
22142299

22152300
private void maybeDrawTicks(@NonNull Canvas canvas) {
2216-
if (!tickVisible || stepSize <= 0.0f) {
2301+
if (ticksCoordinates == null || ticksCoordinates.length == 0) {
22172302
return;
22182303
}
22192304

‎lib/java/com/google/android/material/slider/TickVisibilityMode.java

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package com.google.android.material.slider;
2+
3+
import androidx.annotation.IntDef;
4+
5+
import java.lang.annotation.Retention;
6+
import java.lang.annotation.RetentionPolicy;
7+
8+
/**
9+
* Mode to specify the visibility of tick marks.
10+
*/
11+
@IntDef({
12+
TickVisibilityMode.TICK_VISIBILITY_VISIBLE_ALL,
13+
TickVisibilityMode.TICK_VISIBILITY_AUTO_LIMIT,
14+
TickVisibilityMode.TICK_VISIBILITY_AUTO_HIDE,
15+
TickVisibilityMode.TICK_VISIBILITY_HIDDEN
16+
})
17+
@Retention(RetentionPolicy.SOURCE)
18+
public @interface TickVisibilityMode {
19+
20+
/**
21+
* All tick marks will be drawn, even if they are spaced too densely.
22+
*/
23+
int TICK_VISIBILITY_VISIBLE_ALL = 0;
24+
25+
/**
26+
* All tick marks will be drawn if they are not spaced too densely. Otherwise, the maximum
27+
* allowed number of tick marks will be drawn.
28+
* Note that in this case, the drawn ticks may not match the actual snap values.
29+
*/
30+
int TICK_VISIBILITY_AUTO_LIMIT = 1;
31+
32+
/**
33+
* All tick marks will be drawn if they are not spaced too densely. Otherwise, the tick marks
34+
* will not be drawn.
35+
*/
36+
int TICK_VISIBILITY_AUTO_HIDE = 2;
37+
38+
/**
39+
* Tick marks will not be drawn.
40+
*/
41+
int TICK_VISIBILITY_HIDDEN = 3;
42+
}

‎lib/java/com/google/android/material/slider/res-public/values/public.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
<public name="tickRadiusActive" type="attr" />
3636
<public name="tickRadiusInactive" type="attr" />
3737
<public name="tickVisible" type="attr" />
38+
<public name="tickVisibilityMode" type="attr" />
3839
<public name="trackColorActive" type="attr" />
3940
<public name="trackColorInactive" type="attr" />
4041
<public name="trackHeight" type="attr" />

‎lib/java/com/google/android/material/slider/res/values/attrs.xml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,24 @@
6969
<attr name="tickRadiusActive" format="dimension" />
7070
<!-- The radius of the inactive tick. Only used when the slider is in discrete mode.-->
7171
<attr name="tickRadiusInactive" format="dimension" />
72-
<!-- Whether to show the tick marks. Only used when the slider is in discrete mode. -->
72+
<!-- Whether to show the tick marks. Only used when the slider is in discrete mode.
73+
{@deprecated Use tickVisibilityMode instead.} -->
7374
<attr name="tickVisible" format="boolean" />
75+
<!-- Mode to specify the visibility of tick marks. Only used when the slider is in
76+
discrete mode. -->
77+
<attr name="tickVisibilityMode" format="enum">
78+
<!-- All tick marks will be drawn, even if they are spaced too densely. -->
79+
<enum name="visibleAll" value="0" />
80+
<!-- All tick marks will be drawn if they are not spaced too densely. Otherwise,
81+
the maximum allowed number of tick marks will be drawn.
82+
Note that in this case, the drawn ticks may not match the actual snap values. -->
83+
<enum name="autoLimit" value="1" />
84+
<!-- All tick marks will be drawn if they are not spaced too densely. Otherwise,
85+
the tick marks will not be drawn. -->
86+
<enum name="autoHide" value="2" />
87+
<!-- Tick marks will not be drawn. -->
88+
<enum name="hidden" value="3" />
89+
</attr>
7490
<!-- The color of the track. -->
7591
<attr name="trackColor" />
7692
<!-- The color of active portion of the track. -->

‎lib/javatests/com/google/android/material/slider/SliderConfigTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,20 @@ public static Iterable<Object[]> data() {
8989
new Object[] {
9090
/* valueFrom = */ 10f,
9191
/* valueTo = */ 3f,
92-
/* stepValue = */ 2f,
92+
/* stepValue = */ 0f,
9393
/* value = */ 10f,
9494
IllegalStateException.class,
9595
},
96-
new Object[] {
97-
/* valueFrom = */ 0f, /* valueTo = */ 1f, /* stepValue = */ 0, /* value = */ 0f, null,
98-
},
9996
new Object[] {
10097
/* valueFrom = */ 10f,
10198
/* valueTo = */ 3f,
10299
/* stepValue = */ 2f,
103100
/* value = */ 10f,
104101
IllegalStateException.class,
105102
},
103+
new Object[] {
104+
/* valueFrom = */ 0f, /* valueTo = */ 1f, /* stepValue = */ 0, /* value = */ 0f, null,
105+
},
106106
new Object[] {
107107
/* valueFrom = */ 0f,
108108
/* valueTo = */ 5f,

0 commit comments

Comments
 (0)