Package net.pricefx.formulaengine.scripting.inputbuilder

Class CustomFormPopupInputBuilder

Object

AbstractInputBuilder<CustomFormPopupInputBuilder,Object>

CustomFormPopupInputBuilder

All Implemented Interfaces:

ValueChangeableInput<CustomFormPopupInputBuilder>

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

Builder class for input type CustomFormPopup: an "Open" button that opens a Custom Form in a pop-up dialog. Obtain it with InputBuilderFactory.createCustomFormPopup(String, String).

Since:

13.0 - Rampur

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

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
CustomFormPopupInputBuilder	withRecalculateParentOnPopupConfirm(boolean value)	Recalculates the parent document when a user confirms the pop-up dialog.

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

CustomFormPopupInputBuilder

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

Method Details

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<CustomFormPopupInputBuilder,Object>

withRecalculateParentOnPopupConfirm

public CustomFormPopupInputBuilder withRecalculateParentOnPopupConfirm(boolean value)

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

Example:

 if (api.isInputGenerationExecution()) {
      def typedId = api.find("CFO", Filter.equal("uniqueName", "CFO-123"))[0].typedId
      return api.inputBuilderFactory()
              .createCustomFormPopup("customFormPopup", typedId)
              .setLabel("Open 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:

self

Since:

13.0 - Rampur