Eclipse BIRT Report Object Model (ROM)
Row Element
Display Name: | Row |
Since: | 1.0 |
XML Element: | row |
Extends: | None |
Extendable: | No |
Abstract: | No |
Name Space: | None |
Name Requirement: | Not Supported |
Allows User Properties: | Yes |
Has Style: | Yes |
Default Style: | None |
backgroundAttachment, backgroundColor, backgroundImage, backgroundPositionX, backgroundPositionY, backgroundRepeat, backgroundSizeHeight, backgroundSizeWidth, bidiTextDirection, borderBottomColor, borderBottomStyle, borderBottomWidth, borderLeftColor, borderLeftStyle, borderLeftWidth, borderRightColor, borderRightStyle, borderRightWidth, borderTopColor, borderTopStyle, borderTopWidth, canShrink, color, dateFormat, dateTimeFormat, display, fontFamily, fontSize, fontStyle, fontVariant, fontWeight, highlightRules, letterSpacing, lineHeight, mapRules, marginBottom, marginLeft, marginRight, marginTop, masterPage, numberAlign, numberFormat, orphans, paddingBottom, paddingLeft, paddingRight, paddingTop, pageBreakAfter, pageBreakBefore, pageBreakInside, showIfBlank, stringFormat, textAlign, textIndent, textLineThrough, textOverline, textTransform, textUnderline, timeFormat, verticalAlign, whiteSpace, widows, wordSpacing
A row element describes one row in a grid or table. A row is composed of a list of cells. Rows can set style properties to affect all cells within the row.
A bookmark to use as a target of links within this report.
Type: | expression |
Context: | |
Expression Type: | string |
Since: | 2.0 |
Required: | No |
Display Name: | Bookmark |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Many report items can be the target of hyperlinks. The bookmark is a string that uniquely identifies the item instance within the report. This property is an expression that evaluates to a string. If the string is blank or null, then the item has no bookmark. Bookmarks should be unique. If there are duplicates, the behavior of the hyperlink is undefined: it may jump to the first item with that name.
Action property on labels, data items, images and other items.
Type: | string |
Since: | 2.5 |
Required: | No |
Display Name: | Bookmark display name |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The full qulified name of the event handler class.
Type: | string |
Since: | 2.0 |
Required: | No |
Display Name: | Event handler class |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Full quilified name of the event handler class, used to specify an external Java class which define the scripting behavior that will be executed at runtime.
Minimum height of the row.
Type: | dimension |
Since: | 1.0 |
Required: | No |
Display Name: | Height |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Minimum height of the row. Some items have a dynamic size. The actual size of row is computed as the minimum of the tallest cell within the row, or the row height.
Type: | boolean |
Since: | 2.5 |
Required: | No |
Display Name: | New handler on each event |
JavaScript Type: | |
Default Value: | false |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Type: | boolean |
Since: | 2.5 |
Required: | No |
Display Name: | Repeatable |
JavaScript Type: | |
Default Value: | true |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name of the style applied to this row.
Type: | Style Reference |
Since: | 1.0 |
Required: | No |
Display Name: | Style |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | No |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Rows provide many style properties. The style properties are defined in the ROM Styles Specification. An element can inherit its style properties from a parent element, from a named style, or from a style that identifies the context in which the item appears. This property provides the name of the shared style to use.
This item can also set the value of style properties. Properties set on this element "override" those inherited from a parent element or a shared style.
All properties defined for a style appear as properties on report items also. See the Style element for the list of properties that appear here.
Style element in the ROM Styles Specification.
Type: | boolean |
Since: | 2.1 |
Required: | No |
Display Name: | Suppress Duplicates |
JavaScript Type: | |
Default Value: | false |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Type: | choice (viewAction) |
Since: | 2.1 |
Required: | No |
Display Name: | View action |
JavaScript Type: | |
Default Value: | NoChange |
Inherited: | No |
Runtime Settable: | No |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Name | Display Name | Value | Description |
NoChange | No Change | NoChange | |
Changed | Changed | Changed | |
Added | Added | Added | |
Deleted | Deleted | Deleted |
A list of rules for hiding and displaying this row in various output formats.
Type: | List of HideRule Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Visibility |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
The visibility rules control when the row appears in the report. A row can be completely hidden, in which case it won’t even be created in the Factory. A row can also be hidden conditionally depending on the output format.
Visibility Rule structure for the details of the rules.
Script executed when the element is created in the Factory.
None obj.onCreate( )
Since: | 1.0 |
Context: | factory |
Arguments: | None |
Return Type: | None |
Executed when the element is created in the Factory. Called after the item is created, but before the item is saved to the report document file. See the scripting spec for additional information about this script. Applications should perform visual customization in the on-render script instead.
It is for a script startup phase. No data binding yet. The design of an element can be changed here.
None obj.onPrepare( )
Since: | 2.0 |
Context: | startup |
Arguments: | None |
Return Type: | None |
It is for a script startup phase. No data binding yet. The design of an element can be changed here.
Script executed when the element is prepared for rendering in the Presentation engine.
None obj.onRender( )
Since: | 1.0 |
Context: | presentation |
Arguments: | None |
Return Type: | None |
Executed when the element is prepared for rendering in the Presentation engine. Changes made to the element are written to the target output format, but not saved to the report document file. This is the preferred place for visual customizations.
Dimension property type
Any number of cell entries for the row.
Display Name: | Cells |
Since: | 1.0 |
XML Element: | None. (The contents appear directly within the container element.) |
Contents: | List of Cell |
Default Style: | None |
Any number of Cell elements for the row.