Class actuate.parameter.ParameterDefinition
Contains all of the qualities, values, names, and conditions for a parameter. A ParameterDefinition
object can display options to the user and respond to user-generated events. The actuate.Parameter
class downloads an array of ParameterDefinition objects with actuate.Parameter#downloadParameters.
The order of this array is also the order in which the parameters are displayed. Parameters can be grouped
to divide the parameters on the page into logical sets under a heading.
This class requires significant memory and bandwidth resources. ParameterValue is much
smaller than ParameterDefinition. actuate.parameter.ParameterValue is the more efficient way
to communicate to the server that a parameter value has changed.
Member of: actuate.parameter.
Constructor Attributes | Constructor Name and Description |
---|---|
Constructs an object containing all of the qualities, values, names, and conditions for a parameter.
|
Method Attributes | Method Name and Description |
---|---|
Gets the autosuggest threshold value for this ParameterDefinition.
|
|
Gets the cascadingParentName value for this ParameterDefinition.
|
|
Gets the columnName value for this ParameterDefinition.
|
|
Gets the columnType value for this ParameterDefinition.
|
|
Gets the controlType value for this ParameterDefinition.
|
|
Gets the current display name for this ParameterDefinition.
|
|
Gets the dataType value for this ParameterDefinition.
|
|
Gets the defaultValue value for this ParameterDefinition, if applicable.
|
|
Returns true when the parameter's default value is null.
|
|
Gets the displayName value for this ParameterDefinition.
|
|
getGroup()
Gets the group for this ParameterDefinition, indicating if it is a member of a group.
|
|
Gets the groupPromptText value for this ParameterDefinition.
|
|
Gets the helpText for this ParameterDefinition.
|
|
getName()
Gets the name value for this ParameterDefinition.
|
|
Gets the operator list for this ParameterDefinition.
|
|
Gets the position in the Parameter array for this ParameterDefinition.
|
|
Gets the selectNameValueList for this ParameterDefinition.
|
|
Gets the selectValueList for this ParameterDefinition.
|
|
Gets the startExpanded value for this ParameterDefinition.
|
|
isAdHoc()
Gets the isAdHoc value for this ParameterDefinition.
|
|
isHidden()
Gets the isHidden value for this ParameterDefinition.
|
|
Gets the isPassword value for this ParameterDefinition.
|
|
Gets the isRequired value for this ParameterDefinition.
|
|
Gets the isViewParameter value for this ParameterDefinition.
|
|
setAutoSuggestThreshold(threshold)
Sets the autosuggest threshold for this ParameterDefinition.
|
|
setCascadingParentName(cascadingParentName)
Sets the cascadingParentName for this ParameterDefinition.
|
|
setColumnName(columnName)
Sets the columnName for this ParameterDefinition.
|
|
setColumnType(columnType)
Sets the columnType for this ParameterDefinition.
|
|
setControlType(controlType)
Sets the control type of this ParameterDefinition.
|
|
setCurrentDisplayName(currentDisplayName)
Sets the displayed name for this parameter.
|
|
setDataType(dataType)
Sets the dataType value for this ParameterDefinition.
|
|
setDefaultValue(defaultValue)
Sets the default value for this ParameterDefinition.
|
|
setDefaultValueIsNull(value)
When true, sets the default value for this ParameterDefinition to null.
|
|
setDisplayName(displayName)
Sets the name to display on the parameter page for this ParameterDefinition.
|
|
setGroup(group)
Sets the group value for this ParameterDefinition.
|
|
setGroupPromptText(groupPromptText)
Sets the groupPromptText value for this ParameterDefinition.
|
|
setHelpText(helpText)
Sets the helpText value for this ParameterDefinition.
|
|
setIsAdHoc(isAdHoc)
Sets this parameter as an ad hoc parameter.
|
|
setIsHidden(isHidden)
Sets the parameter to hidden.
|
|
setIsPassword(isPassword)
Sets this parameter to treat its value as a password, which hides the input on the page and encrypts the value.
|
|
setIsRequired(isRequired)
Sets the parameter to required.
|
|
setIsViewParameter(isViewParameter)
Sets the isViewParameter value for this ParameterDefinition.
|
|
setName(name)
Sets the name to use internally for this ParameterDefinition.
|
|
setPosition(position)
Sets the position value for this ParameterDefinition.
|
|
setSelectNameValueList(selectNameValueList)
Sets the selectNameValueList value for this ParameterDefinition.
|
|
setSelectValueList(selectValueList)
Sets the selectValueList value for this ParameterDefinition.
|
|
setStartExpanded(startExpanded)
Sets the startExpanded value for this ParameterDefinition.
|
var threshold = paramdef.getAutoSuggestThreshold( );
- Returns:
- {Integer} threshold
var parentname = paramdef.getCascadingParentName( );
- Returns:
- {String} The name of the parent parameter for any member of a cascading parameter set.
var columnname = paramdef.getColumnName( );
- Returns:
- {String} columnName
var columntype = paramdef.getColumnType( );
- Returns:
- {String} Possible values are: null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
var controltype = paramdef.getControlType( );
- Returns:
- {String} Possible values are: null, "", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".
var displayname = paramdef.getDisplayName( );
- Returns:
- {String} The current display name.
var type = paramdef.getDataType( );
- Returns:
- {String} Possible values are: "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
var default = paramdef.getDefaultValue( );
- Returns:
- {String} The default value.
if (paramdef.getDefaultValueIsNull( )){ alert('Default value is null!'); }
- Returns:
- {boolean}
var displayname = paramdef.getDisplayName( );
- Returns:
- {String} The display name.
document.write(paramdef.getGroup( ));
- Returns:
- {String} A group name, or null if there is no group.
- Returns:
- {String} groupPromptText
var helptext = paramdef.getHelpText( );
- Returns:
- {String} The help text.
var paramname = paramdef.getName( );
- Returns:
- {String} The parameter name.
var ops = new Array( ); ops = paramdef.getOperatorList( );
- Returns:
- {String[ ]} An array of Strings containing the operator list.
var position = paramdef.getPosition( );
- Returns:
- {Integer} position
var namevalues = new array( ); namevalues = paramdef.getSelectNameValueList( ).slice( );
- Returns:
- {Array} Array of actuate.parameter.NameValuePair objects.
var selectvalues = new array( ); selectvalues = paramdef.getSelectValueList( ).slice( );
- Returns:
- {String[ ]} An array of strings containing the select value list.
- Returns:
- {boolean} startExpanded
if (paramdef.isAdHoc( )){ paramdef.setDefaultValueIsNull(true); }
- Returns:
- {boolean} True indicates that this parameter is an ad hoc parameter.
if (paramdef.isHidden( )){ paramdef.setIsHidden(false); }
- Returns:
- {boolean} True indicates that this parameter is hidden.
if (paramdef.isPassword( )){ paramdef.setIsRequired(true); }
- Returns:
- {boolean} True indicates that the parameter is a password.
if (paramdef.isRequired( )){ paramdef.setHelpText("This parameter is required."); }
- Returns:
- {boolean} isRequired
if (paramdef.isViewParameter( )){ paramdef.setHelpText("This is a view-time parameter."); }
- Returns:
- {boolean} True indicates that the parameter is a view-time parameter. False indicates that the parameter is a run-time parameter.
paramdef.setAutoSuggestThreshold(0);
- Parameters:
- {Integer} threshold
- Returns:
- {void}
paramdef.setCascadingParentName("Clark");
- Parameters:
- {String} cascadingParentName
- Returns:
- {void}
paramdef.setColumnName("ProductName");
- Parameters:
- {string} columnName
- Returns:
- {void}
paramdef.setColumnType("Unknown");
- Parameters:
- {String} columnType
- Possible values are null, "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
- Returns:
- {void}
paramdef.setControlType("ControlList");
- Parameters:
- {String} controlType
- Possible values are null, "", "AutoSuggest", "ControlRadioButton", "ControlList", "ControlListAllowNew", and "ControlCheckBox".
- Returns:
- {void}
paramdef.setCurrentDisplayName("Year");
- Parameters:
- {String} currentDisplayName
- Returns:
- {void}
paramdef.setDataType("Date");
- Parameters:
- {String} dataType
- Possible values are "Currency", "Date", "DateOnly", "Time", "Double", "Integer", "String", "Boolean", "Structure", "Table", and "Unknown".
- Returns:
- {void}
paramdef.setDefaultValue("2010");
- Parameters:
- {String} defaultValue
- Returns:
- {void}
paramdef.setDefaultValueIsNull(true);
- Parameters:
- {boolean} value
- Returns:
- {void}
paramdef.setDisplayName("Year");
- Parameters:
- {String} displayName
- Returns:
- {void}
paramdef.setGroup("Customer Details");
- Parameters:
- {String} group
- Returns:
- {void}
- Parameters:
- {string} groupPromptText
- Returns:
- {void}
if (paramdef.isRequired( )){ paramdef.setHelpText("This parameter is required.") }
- Parameters:
- {String} helpText
- Returns:
- {void}
paramdef.setIsAdHoc(true);
- Parameters:
- {boolean} isAdHoc
- True sets this parameter to ad hoc.
- Returns:
- {void}
paramdef.setIsAdHoc(true);
- Parameters:
- {boolean} isHidden
- True hides the parameter.
- Returns:
- {void}
paramdef.setIsPassword(true);
- Parameters:
- {boolean} isPassword
- True indicates a password value.
- Returns:
- {void}
paramdef.setIsRequired(true);
- Parameters:
- {boolean} isRequired
- True indicates a mandatory parameter.
- Returns:
- {void}
paramdef.setIsViewParameter(true);
- Parameters:
- {boolean} isViewParameter
- Returns:
- {void}
paramdef.setName("Year");
- Parameters:
- {String} name
- Returns:
- {void}
paramdef.setPosition(++paramdef.getPosition( ));
- Parameters:
- {Integer} position
- Returns:
- {void}
paramdef.setSelectNameValueList(nparam.getSelectNameValueList( ));
- Parameters:
- {actuate.parameter.NameValuePair[ ]} selectNameValueList
- An array of actuate.parameter.NameValuePair objects.
- Returns:
- {void}
var values = new Array("2007", "2008", "2009"); paramdef.setSelectValueList(values);
- Parameters:
- {Array} selectValueList
- Returns:
- {void}
- Parameters:
- {boolean} startExpanded
- Returns:
- {void}