Package net.pricefx.formulaengine.scripting.inputbuilder

Class CustomFormListPopupInputBuilder

Object

AbstractInputBuilder<CustomFormListPopupInputBuilder,Object>

CustomFormListPopupInputBuilder

public class CustomFormListPopupInputBuilder
extends AbstractInputBuilder<CustomFormListPopupInputBuilder,Object>

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

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
CustomFormListPopupInputBuilder	withRecalculateParentOnPopupConfirm(boolean value)	Recalculates the parent document when a user confirms the pop-up dialog.
CustomFormListPopupInputBuilder	withSubsetFilter(Filter filter)	Allows you to set a filter criteria to filter Custom Forms that will be visible in the pop-up modal.

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

CustomFormListPopupInputBuilder

public CustomFormListPopupInputBuilder(InputBuilderContext builderContext,
 String paramName,
 String typedId)

Method Details

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<CustomFormListPopupInputBuilder,Object>

withSubsetFilter

public CustomFormListPopupInputBuilder withSubsetFilter(Filter filter)

Allows you to set a filter criteria to filter Custom Forms that will be visible in the pop-up modal.

Example – displays only the Custom Form with the CFO-123 uniqueName:

 if (api.isInputGenerationExecution()) {
      return api.inputBuilderFactory()
              .createCustomFormListPopup("customFormPopup", "123.CFOT")
              .setLabel("Select a Custom Form")
              .withSubsetFilter(Filter.equal("uniqueName", "CFO-123"))
              .getInput()
  } else {
      input.customFormPopup
  }
 

Parameters:

filter - A filter setting using Filter.

Returns:

CustomFormListPopupInputBuilder

Since:

12.0 - Clover Club

withRecalculateParentOnPopupConfirm

public CustomFormListPopupInputBuilder withRecalculateParentOnPopupConfirm(boolean value)

Recalculates the parent document when a user confirms the pop-up dialog.

Example:

 if (api.isInputGenerationExecution()) {
      return api.inputBuilderFactory()
              .createCustomFormListPopup("customFormPopup", "123.CFOT")
              .setLabel("Select a Custom Form")
              .withRecalculateParentOnPopupConfirm(true)
              .getInput()
  } else {
      input.customFormPopup
  }
 

Parameters:

value - Set to true to recalculate the parent document when a user confirms the pop-up dialog. Default=false.

Returns:

Since:

12.0 - Clover Club