Nonrequired Elements

For parameter forms, you can use nonrequired and required elements.

Table 92. Nonrequired Elements

Elements

Function

getEmbedParameterValidationRoutines()

Adds the JavaScript parameter validation routines to the form

isFormUsesParameterValidationCond()

Returns true if the current job requires JavaScript validation routines

isParameterValidationCond()

Tests the current parameter for a validation function

isParameterValidationMaskCond()

Returns true if a mask is associated with the validation function of the current parameter

resetParameterPickList()

Initializes the static or dynamic choice options of the current parameter and prints an error message if initialization fails

isParameterMultiValuesCond()

Returns true if the parameter accepts multiple values

see getParameterType()

Returns the current parameter type number:

Text edit = 0

Drop-down list = 1

Radio button = 2

List box = 3

getParameterType()

Returns the current parameter type number:

Text edit = 0

Drop-down list = 1

Radio button = 2

List box = 3

getParameterListPublisherDefaultsFieldName()

Returns the name of the HTML form field used for the Publisher Defaults parameter list

processParameterPickListLoop() 

Iterates through a parameter pick list values.

getPickListParameterValue()

Used within a loop construct for processParameterPickListLoop()

Returns the next value in a parameter pick list;

getParameterPickListValueSelected(String presentationType)

Must be used within a Java loop construct. Returns "selected" if the next value in the pick list is the current value for the parameter;

Note:

You can set presentationType to "select" or "check." For a pick list for a parameter with only a few values, you can use buttons to display the options. In this case, setting the presentationType to "check" returns "checked." You can use this option to indicate which option is the current value for the parameter

getParameterValidationMask()

Returns the mask associated with the current parameter of the validation function

getParameterValidationName()

Returns the name of the current parameter of the validation function

getPublisherDefaultsParameterValue()

Returns the value of the current parameter in the Publisher Defaults parameter list

isRequiredParameterCond()

Returns true if the current parameter is required

getSaveDefaultsCheckboxFieldName()

Returns the name of the HTML form field that represents the “save default” box

isShowFormsParameterListCond()

Determines whether to display parameter lists

isShowFormsSaveMyDefaultsCond()

Determines whether the publisher selected “save as my defaults”

isShowParameterListPublisherDefaultsCond()

Returns true if the job is configured to display Publisher Defaults