io.jmix.ui.component

Interface Slider<V extends java.lang.Number>

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Field<V>, HasContextHelp, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasOrientation, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, Validatable

All Known Implementing Classes:

SliderImpl

@StudioComponent(caption="Slider",
                 category="Components",
                 xmlElement="slider",
                 canvasBehaviour=SLIDER,
                 icon="io/jmix/ui/icon/component/slider.svg",
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/slider.html")
public interface Slider<V extends java.lang.Number>
extends Field<V>, HasDatatype<V>, HasOrientation

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasOrientation

HasOrientation.Orientation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
V	getMax()
V	getMin()
int	getResolution()
boolean	isUpdateValueOnCLick()
void	setMax(V max) Sets the maximum value of the slider.
void	setMin(V min) Sets the minimum value of the slider.
void	setResolution(int resolution) Sets the number of digits after the decimal point.
void	setUpdateValueOnClick(boolean updateValueOnClick) Sets the slider to update its value when the user clicks on it.

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.HasDatatype

getDatatype, setDatatype

Methods inherited from interface io.jmix.ui.component.HasOrientation

getOrientation, setOrientation

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setMin

@StudioProperty(type=DOUBLE,
                defaultValue="0")
void setMin(V min)

Sets the minimum value of the slider.

Parameters:

min - the minimum value of the slider

getMin

V getMin()

Returns:

the minimum value of the slider

setMax

@StudioProperty(type=DOUBLE,
                defaultValue="100")
void setMax(V max)

Sets the maximum value of the slider.

Parameters:

max - the maximum value of the slider

getMax

V getMax()

Returns:

the maximum value of the slider

setResolution

@StudioProperty(defaultValue="0")
void setResolution(int resolution)

Sets the number of digits after the decimal point.

Parameters:

resolution - the number of digits after the decimal point

getResolution

int getResolution()

Returns:

resolution the number of digits after the decimal point

setUpdateValueOnClick

@StudioProperty(defaultValue="false")
void setUpdateValueOnClick(boolean updateValueOnClick)

Sets the slider to update its value when the user clicks on it.

By default this behavior is disabled.

Parameters:

updateValueOnClick - true to update the value of the slider on click

isUpdateValueOnCLick

boolean isUpdateValueOnCLick()

Returns:

true if the slider updates its value on click