Package net.pricefx.formulaengine.scripting.inputbuilder

Class ButtonInputBuilder<VT>

Object

AbstractInputBuilder<ButtonInputBuilder,VT>

ButtonInputBuilder<VT>

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

Builder class for input type Button InputType.BUTTON

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

Method Summary

Modifier and Type	Method	Description
protected Object	_getInput()
ButtonInputBuilder	setTargetPage(String targetPage)	Opens the target location (AppPage).
ButtonInputBuilder	setTargetPageComponent(String targetPageComponent)	Not available yet.
ButtonInputBuilder	setTargetPageState(String targetPageState)	Opens the particular object detail in the specified location.
ButtonInputBuilder	setUrl(String url)	Opens the target URL in a new tab when a user clicks the button.

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

ButtonInputBuilder

protected ButtonInputBuilder(InputBuilderContext builderContext,
 String paramName)

Method Details

setUrl

public ButtonInputBuilder setUrl(String url)

Opens the target URL in a new tab when a user clicks the button. Available for Configurator only.
Example:

 def ce = api.createConfiguratorEntry()
 def builder = api.inputBuilderFactory()
          .createButtonEntry("Button")
          .setUrl("/app/modules/#/md/products")
          .buildContextParameter()

 return ce.createParameter(builder)
 

Parameters:

url - The URL address.

Returns:

self

Since:

5.1 - Collins

setTargetPage

public ButtonInputBuilder setTargetPage(String targetPage)

Opens the target location (AppPage). For example, AppPages.MD_PRODUCTS_PAGE redirects the user to the Master Data - Products page. Available for Configurator only.
Example:

 def ce = api.createConfiguratorEntry()
 def builder = api.inputBuilderFactory()
      .createButtonEntry("Button")
      .setTargetPage(AppPages.DB_DASHBOARDS_PAGE)
      .buildContextParameter()

 return ce.createParameter(builder)
 

Parameters:

targetPage - Name of the target page (AppPage). The list of available AppPages.

Returns:

self

See Also:

• Deep Linking

setTargetPageState

public ButtonInputBuilder setTargetPageState(String targetPageState)

Opens the particular object detail in the specified location. Available for Configurator only.
Example – opens the "BasicBarLineChart" within the Dashboards page:

 def ce = api.createConfiguratorEntry()
 def builder = api.inputBuilderFactory()
      .createButtonEntry("Button")
      .setTargetPage(AppPages.DB_DASHBOARDS_PAGE)
      .setTargetPageState("BasicBarLineChart")
      .buildContextParameter()

 return ce.createParameter(builder)
 

Parameters:

targetPageState - ID, typedId, or uniqueName of the target page. See How to Specify RelayState Parameter for the list of available targetPageState values.

Returns:

self

See Also:

• Deep Linking

setTargetPageComponent

public ButtonInputBuilder setTargetPageComponent(String targetPageComponent)

Not available yet.

Parameters:

targetPageComponent - target page component

Returns:

self

_getInput

protected Object _getInput()

Specified by:

_getInput in class AbstractInputBuilder<ButtonInputBuilder,VT>