Eclipse BIRT Report Object Model (ROM)
AbstractScalarParameter Element
Display Name: | Abstract ScalarParameter |
Since: | 2.5 |
XML Element: | None |
Extends: | Parameter |
Extendable: | No |
Abstract: | Yes |
Name Space: | Parameters |
Name Requirement: | Optional |
Allows User Properties: | Yes |
Has Style: | No |
comments, customXml, displayName, displayNameID, eventHandlerClass, extends, helpText, helpTextID, hidden, name, newHandlerOnEachEvent, promptText, promptTextID, propertyMasks, userProperties, viewAction
Represents the abstract scalar parameter types, which defines a single-value parameter.
Abstract 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 sort this list by specified key and direction(as controlled by the
sortDirection
, sortBy
and sortByColumn
properties).
Refer to a data set for the dynamic selection list.
Type: | DataSet Reference |
Since: | 2.0 |
Required: | No |
Display Name: | DataSet Name |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Dynamic list |
Refer to a data set for the selection list. Once this property is set, the selection list is dynamic.
The data type for the parameter.
Type: | choice (paramType) |
Since: | 1.0 |
Required: | No |
Display Name: | Data type |
JavaScript Type: | |
Default Value: | string |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
string | String | string | |
float | Float | float | |
decimal | Decimal | decimal | |
dateTime | Date Time | dateTime | |
boolean | Boolean | boolean | |
integer | Integer | integer | |
date | Date | date | |
time | Time | time | |
javaObject | Java Object | javaObject |
The data type for the parameter. The data type controls how the Requester formats, parses and validates the parameter. Every type can optionally provide a choice list. And, the parameter can require that the user select one of the choices.
selectionList
property
defaultValue
property
The default value of the parameter.
Type: | list |
Since: | 1.0 |
Required: | No |
Display Name: | Default value |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The default value for the parameter. The default value can be an expression, but cannot reference any other parameters.
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 |
The flag that indicates whether the value of the parameter is required.
Type: | boolean |
Since: | 2.2 |
Required: | No |
Display Name: | Is required |
JavaScript Type: | |
Default Value: | true |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The flag indicates whether the value of the parameter is required.
true
if the value of the parameter is required.
For string type parameter, if the value is required, it cannot be null
or empty.
For other type parameters, required value cannot be null
.
The prompt for the dynamic choices.
Type: | expression |
Context: | |
Expression Type: | string |
Since: | 2.0 |
Required: | No |
Display Name: | Label expression |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Dynamic list |
An expression that returns the display value for each row in the dynamic list.
valueExpr
property
List limitation number.
Type: | integer |
Since: | 2.0 |
Required: | No |
Display Name: | List limit |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Value for the list limitation number. If the limitation is provided, only the top-n choices will be available in the parameter request dialog.
Defines a selection list for the parameter: static list of values from which the user can choose.
Type: | List of SelectionChoice Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Selection list |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
The parameter selection list provides a developer-defined list of choices. Every choice has two parts: a choice and a label. The label can be externalized and appears in the UI. The choice is the value passed to the report. For example, labels may be "Open" and "Closed", while the values are 0 and 1.
The items in the list are of the type given by the parameter data type.
The sort key for parameter values when preview.
Type: | choice (paramSortValues) |
Since: | 2.2 |
Required: | No |
Display Name: | Sort by |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
value | Value | value | |
label | Display Text | label |
The sort key for parameter values when preview.Its value can be label or value.
The expression by which the result sorts.
Type: | expression |
Context: | |
Expression Type: | None |
Since: | 2.3 |
Required: | No |
Display Name: | Sort by column |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The expression by which the result sorts.
The sort order for parameter values when preview.
Type: | choice (sortDirection) |
Since: | 2.2 |
Required: | No |
Display Name: | Sort direction |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
asc | Ascending | asc | |
desc | Descending | desc |
The sort order for parameter values when preview. Its value can be asc or desc.
The expression to get the value for the choice.
Type: | expression |
Context: | |
Expression Type: | any |
Since: | 2.0 |
Required: | No |
Display Name: | Value expression |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Dynamic list |
The expression on the data row from the dynamic list data set that returns the value for the choice.
lableExpr
property
The parameter type for this scalar parameter.
Type: | choice (paramValueType) |
Since: | 2.0 |
Required: | No |
Display Name: | Value type |
JavaScript Type: | |
Default Value: | static |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
static | Static | static | |
dynamic | Dynamic | dynamic |
The parameter type for this scalar parameter. Its value can be dynamic or static.