Package net.pricefx.formulaengine.scripting.inputbuilder

Class TreeInputBuilder

Object

AbstractInputBuilder<TreeInputBuilder,Object>

TreeInputBuilder

All Implemented Interfaces:

ValueChangeableInput<TreeInputBuilder>

public class TreeInputBuilder
extends AbstractInputBuilder<TreeInputBuilder,Object>
implements ValueChangeableInput<TreeInputBuilder>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TreeInputBuilder.CheckedStrategy
static final record	TreeInputBuilder.Mapper

Nested classes/interfaces inherited from class AbstractInputBuilder

AbstractInputBuilder.InputWidth

Field Summary

Fields inherited from class AbstractInputBuilder

builderContext, cp

Constructor Summary

Constructors

Constructor	Description
TreeInputBuilder(InputBuilderContext builderContext, String paramName)

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
TreeInputBuilder	setCheckedStrategy(TreeInputBuilder.CheckedStrategy strategy)	Sets the checkedStrategy key for the TreeInputBuilder instance.
TreeInputBuilder	setMultiple(boolean isMultiple)	Sets the multiple key for the TreeInputBuilder instance.
TreeInputBuilder	setTree(List<Map<String,Object>> tree)	Adds data set in the predefined structure to the TreeInputBuilder instance.

Methods inherited from class AbstractInputBuilder

addOrUpdateInput, addToConfiguratorEntry, addToConfiguratorEntry, addToFormLayout, buildContextParameter, buildFormInput, buildMap, getInput, registerFrontendEvent, 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

Methods inherited from interface ValueChangeableInput

onValueChange, onValueChange, onValueChange

Constructor Details

TreeInputBuilder

public TreeInputBuilder(InputBuilderContext builderContext,
 String paramName)

Method Details

setTree

public TreeInputBuilder setTree(List<Map<String,Object>> tree)

Adds data set in the predefined structure to the TreeInputBuilder instance.

The data set needs to be in the proper structure (title/value/children), otherwise the InputBuilderExceptions.IllegalDataStructureException is thrown.

The title and value keys are mandatory. The children key is optional, but when present, needs to be null, empty collection or contains title and value.

Example:

   // data set where 'title' and 'value' keys are mandatory and 'children' is optional
   // (can be null, empty collection or title/value/children structure)
   // values for 'value' key needs to be unique across all data set
   def data = [[title   : 'Cars',
                value   : '[Cars]',
                children: [[title: 'Bugatti', value: '[Cars, Bugatti]']]],
               [title   : 'Bikes',
                value   : '[Bikes]',
                children: [[title: 'Bugatti', value: '[Bikes, Bugatti]']]]]

   if(api.isInputGenerationExecution()) {
      return api.inputBuilderFactory()
                  .createTreeEntry('hierarchicalFilter')
                  .setTree(data)
                  .getInput()
   }

   return input.hierarchicalFilter
 

Parameters:

tree - List of Map with the data in predefined structure, where 'title' and 'value' keys are mandatory and 'children' is optional (can be null, empty collection or title/value/children structure)

Returns:

self

Since:

15.0 - Southside

See Also:

• PublicGroovyAPI.hierarchicalFilteringDataAdjustment(List, boolean)

setMultiple

public TreeInputBuilder setMultiple(boolean isMultiple)

Sets the multiple key for the TreeInputBuilder instance.

Default value is false.

Example:

  return api.inputBuilderFactory()
              .createTreeEntry('hierarchicalFilter')
              .setTree(someData)
              .setMultiple(true)
              .getInput()
 

Parameters:

isMultiple - The multiple flag, default value is false.

Returns:

self

Since:

15.0 - Southside

setCheckedStrategy

public TreeInputBuilder setCheckedStrategy(TreeInputBuilder.CheckedStrategy strategy)

Sets the checkedStrategy key for the TreeInputBuilder instance.

Default value is TreeInputBuilder.CheckedStrategy.PARENT.

Example:

  // the import or static import is required for the CheckedStrategy enum
  import net.pricefx.formulaengine.scripting.inputbuilder.TreeInputBuilder.CheckedStrategy

  return api.inputBuilderFactory()
              .createTreeEntry('hierarchicalFilter')
              .setTree(someData)
              .setCheckedStrategy(CheckedStrategy.CHILD)
              .getInput()
 

Parameters:

strategy - The checkedStrategy value, default value is TreeInputBuilder.CheckedStrategy.PARENT.

Returns:

self

Since:

15.0 - Southside

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<TreeInputBuilder,Object>