Eclipse BIRT Report Object Model (ROM)
ScalarParameter Element
Display Name: | ScalarParameter |
Since: | 1.0 |
XML Element: | scalar-parameter |
Extends: | Parameter |
Extendable: | Yes |
Abstract: | No |
Name Space: | Parameters |
Name Requirement: | Required |
Allows User Properties: | Yes |
Has Style: | No |
comments, customXml, displayName, displayNameID, eventHandlerClass, extends, helpText, helpTextID, hidden, name, propertyMasks, userProperties, 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:
How the items should appear in the UI. Choices are auto (default), left, center or right.
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 | Numbers are left aligned, all others are right aligned. |
left | Left | left | Values are left-aligned. |
center | Center | center | Values are centered. |
right | Right | right | Values are right-aligned. |
How the items should appear in the UI. Choices are auto (default), left, center or 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 |
Bindings the data set column and expressions with the property values..
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 |
Property values of a scalar parameter can bind to a data set column through bound data columns' names. If a data set column or expression are not bound in the data columns, the exeuction of the expression fails.
Hides the user�s entry by displaying asterisks or similar characters. Often used for passwords.
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 |
This property hides the user�s entry by displaying asterisks or similar characters. Often used for passwords. The default is to show the entry in plain text.
hidden
Property
The suggested type of UI control to use when displaying the parameter.
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 | The user can type in the value. |
list-box | Combo/List Box | list-box | Requires a list of choices: static or dynamic. Shown as a list box if set of choices are fixed, combo-box if set of choices is open. |
radio-button | Radio Button | radio-button | Only allowed for a fixed set of choices. |
check-box | Check Box | check-box | Only for Boolean values |
auto-suggest | Text Box - Auto Suggest | auto-suggest |
The suggested type of UI control to use when displaying the parameter. The default depends on the parameter properties:
The list-box control is rendered in the UI depending on the value of the
mustMatch
property. If mustMatch
is true, then the user much choose a value from
the list, and the control is rendered as a UI list box. However, if mustMatch
is
false, then the user can chose an item from the list, or type in a different
value, and the control is rendered as a UI combo box.
mustMatch
property
The name of the data set to execute to obtain a selection list dynamically.
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 |
The name of the data set to execute to obtain the list.
This element defines or references a query that defines a dynamic selection list for the parameter. The data set can reference other parameters, but only those that appear in the design before this parameter. Sorting can be done by the data set (if the fixedOrder property is true), or can be done by BIRT (if the fixedOrder property is false.)
The data set must return a column that contains the choice values. It may also contain a column that returns the labels for the values. All other columns are ignored. The choice is that passed to the report when run. The optional display value is shown to the user in the UI. For example, the display values might be �Residential?, �Commercial?, and �Government? while the corresponding parameter values are �R?, �C?, and �G?.
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 | Arbitrary Unicode text. |
float | Float | float | A scientific amount using the usual floating point notation. |
decimal | Decimal | decimal | Any type of number including currency. Fixed decimal, arbitrary precision. |
dateTime | DateTime | dateTime | A date, time or combination of date and time. |
boolean | Boolean | boolean | A simple true/false value. |
integer | Integer | integer | |
date | Date | date | |
time | Time | time |
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: | literalString |
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 |
Whether to display the list sorted in unsorted (fixed) order.
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 |
Whether to display the values in the order defined in the list, or whether to resort the list lexicographically based on the actual translated values. The default is true, and the selections are displayed in the order in which they are defined.
selectionList
property
dynamicList
property
Formatting pattern for showing the parameter in the UI.
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 |
Formatting instructions for the parameter value within the parameter UI. For UIs that are able to show formatted parameter values, provides a BIRT format used to display the value. The format is dropped, and the unformatted value presented, when the user edits the parameter value.
Formatting instructions for the parameter value within the parameter UI. By default the UI should use the following rules:
The format string must be one of the valid BIRT format strings (see the Style element for a list.) The format is used by the UI to display the value after the user moves away from a field. For example, to format a number as a dollar amount.
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 |
An expression on the data row to return the display value for each choice in a dynamic list.
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 on the data row from the dynamic list data set that returns the prompt for the choice. If omitted, then BIRT uses the value as the label.
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.
If true, then the value that the user provides must match one of the values in the static or dynamic selection list.
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 |
If true, then the value that the user provides must match one of the values in the list. If false, then the values in the list are a reference; the use can enter additional values as well. Ignored if the property does not have a 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 | |
ad-hoc | Ad-hoc | ad-hoc |
The prompt text displayed when user input the parameter value.
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 |
The text that will be displayed to the user when he/she is prompt for the parameter value.
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 |
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: | Selection list |
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.
mustMatch
property
fixedOrder
property
controlType
property
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 |
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 |
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 |
An expression on the data set row to return the value of each choice in a dynamic list.
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 |
An expression on the data row from the dynamic list data set that returns the value for the choice. If omitted, then BIRT uses the first column.
Type of the 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 |
Type of the parameter, can be static or dynamic