Package net.pricefx.formulaengine.scripting.inputbuilder

Class OptionInputBuilder

Object

AbstractInputBuilder<OptionInputBuilder,Object>

OptionInputBuilder

public class OptionInputBuilder
extends AbstractInputBuilder<OptionInputBuilder,Object>

Builder class for input type Option and Options (InputType.OPTION and InputType.OPTIONS).

Nested Class Summary

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Constructor	Description
OptionInputBuilder(InputBuilderContext builderContext, InputType type, String paramName)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
OptionInputBuilder	addOption(String option)	Adds the option to the OptionInputBuilder instance.
OptionInputBuilder	setLabels(Map<String,Object> labels)	Sets labels of the OptionInputBuilder instance.
OptionInputBuilder	setOptions(List<String> options)	Adds options to the OptionInputBuilder instance.

Methods inherited from class AbstractInputBuilder

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

Methods inherited from class Object

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

Constructor Details

OptionInputBuilder

public OptionInputBuilder(InputBuilderContext builderContext,
 InputType type,
 String paramName)

Method Details

setOptions

public OptionInputBuilder setOptions(List<String> options)

Adds options to the OptionInputBuilder instance.

Example:

 Map driverClasses = ...

 optionInputBuilder.addOptions(driverClasses?.driverClassLabel as List)
 

Parameters:

options - List of options names

Returns:

self

addOption

public OptionInputBuilder addOption(String option)

Adds the option to the OptionInputBuilder instance.

Example:

 Map driverClasses = ...

 driverClasses.each { String driverClassName, String driverClassLabel ->
      optionInputBuilder.addOption(driverClassLabel)
 }
 

Parameters:

option - option name

Returns:

self

setLabels

public OptionInputBuilder setLabels(Map<String,Object> labels)

Sets labels of the OptionInputBuilder instance.

Example:

 OptionInputBuilder builder = api.inputBuilderFactory()
                                 .createRadioEntry(inputName)
                                 .setLabels([model : "Services Model",
                                             type  : "Service Type"])
                                 .setValue(inputValue)
 

Parameters:

labels - Map of labs to be set

Returns:

self

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<OptionInputBuilder,Object>