Eclipse BIRT Report Object Model (ROM)

ScalarParameter Element

Element Overview

Defines a simple single-value parameter.

Details

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

Property Summary

alignment
autoSuggestThreshold
boundDataColumns
concealValue
controlType
distinct
fixedOrder
format
mustMatch
paramType

Method Summary

getDefaultValueList
getSelectionValueList

Inherited Properties

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

Inherited Methods

validate

Description

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:

Property Detail

alignment Property

Details

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

Choices

NameDisplay Name ValueDescription
auto Auto auto
left Left left
center Center center
right Right right


autoSuggestThreshold Property

Details

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

boundDataColumns Property

Details

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

concealValue Property

Details

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

controlType Property

Details

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

Choices

NameDisplay Name ValueDescription
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


distinct Property

Details

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

fixedOrder Property

Details

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

format Property

Details

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

mustMatch Property

Details

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

paramType Property

Details

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

Choices

NameDisplay Name ValueDescription
simple Simple simple
multi-value Multi Value multi-value

Method Detail

getDefaultValueList Method

Synopsis

list obj.getDefaultValueList( )

Details

Since: 2.5
Context: factory
Arguments: None
Return Type: list

getSelectionValueList Method

Synopsis

list obj.getSelectionValueList( )

Details

Since: 2.5
Context: factory
Arguments: None
Return Type: list