Package net.pricefx.formulaengine.scripting.inputbuilder

Class SliderInputBuilder

Object

AbstractInputBuilder<SliderInputBuilder,BigDecimal>

AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

SliderInputBuilder

public class SliderInputBuilder
extends AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Builder class for input type Slider InputType.SLIDER.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SliderInputBuilder(InputBuilderContext builderContext, String paramName)

Method Summary

Modifier and Type	Method	Description
SliderInputBuilder	hideTrack(boolean hideTrack)	Shows or hide the range/slider track (colored bar from lower bound to the cursor materializing the selected value).
SliderInputBuilder	setColour(List<String> colours)	Sets the colours of the range slider (needs to be two elements collection, if not the InputBuilderExceptions.ColourSectionsNumberException will be thrown). List of possible values: informative (blue) negative (red) negative-strong (super red) positive (green) positive-strong (super green) warning (yellow) neutral (gray) accent (current accent color from settings) inverted (dark color for white theme, light color for dark theme) Example:
SliderInputBuilder	setFrom(BigDecimal from)	Sets the lower bound of the slider range.
SliderInputBuilder	setStep(BigDecimal step)	Sets the range/slider step.
SliderInputBuilder	setSubLabels(String left, String right)	Sets the sub labels displayed respectively on the left and the right of the slider.
SliderInputBuilder	setTo(BigDecimal to)	Sets the upper bound of the slider range.

Methods inherited from class AbstractSliderBuilder

_getInput

Methods inherited from class AbstractInputBuilder

addOrUpdateInput, addToConfiguratorEntry, addToConfiguratorEntry, buildContextParameter, buildMap, getInput, self, setAccessCode, setAlign, setAllValueTypesTracking, setAlwaysEditable, setAppearance, setAutoComplete, setAutoFocus, setCaption, setConfigValues, setCustomAttributeName, setCustomAttributeValue, setDefaultValueTracking, setDefaultWidth, setDisabled, setDisplayMode, setErrorMessage, setExportable, setFirstRunTracking, setFlex, setHelpLink, setHelpText, setIcon, setIconPosition, setImportable, setLabel, setLabelPlacement, setLabelStyle, setLabelTranslations, setLayoutGridName, setLogActivity, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setShowInline, setSize, setStoreAuditTrail, setSuccessMessage, setTab, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SliderInputBuilder

protected SliderInputBuilder(InputBuilderContext builderContext,
 String paramName)

Method Details

setColour

public SliderInputBuilder setColour(List<String> colours)

Sets the colours of the range slider (needs to be two elements collection, if not the InputBuilderExceptions.ColourSectionsNumberException will be thrown).
List of possible values:

• informative (blue)
• negative (red)
• negative-strong (super red)
• positive (green)
• positive-strong (super green)
• warning (yellow)
• neutral (gray)
• accent (current accent color from settings)
• inverted (dark color for white theme, light color for dark theme)

Example:

 def slider = api.inputBuilderFactory()
     .createRangeSliderEntry("myRangeSlider")
     .setColour(['neutral', 'accent'])
     .buildContextParameter();
 

The range slider entry is rendered with colours:

Specified by:

setColour in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

colours - of the slider.

Returns:

self

Since:

15.0 Southside

hideTrack

public SliderInputBuilder hideTrack(boolean hideTrack)

Description copied from class: net.pricefx.formulaengine.scripting.inputbuilder.AbstractSliderBuilder

Shows or hide the range/slider track (colored bar from lower bound to the cursor materializing the selected value).

Overrides:

hideTrack in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

hideTrack - true to hide the track, false to display the track.

Returns:

self

setFrom

public SliderInputBuilder setFrom(BigDecimal from)

Description copied from class: net.pricefx.formulaengine.scripting.inputbuilder.AbstractSliderBuilder

Sets the lower bound of the slider range.

Overrides:

setFrom in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

from - the lower bound of the slider range.

Returns:

self

setStep

public SliderInputBuilder setStep(BigDecimal step)

Description copied from class: net.pricefx.formulaengine.scripting.inputbuilder.AbstractSliderBuilder

Sets the range/slider step.

Overrides:

setStep in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

step - the range/slider step.

Returns:

self

setSubLabels

public SliderInputBuilder setSubLabels(String left,
 String right)

Description copied from class: net.pricefx.formulaengine.scripting.inputbuilder.AbstractSliderBuilder

Sets the sub labels displayed respectively on the left and the right of the slider.

Overrides:

setSubLabels in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

left - left sub label.

right - right sub label.

Returns:

self

setTo

public SliderInputBuilder setTo(BigDecimal to)

Description copied from class: net.pricefx.formulaengine.scripting.inputbuilder.AbstractSliderBuilder

Sets the upper bound of the slider range.

Overrides:

setTo in class AbstractSliderBuilder<SliderInputBuilder,BigDecimal>

Parameters:

to - the upper bound of the slider range.

Returns:

self