Eclipse BIRT Report Object Model (ROM)
ScalarParameter Element
| Display Name: | ScalarParameter |
| Since: | 1.0 |
| XML Element: | scalar-parameter |
| Extends: | AbstractScalarParameter |
| Extendable: | Yes |
| Abstract: | No |
| Name Space: | Parameters |
| Name Requirement: | Required |
| Allows User Properties: | Yes |
| Has Style: | No |
comments, customXml, dataSetName, dataType, defaultValue, displayName, displayNameID, eventHandlerClass, extends, helpText, helpTextID, hidden, isRequired, labelExpr, listLimit, name, newHandlerOnEachEvent, promptText, promptTextID, propertyMasks, selectionList, sortBy, sortByColumn, sortDirection, userProperties, valueExpr, valueType, viewAction
This element defines a single-value parameter. Scalar parameters can have selection lists.
Scalar parameters can provide a selection list. The list
can be static (defined by the selectionList
property) or dynamic (defined by the dataSet,
valueExpr and labelExpr
properties.) The user can be required to select a value from the list, or can
enter a value not in the list (as controlled by the
mustMatch property).
BIRT uses the following rules to determine the selection list:
| Type: | choice (scalarParamAlign) |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Alignment |
| JavaScript Type: | |
| Default Value: | auto |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Name | Display Name | Value | Description |
| auto | Auto | auto | |
| left | Left | left | |
| center | Center | center | |
| right | Right | right |
| Type: | integer |
| Since: | 2.3 |
| Required: | No |
| Display Name: | Auto suggest threshold |
| JavaScript Type: | |
| Default Value: | 1 |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Hidden |
| Property Sheet Group: | Top |
| Type: | List of ComputedColumn Structures |
| Since: | 2.1 |
| Required: | No |
| Display Name: | Bound data columns |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | Yes |
| Property Sheet Visibility: | Hidden |
| Property Sheet Group: | Top |
| Type: | boolean |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Conceal value |
| JavaScript Type: | |
| Default Value: | false |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Type: | choice (paramControl) |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Control type |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Name | Display Name | Value | Description |
| text-box | Text Box | text-box | |
| list-box | Combo/List Box | list-box | |
| radio-button | Radio Button | radio-button | |
| check-box | Check Box | check-box | |
| auto-suggest | Text Box - Auto Suggest | auto-suggest |
| Type: | boolean |
| Since: | 2.2 |
| Required: | No |
| Display Name: | Distinct |
| JavaScript Type: | |
| Default Value: | true |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Type: | boolean |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Fixed order |
| JavaScript Type: | |
| Default Value: | true |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Selection list |
| Type: | ParameterFormatValue Structure |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Format |
| JavaScript Type: | |
| Default Value: | None |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Hidden |
| Property Sheet Group: | Top |
| Type: | boolean |
| Since: | 1.0 |
| Required: | No |
| Display Name: | Must match |
| JavaScript Type: | |
| Default Value: | true |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Selection list |
| Type: | choice (scalarParamType) |
| Since: | 2.2 |
| Required: | No |
| Display Name: | Scalar parameter type |
| JavaScript Type: | |
| Default Value: | simple |
| Inherited: | Yes |
| Runtime Settable: | No |
| Property Sheet Visibility: | Visible |
| Property Sheet Group: | Top |
| Name | Display Name | Value | Description |
| simple | Simple | simple | |
| multi-value | Multi Value | multi-value |
list obj.getDefaultValueList( )
| Since: | 2.5 |
| Context: | factory |
| Arguments: | None |
| Return Type: | list |
list obj.getSelectionValueList( )
| Since: | 2.5 |
| Context: | factory |
| Arguments: | None |
| Return Type: | list |