Eclipse BIRT Report Object Model (ROM)
Parameter Element
| Display Name: | Parameter |
| Since: | 1.0 |
| XML Element: | None |
| Extends: | ReportElement |
| Extendable: | No |
| Abstract: | Yes |
| Name Space: | Parameters |
| Name Requirement: | Required |
| Allows User Properties: | Yes |
| Has Style: | No |
comments, customXml, displayName, displayNameID, eventHandlerClass, extends, name, newHandlerOnEachEvent, propertyMasks, userProperties, viewAction
The base parameter element defines properties common to all types of parameters. Parameters can be hidden, meaning that they will not appear in the UI. Parameters also provide additional pop-up help text that can explain the use of the parameter to the end user.
Additional text to display for the parameter to explain how to use the parameter.
| Type: | string |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Help text |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
Additional text to display for the parameter to explain how to use the parameter. The string can be externalized.
Resource key for the helpText
| Type: | resourceKey |
| Since: | none |
| Required: | No |
| Display Name: | Help text Key |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
helpText can be externalized. helpTextId is the resource key for the helpText.
Hides the parameter from the parameter UI.
| Type: | boolean |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Hidden |
| JavaScript Type: | |
| Default Value: | false |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
If true, the parameter will not appear in the Requester page. Allows the developer to create parameters for internal use, or for use by scripts. Parameters are visible by default.
concealValue property of
the Scalar Parameter
| Type: | string |
| Since: | 2.0 |
| Required: | No |
| Display Name: | Prompt text |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Type: | resourceKey |
| Since: | 2.1 |
| Required: | No |
| Display Name: | Prompt text key |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
Validation method associated with the parameter
boolean obj.validate( )
| Since: | 2.5 |
| Context: | factory |
| Arguments: | None |
| Return Type: | boolean |
User can implement this method to perform custom validation for a particular parameter. This method is called during report execution, to validate the parameter value.