Interface IRangesliderBase<I extends IRangesliderBase>
-
- All Superinterfaces:
IAnyGroup<I>
,IComponent<I>
,IDisable<I>
,IHtmlBasedComponent<I>
,ISingleChildable<I,ISliderbuttons>
,IXulElement<I>
- All Known Subinterfaces:
IMultislider
,IRangeslider
public interface IRangesliderBase<I extends IRangesliderBase> extends IXulElement<I>, IDisable<I>, IAnyGroup<I>, ISingleChildable<I,ISliderbuttons>
ImmutableRangeslider
base component- Author:
- katherine
- See Also:
Rangeslider
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IRangesliderBase.Orient
Specifies the orient ofIRangesliderBase
component
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.util.Map<java.lang.Integer,java.lang.String>
getMarks()
Returns the marks information map of the component.default int
getMarkScale()
Returns mark scale of the component.default int
getMax()
Returns the maximum value of the component.default int
getMin()
Returns the minimum value of the component.default java.lang.String
getOrient()
Returns the orient.default int
getStep()
Returns the step of the component.default boolean
isTooltipVisible()
Returns whether it is tooltip visible.I
withMarks(java.util.Map<java.lang.Integer,? extends java.lang.String> marks)
Returns a copy ofthis
immutable component with the specifiedmarks
.I
withMarkScale(int markScale)
Returns a copy ofthis
immutable component with the specifiedmarkScale
.I
withMax(int max)
Returns a copy ofthis
immutable component with the specifiedmax
.I
withMin(int min)
Returns a copy ofthis
immutable component with the specifiedmin
.I
withOrient(java.lang.String orient)
Returns a copy ofthis
immutable component with the specifiedorient
.default I
withOrient(IRangesliderBase.Orient orient)
Returns a copy ofthis
immutable component with the specifiedorient
.I
withStep(int step)
Returns a copy ofthis
immutable component with the specifiedstep
.I
withTooltipVisible(boolean tooltipVisible)
Returns a copy ofthis
immutable component with the specifiedtooltipVisible
.-
Methods inherited from interface org.zkoss.stateless.sul.IComponent
getAction, getActions, getClientAttributes, getId, getMold, getWidgetClass, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides
-
Methods inherited from interface org.zkoss.stateless.sul.IDisable
isDisabled, withDisabled
-
Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent
getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex
-
Methods inherited from interface org.zkoss.stateless.sul.ISingleChildable
getChild, withChild
-
Methods inherited from interface org.zkoss.stateless.sul.IXulElement
getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip
-
-
-
-
Method Detail
-
getMarks
@Nullable java.util.Map<java.lang.Integer,java.lang.String> getMarks()
Returns the marks information map of the component. Refer towithMarks(java.util.Map<java.lang.Integer, ? extends java.lang.String>)
for more details.
-
withMarks
I withMarks(java.util.Map<java.lang.Integer,? extends java.lang.String> marks)
Returns a copy ofthis
immutable component with the specifiedmarks
.Sets the marks information map for displaying value marks. In this map, the key represents the number value of slider, and the value represents the displayed scale text.
- Parameters:
marks
- The value marks displaying informationDefault:
null
.- Returns:
- A modified copy of the
this
object
-
getMin
default int getMin()
Returns the minimum value of the component.Default:
0
.
-
withMin
I withMin(int min)
Returns a copy ofthis
immutable component with the specifiedmin
.Sets the minimum value of the component.
- Parameters:
min
- The minimum value of the component.Default:
0
.- Returns:
- A modified copy of the
this
object
-
getMax
default int getMax()
Returns the maximum value of the component.Default:
100
.
-
withMax
I withMax(int max)
Returns a copy ofthis
immutable component with the specifiedmax
.Sets the maximum value of the component.
- Parameters:
max
- The maximum value of the component.Default:
100
.- Returns:
- A modified copy of the
this
object
-
getStep
default int getStep()
Returns the step of the component. When the user drags the slider buttons, the buttons would increase/decrease value by the step count.Default:
1
-
withStep
I withStep(int step)
Returns a copy ofthis
immutable component with the specifiedstep
.Sets the step of component
- Parameters:
step
- The step of the slider.Default:
1
.- Returns:
- A modified copy of the
this
object
-
getOrient
default java.lang.String getOrient()
Returns the orient.Default:
"horizontal"
.
-
withOrient
I withOrient(java.lang.String orient)
Returns a copy ofthis
immutable component with the specifiedorient
.Sets the orient of component
- Parameters:
orient
- Either"horizontal"
or"vertical"
Default:
"horizontal"
.- Returns:
- A modified copy of the
this
object
-
withOrient
default I withOrient(IRangesliderBase.Orient orient)
Returns a copy ofthis
immutable component with the specifiedorient
.Sets the orient of component
- Parameters:
orient
- Theorient
Default:
"horizontal"
.- Returns:
- A modified copy of the
this
object
-
isTooltipVisible
default boolean isTooltipVisible()
Returns whether it is tooltip visible. If true, the tooltips of the slider buttons would be always visible.Default:
false
.
-
withTooltipVisible
I withTooltipVisible(boolean tooltipVisible)
Returns a copy ofthis
immutable component with the specifiedtooltipVisible
.Sets whether it is tooltip visible.
- Parameters:
tooltipVisible
- Whether it is tooltip visible.Default:
false
.- Returns:
- A modified copy of the
this
object
-
getMarkScale
default int getMarkScale()
Returns mark scale of the component. Refer towithMarkScale(int)
for more details.Default:
20
-
withMarkScale
I withMarkScale(int markScale)
Returns a copy ofthis
immutable component with the specifiedmarkScale
.Sets the mark scale for displaying value marks.
The value marks would be displayed every number value (ex. 20) start from the minimum value. (if min is 0, then display "0 20 40 ...")
Notice that it's not allowed to use
markScale
andmarks
at the same time.- Parameters:
markScale
- The value marks displaying scaleDefault:
20
.- Returns:
- A modified copy of the
this
object
-
-