| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>BIRT ROM Documentation</title> |
| <link rel="stylesheet" href="style/style.css" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| <body> |
| <p class="title">Eclipse BIRT Report Object Model (ROM)</p> |
| <p class="subtitle">Table of Contents</p> |
| <h1>Elements</h1> |
| <table class="summary-table"> |
| <tr><td><a href="elements/AccessControl.html">AccessControl</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/AutoText.html">AutoText</a></td> |
| <td>Describes the page number of the report.</td></tr> |
| <tr><td><a href="elements/CascadingParameterGroup.html">CascadingParameterGroup</a></td> |
| <td>Visual grouping of report cascading parameters.</td></tr> |
| <tr><td><a href="elements/Cell.html">Cell</a></td> |
| <td>Represents a cell element within a grid row or table row.</td></tr> |
| <tr><td><a href="elements/Column.html">Column</a></td> |
| <td>Describes one column within a table or grid.</td></tr> |
| <tr><td><a href="elements/Cube.html">Cube</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Data.html">Data</a></td> |
| <td>Displays a data set or computed value with optional |
| formatting.</td></tr> |
| <tr><td><a href="elements/DataSet.html">DataSet</a></td> |
| <td>Parent of simple data set and joint data set.</td></tr> |
| <tr><td><a href="elements/DataSource.html">DataSource</a></td> |
| <td>The data source element represents a connection to an |
| external data system.</td></tr> |
| <tr><td><a href="elements/DesignElement.html">DesignElement</a></td> |
| <td>Abstract element that represents anything |
| that has properties.</td></tr> |
| <tr><td><a href="elements/Dimension.html">Dimension</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/ExtendedItem.html">ExtendedItem</a></td> |
| <td>Represents an extended item, provide BIRT extenion capability.</td></tr> |
| <tr><td><a href="elements/FilterConditionElement.html">FilterConditionElement</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/FreeForm.html">FreeForm</a></td> |
| <td>Container that use free-form layout which position an element at (x,y) location.</td></tr> |
| <tr><td><a href="elements/GraphicMasterPage.html">GraphicMasterPage</a></td> |
| <td>A master page with free-form page decorations.</td></tr> |
| <tr><td><a href="elements/Grid.html">Grid</a></td> |
| <td>Represents a Grid item, it's divided into a series of rows and columns.</td></tr> |
| <tr><td><a href="elements/Hierarchy.html">Hierarchy</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Image.html">Image</a></td> |
| <td>Displays an image within the report.</td></tr> |
| <tr><td><a href="elements/JointDataSet.html">JointDataSet</a></td> |
| <td>Represents a data set joined by serveral data sets on respective join conditions.</td></tr> |
| <tr><td><a href="elements/Label.html">Label</a></td> |
| <td>Displays a static piece of text. The text can be |
| externalized.</td></tr> |
| <tr><td><a href="elements/Level.html">Level</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Library.html">Library</a></td> |
| <td>Predefined set of components and rules.</td></tr> |
| <tr><td><a href="elements/Line.html">Line</a></td> |
| <td>Lines to add graphical interest to a report.</td></tr> |
| <tr><td><a href="elements/List.html">List</a></td> |
| <td>This section describes the list itself.</td></tr> |
| <tr><td><a href="elements/ListGroup.html">ListGroup</a></td> |
| <td>Represents a group break level within a list.</td></tr> |
| <tr><td><a href="elements/Listing.html">Listing</a></td> |
| <td>Abstract base element that captures the behavior common |
| to lists and tables.</td></tr> |
| <tr><td><a href="elements/ListingGroup.html">ListingGroup</a></td> |
| <td>Abstract element that represents the behavior common to |
| list and table groups.</td></tr> |
| <tr><td><a href="elements/MasterPage.html">MasterPage</a></td> |
| <td>Base element for master pages within a report.</td></tr> |
| <tr><td><a href="elements/Measure.html">Measure</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/MeasureGroup.html">MeasureGroup</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/MemberValue.html">MemberValue</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Module.html">Module</a></td> |
| <td>Report design information common to report designs and |
| libraries. This is most of the report except for the body.</td></tr> |
| <tr><td><a href="elements/OdaCube.html">OdaCube</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/OdaDataSet.html">OdaDataSet</a></td> |
| <td>An extended data set retrieved by a query through an ODA driver that |
| implements the Open Data Access (ODA) interfaces.</td></tr> |
| <tr><td><a href="elements/OdaDataSource.html">OdaDataSource</a></td> |
| <td>An extended data source that represents a connection that implements the Open |
| Data Access (ODA) interfaces to interact with an external data provider.</td></tr> |
| <tr><td><a href="elements/OdaDimension.html">OdaDimension</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/OdaHierarchy.html">OdaHierarchy</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/OdaLevel.html">OdaLevel</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/OdaMeasure.html">OdaMeasure</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/OdaMeasureGroup.html">OdaMeasureGroup</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Parameter.html">Parameter</a></td> |
| <td>The base parameter element defines properties common to |
| all types of parameters.</td></tr> |
| <tr><td><a href="elements/ParameterGroup.html">ParameterGroup</a></td> |
| <td>Visual grouping of report parameters.</td></tr> |
| <tr><td><a href="elements/Rectangle.html">Rectangle</a></td> |
| <td>Describes a simple rectangle.</td></tr> |
| <tr><td><a href="elements/ReportDesign.html">ReportDesign</a></td> |
| <td>The report design element represents report as a whole.</td></tr> |
| <tr><td><a href="elements/ReportElement.html">ReportElement</a></td> |
| <td>Abstract element for user-visible elements.</td></tr> |
| <tr><td><a href="elements/ReportItem.html">ReportItem</a></td> |
| <td>Abstract base element for all visual report items.</td></tr> |
| <tr><td><a href="elements/Row.html">Row</a></td> |
| <td>Represents one row within a grid or table.</td></tr> |
| <tr><td><a href="elements/ScalarParameter.html">ScalarParameter</a></td> |
| <td>Defines a simple single-value parameter.</td></tr> |
| <tr><td><a href="elements/ScriptDataSet.html">ScriptDataSet</a></td> |
| <td>A data set defined in JavaScript.</td></tr> |
| <tr><td><a href="elements/ScriptDataSource.html">ScriptDataSource</a></td> |
| <td>A specialized data source defined in JavaScript.</td></tr> |
| <tr><td><a href="elements/SimpleDataSet.html">SimpleDataSet</a></td> |
| <td>The data set element represents a result set retrieved |
| from an external data provider.</td></tr> |
| <tr><td><a href="elements/SimpleMasterPage.html">SimpleMasterPage</a></td> |
| <td>The simple master page provides a header and footer that |
| appear on every page.</td></tr> |
| <tr><td><a href="elements/SortElement.html">SortElement</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/Style.html">Style</a></td> |
| <td>Describes a Style element.</td></tr> |
| <tr><td><a href="elements/Table.html">Table</a></td> |
| <td>Presents data from a data set in using a tabular layout.</td></tr> |
| <tr><td><a href="elements/TableGroup.html">TableGroup</a></td> |
| <td>Represents a group break level within a table.</td></tr> |
| <tr><td><a href="elements/TabularCube.html">TabularCube</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TabularDimension.html">TabularDimension</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TabularHierarchy.html">TabularHierarchy</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TabularLevel.html">TabularLevel</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TabularMeasure.html">TabularMeasure</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TabularMeasureGroup.html">TabularMeasureGroup</a></td> |
| <td></td></tr> |
| <tr><td><a href="elements/TemplateDataSet.html">TemplateDataSet</a></td> |
| <td>Represents a template data set.</td></tr> |
| <tr><td><a href="elements/TemplateElement.html">TemplateElement</a></td> |
| <td>A base template element, represents placeholder for a data set or a report item.</td></tr> |
| <tr><td><a href="elements/TemplateParameterDefinition.html">TemplateParameterDefinition</a></td> |
| <td>Represents a definition for a template element.</td></tr> |
| <tr><td><a href="elements/TemplateReportItem.html">TemplateReportItem</a></td> |
| <td>Represents a template placeholder for a report item.</td></tr> |
| <tr><td><a href="elements/Text.html">Text</a></td> |
| <td>Displays a multi-line block of text defined within the |
| report. Can contain embedded formatting and value expressions.</td></tr> |
| <tr><td><a href="elements/TextData.html">TextData</a></td> |
| <td>Displays a multi-line block of text defined within the |
| report.</td></tr> |
| <tr><td><a href="elements/Theme.html">Theme</a></td> |
| <td>Represents a theme in the library</td></tr> |
| <tr><td><a href="elements/ValueAccessControl.html">ValueAccessControl</a></td> |
| <td></td></tr> |
| </table> |
| |
| <h1>Structures</h1> |
| <table class="summary-table"> |
| <tr><td><a href="structs/Action.html">Action</a></td> |
| <td>Defines a hyperlink.</td></tr> |
| <tr><td><a href="structs/AggregationArgument.html">AggregationArgument</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/CachedMetaData.html">CachedMetaData</a></td> |
| <td>The cached meta-data element contains cached derived data |
| attributes of a data set.</td></tr> |
| <tr><td><a href="structs/ColumnHint.html">ColumnHint</a></td> |
| <td>Provides a number of |
| report-related data attributes about a result set column.</td></tr> |
| <tr><td><a href="structs/ComputedColumn.html">ComputedColumn</a></td> |
| <td>A user-defined column in the result set.</td></tr> |
| <tr><td><a href="structs/ConfigVar.html">ConfigVar</a></td> |
| <td>Define a varialbe mostly for deployment-specific purpose.</td></tr> |
| <tr><td><a href="structs/CustomColor.html">CustomColor</a></td> |
| <td>Defines a custom color name.</td></tr> |
| <tr><td><a href="structs/DataSetParam.html">DataSetParam</a></td> |
| <td>Describes an input and/or output parameter of the data |
| set query.</td></tr> |
| <tr><td><a href="structs/DateFormatValue.html">DateFormatValue</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/DateTimeFormatValue.html">DateTimeFormatValue</a></td> |
| <td>Used to format a datetime value.</td></tr> |
| <tr><td><a href="structs/DimensionCondition.html">DimensionCondition</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/DimensionJoinCondition.html">DimensionJoinCondition</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/EmbeddedImage.html">EmbeddedImage</a></td> |
| <td>Holds an reusable image embedded within the design file.</td></tr> |
| <tr><td><a href="structs/ExtendedProperty.html">ExtendedProperty</a></td> |
| <td>Represents one Extended property.</td></tr> |
| <tr><td><a href="structs/FilterCondition.html">FilterCondition</a></td> |
| <td>Defines a fileter criteria.</td></tr> |
| <tr><td><a href="structs/HideRule.html">HideRule</a></td> |
| <td>Defines a visibility rule for a report item in a kind of output format.</td></tr> |
| <tr><td><a href="structs/HighlightRule.html">HighlightRule</a></td> |
| <td>Represents a highlight rule;each highlight rule consists of an expression, operator, values, and corresponding format style</td></tr> |
| <tr><td><a href="structs/IncludeScript.html">IncludeScript</a></td> |
| <td>Stores a location for a script file that is loaded by the design.</td></tr> |
| <tr><td><a href="structs/IncludedCssStyleSheet.html">IncludedCssStyleSheet</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/IncludedLibrary.html">IncludedLibrary</a></td> |
| <td>Link to a library used by the report with a namespace.</td></tr> |
| <tr><td><a href="structs/JoinCondition.html">JoinCondition</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/LevelAttribute.html">LevelAttribute</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/MapRule.html">MapRule</a></td> |
| <td>Represents a map rule; each map rule consists of a test expression, operator, values and corresponding |
| translated value</td></tr> |
| <tr><td><a href="structs/NumberFormatValue.html">NumberFormatValue</a></td> |
| <td>Used to format a numeric value.</td></tr> |
| <tr><td><a href="structs/OdaDataSetParam.html">OdaDataSetParam</a></td> |
| <td>Describes an input and/or output parameter of the ODA data |
| set query.</td></tr> |
| <tr><td><a href="structs/OdaDesignerState.html">OdaDesignerState</a></td> |
| <td>Describes the state of the ODA data source/data set.</td></tr> |
| <tr><td><a href="structs/OdaLevelAttribute.html">OdaLevelAttribute</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/OdaResultSetColumn.html">OdaResultSetColumn</a></td> |
| <td>Describes a column within a result set of an ODA data set.</td></tr> |
| <tr><td><a href="structs/ParamBinding.html">ParamBinding</a></td> |
| <td>Represents an association between an expression and a |
| data set or nested report input parameter.</td></tr> |
| <tr><td><a href="structs/ParameterFormatValue.html">ParameterFormatValue</a></td> |
| <td>Used to format the default value of the scalar parameter.</td></tr> |
| <tr><td><a href="structs/PropertyBinding.html">PropertyBinding</a></td> |
| <td>Bind a value expression to a property.</td></tr> |
| <tr><td><a href="structs/PropertyMask.html">PropertyMask</a></td> |
| <td>Allows a third-party developer to lock or hide a |
| property.</td></tr> |
| <tr><td><a href="structs/ResultSetColumn.html">ResultSetColumn</a></td> |
| <td>Describes a column within a result set.</td></tr> |
| <tr><td><a href="structs/Rule.html">Rule</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/ScriptLib.html">ScriptLib</a></td> |
| <td>Stores the class path that is for BIRT defined scripts.</td></tr> |
| <tr><td><a href="structs/SearchKey.html">SearchKey</a></td> |
| <td>Defines a search criteria for a drill-through hyperlink.</td></tr> |
| <tr><td><a href="structs/SelectionChoice.html">SelectionChoice</a></td> |
| <td>Describes one item in a static parameter selection list.</td></tr> |
| <tr><td><a href="structs/SortKey.html">SortKey</a></td> |
| <td>A sort definition consisting of an expression and sort |
| direction.</td></tr> |
| <tr><td><a href="structs/StringFormatValue.html">StringFormatValue</a></td> |
| <td>Used to format a string value.</td></tr> |
| <tr><td><a href="structs/TOCStructure.html">TOCStructure</a></td> |
| <td>Represents a toc;each toc consists of an expression, style, and corresponding format style</td></tr> |
| <tr><td><a href="structs/TimeFormatValue.html">TimeFormatValue</a></td> |
| <td></td></tr> |
| <tr><td><a href="structs/UserMethod.html">UserMethod</a></td> |
| <td><i>Reserved</i></td></tr> |
| <tr><td><a href="structs/UserProperty.html">UserProperty</a></td> |
| <td>Defines a user-defined property.</td></tr> |
| </table> |
| |
| <h1>Supporting Indexes</h1> |
| <table class="summary-table"> |
| <tr><td><a href="types.html">Property Types</a></td> |
| <td>The set of types used to define ROM properties.</td></tr> |
| <tr><td><a href="styles.html">Predefined Styles</a></td> |
| <td>Styles defined by BIRT, usually as a "default style" for an element or slot.</td></tr> |
| <tr><td><a href="prop-index.html">Property Index</a></td> |
| <td>Index of properties with a link to their definition.</td></tr> |
| </table><br> |
| |
| </body> |
| </html> |
