Package net.pricefx.formulaengine.scripting.inputbuilder

Class StringInputBuilder<VT>

Object

AbstractInputBuilder<StringInputBuilder,VT>

StringInputBuilder<VT>

public class StringInputBuilder<VT>
extends AbstractInputBuilder<StringInputBuilder,VT>

Builder class for input type StringUserEntry InputType.STRINGUSERENTRY.

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	StringInputBuilder(InputBuilderContext builderContext, String paramName)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
StringInputBuilder	setMaxLength(Integer maxLength)	Sets the maximum amount of alphanumerics to be accepted by StringUserEntry.
StringInputBuilder	setMinLength(Integer minLength)	Sets the minimum amount of alphanumerics to be accepted by StringUserEntry.
StringInputBuilder	setTextMask(String textMask)	Sets text mask on ContextParameter, used in the dropdown input field.

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, setNoRefresh, setParameterGroup, setPlaceholderText, setPreviousValueTracking, setReadOnly, setRequired, setShowInline, setSize, setSuccessMessage, setTheme, setTitle, setTrackedValue, setUserGroupEdit, setUserGroupEdit, setUserGroupView, setValue, setValueChangeTracking, setValueHint, setWarningMessage, setWidth

Methods inherited from class Object

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

Constructor Details

StringInputBuilder

protected StringInputBuilder(InputBuilderContext builderContext,
 String paramName)

Method Details

setTextMask

public StringInputBuilder setTextMask(String textMask)

Sets text mask on ContextParameter, used in the dropdown input field.

Example:

 api.inputBuilderFactory()
      .createStringUserEntry("StringEntry")
      .setTextMask("Enter string value ...")
      .setLabel("A string entry without refresh")
      .setNoRefresh(true)
      .buildContextParameter()
 

Parameters:

textMask - text mask

Returns:

self

setMaxLength

public StringInputBuilder setMaxLength(Integer maxLength)

Sets the maximum amount of alphanumerics to be accepted by StringUserEntry. Max value needs to be positive number and higher or equal to min value (sets by setMinLength(Integer)) If the conditions are not met the InputBuilderExceptions.InvalidValueException will be thrown.

Example:

 // The input will accept the maximum of 4 alphanumerics, no more
 api.inputBuilderFactory()
      .createStringUserEntry("StringEntry")
      .setMaxLength(4)
      .buildContextParameter()
 

Parameters:

maxLength - maximum amount of alphanumerics

Returns:

StringInputBuilder with the updated PriceFxInterface.CONTEXTPARAM_CONFIG_MAX_LENGTH

Since:

14.0 - Caribou Lou

See Also:

• setMinLength(Integer)

setMinLength

public StringInputBuilder setMinLength(Integer minLength)

Sets the minimum amount of alphanumerics to be accepted by StringUserEntry. Min value needs to be positive number or zero and lower or equal to max value (sets by setMaxLength(Integer)) If the conditions are not met the InputBuilderExceptions.InvalidValueException will be thrown.

Example:

 // The input will accept at least 2 alphanumerics, no less
 api.inputBuilderFactory()
      .createStringUserEntry("StringEntry")
      .setMinLength(2)
      .buildContextParameter()
 

Parameters:

minLength - minimum amount of alphanumerics

Returns:

StringInputBuilder with the updated PriceFxInterface.CONTEXTPARAM_CONFIG_MIN_LENGTH

Since:

14.0 - Caribou Lou

See Also:

• setMaxLength(Integer)

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<StringInputBuilder,VT>