Eclipse BIRT Report Object Model (ROM)

Row Element

# Element Overview

Represents one row within a grid or table.

### Details

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

### Property Summary

bookmark
  A bookmark to use as a target of links within this report.
bookmarkDisplayName
eventHandlerClass
  The full qulified name of the event handler class.
height
  Minimum height of the row.
newHandlerOnEachEvent
repeatable
style
  Name of the style applied to this row.
suppressDuplicates
viewAction
visibility
  A list of rules for hiding and displaying this row in various output formats.

### Method Summary

onCreate
  Script executed when the element is created in the Factory.
onPrepare
  It is for a script startup phase. No data binding yet. The design of an element can be changed here.
onRender
  Script executed when the element is prepared for rendering in the Presentation engine.

### Slot Summary

cells
  Any number of cell entries for the row.

### Style Properties

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

### Description

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.

# Property Detail

## bookmark Property

A bookmark to use as a target of links within this report.

### Details

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

### Description

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.

### See Also

Action property on labels, data items, images and other items.

## bookmarkDisplayName Property

### Details

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

## eventHandlerClass Property

The full qulified name of the event handler class.

### Details

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

### Description

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.

## height Property

Minimum height of the row.

### Details

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

### Description

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.

## newHandlerOnEachEvent Property

### Details

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

## repeatable Property

### Details

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

## style Property

Name of the style applied to this row.

### Details

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

### Description

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.

### See Also

Style element in the ROM Styles Specification.

## suppressDuplicates Property

### Details

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

## viewAction Property

### Details

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

### Choices

Name | Display Name | Value | Description
NoChange | No Change | NoChange |
Changed | Changed | Changed |
Added | Added | Added |
Deleted | Deleted | Deleted |

## visibility Property

A list of rules for hiding and displaying this row in various output formats.

### Details

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

### Description

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.

### See Also

Visibility Rule structure for the details of the rules.

# Method Detail

## onCreate Method

Script executed when the element is created in the Factory.

### Synopsis

`None obj.onCreate( )`

### Details

Since: | 1.0
Context: | factory
Arguments: | None
Return Type: | None

### Description

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.

## onPrepare Method

It is for a script startup phase. No data binding yet. The design of an element can be changed here.

### Synopsis

`None obj.onPrepare( )`

### Details

Since: | 2.0
Context: | startup
Arguments: | None
Return Type: | None

### Description

It is for a script startup phase. No data binding yet. The design of an element can be changed here.

## onRender Method

Script executed when the element is prepared for rendering in the Presentation engine.

### Synopsis

`None obj.onRender( )`

### Details

Since: | 1.0
Context: | presentation
Arguments: | None
Return Type: | None

### Description

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.

### See Also

Dimension property type

# Slot Detail

## cells Slot

Any number of cell entries for the row.

### Details

Display Name: | Cells
Since: | 1.0
XML Element: | None. (The contents appear directly within the container element.)
Contents: | List of Cell
Default Style: | None

### Description

Any number of Cell elements for the row.