All Classes and Interfaces

Class
Description
Represents the abstract scalar parameter types.
Represents the abstract scalar parameter types.
Represents a abstract theme in the library.
Deprecated. 
The Action structure defines a hyperlink.
Represents an "action" (hyperlink) attached to an element.
This event class identifies that the activity stack changes.
The interface receives events about activity stack changes.
AggregationArgument.
AggregationArgumentHandle.
 
Represents the definition of argument.
Represents the definition of argument.
Represents an optional argument list of a method.
Represents an optional argument list of a method.
Notification event that says that the attribute of the module is changed.
Represents a autotext report item.
The strategy to recover the table from an invalid layout to a valid one.
 
The internal factory to find resources in the bundle.
Structure used to cache data set information that include output column information when it gets from databases, input/output parameter definitions.
Structure handle to deal with cached data set metadata informations.
CalculationArgument.
CalculationArgumentHandle.
Represents the group of cascading parameters.
Represents the group of cascading parameters.
Validates that type of the parameters in a cascading parameter group should be "dynamic".
Represents a cell within a table or grid.
Validates all cells in one row don't overlap each other.
Adapter class for the IChoiceDefinition class.
An error indicates circular extension while setting the extends property of an element.
Represents the script object definition.
Represents the script object definition.
Handle to work with a color property.
Utility class to do color parsing or converting work.
Represents the data structure to store copied objects like the column and cells.
The utility class for bound data columns migration.
Represents a column within a table.
This class represents one column hint used by data sets.
Represents the handle of column hint.
Application-level interface into the Model's command stack.
Class that records some status after the report item checks the compatibilities.
Provides the backward compatibility for the user.
Abstract class for working with properties that have internal structure, such as a color, a dimension or a font.
Represents one computed column.
Represents the handle of computed column.
This class represents a configuration variable in the report's config variable list.
Represents the handle of configuration variable.
Represents the method information for both class and element.
 
Notification event that says that the contents of a container have changed.
Reports an error during a container operation.
Notification event that says that one content of a container have been replaced by another one.
The utility class for copy/paste.
Included css style sheet event
Included css style sheet exception
Included css style sheet reload event
Css shared style handle.
Represents an include style sheet in the module.
Represents a cube.
Utility class to provide some methods about cube.
Represents an custom color in the report's color palette.The use-defined color has a unique name and a valid RGB value for render.
Represents the handle of custom color.
Notification event that says that the contents of user-defined message is added, dropped, or changed.
Reports an error during a user-defined message operation.
Validates the result set column of the data item.
 
Represents a data item element.
Abstract handle for data set elements.
Validates the data set name of scalar parameter is required.
Validates the data set name of scalar parameter is required.
Represents the parameter for ODA drivers.
Represents the parameter for data set drivers.
Validates the data set of some special elements should be provided.
Deprecated.
since birt 2.2
This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
The utility class to convert values between parameter type choices and column data type choices.
The format value for the data.
The format value for the data-time.
The default implementation for interface IResourceLocator.
Provides API to operate a derived data set.
This class collects commonly-used choice constants.
Wraps around configuration settings for design engine.
Base class for all report elements.
Represents the BIRT design engine as a whole.
Factory pattern to create an instance of Design Engine
Implementation of DesignEngine.
Signals that a fatal error occurred when opening a design file.
Applies logic customized to each type of report element.
The DimensionCondition structure defines a list of join conditions between cube and hierarchy.
Represents the handle of the cube-dimension/hierarchy join condition.
Simplifies working with dimension properties.
Represents a dimension element in the cube element.
Represents a dimension join condition in the DimensionCondition.
Represents a dimension join condition in the DimensionCondition.
Utility class to do conversions between units.
Representation of a dimension property value.
Notification event that says that the module is disposed.
Utility class for the serialize a report design in which all the elements localize their property values from the referred external resources, such as library elements, library embedded images.
Represents the dynamic filter parameter types.
Extension adapter class for the IElementCommand.
Indicates that an element was deleted.
Abstract base class for property handles, slot handles, structure handles an other handles that provide detail about a report element.
Represents the utility class to help export element and structure to library file.
Represents the utility class to help export element and structure to library file.
Validates the element extends property.
Creates a new report elements and returns handles to it.
Events indicating that the element is just localized.
Validates the property whose type is element reference.
Represents an embedded image.
Represents the handle of an embedded image.
Implements an empty group element handle, which actually can do nothing.
Identifies that the encryption of an element property changed.
Indicates an error when setting the name of an element.
Implements to define the error codes that are exposed to api.
Provides detail information about errors found when opening a design file.
Represents the object for the expression.
Simplifies working with expression properties.
Simplifies working with expression lists.
Enumerates the expression types.
Base class for all peer-provided exceptions.
Represents an extended element.
This class represents one Extended property.
Represents the handle of Extended property.
Indicates that the extends attribute of an element changed.
Indicates an error while setting the extends property of an element.
An error indicates not supported extension while setting the extends property of an element.
Notification event to send when the dynamic property list is changed after setting an extension property value.
Validates the extension is valid, which is provided by IReportItem.
Factory element handle class to retrieve some factory styles.
A specialized handle for use when creating the Factory data structures.
The strategy to fill empty areas with LayoutCells and Cell elements.
Represents one filter in the filter list of List, Table or their Groups.
 
Represents one filter in the filter list of List, Table or their Groups.
FilterExprDefinition
Simplifies working with the font family property.
The abstract value for the format of string, data-time and number.
Represents a format value in the style or the highlight rule.
Represents a free-form element.
Represents a graphic master page in the design.
Represents an object of copied objects when do copy/paste operations between grids.
Represents a grid item in the design.
Represents an object of copied objects when do copy/paste operations between grids.
This class is a factory class to instantiate a group element handle.
This class provides services to deal with a group of elements.
Represents both list and table groups in the design.
Validates the ducplicat group name in one table with data set.
A handle for working with a top-level property of a collection of elements.
Implements hide rules of a ReportItem.
Represents the handle of visibility rule.
Represents a Hierarchy.
Represents a highlight rule that says how a data item should appear based on the value within it.
Represents a highlight rule in the highlight property of a style.
Provides the absolute dimension value for absolute font size constant.
Represents the visibility level of a module.
Script wrapper of ActionHandle
Application-level interface into the Model's activity record.
 
Represents the definition of argument.
Represents an optional argument list of a method.
Receives file name events after one attribute of the report design is changed.
Simple wrapper of AutoTextHandle
 
IBirtFilterOperatorConstants
 
Retrieves resources in the Eclipse bundle.
Represents a the design of a Cell in the scripting environment
Describes the options for a property value.
Defines a choice within a list of property choices defined by a peer extension.
Represents a set of choices on a predefined or user defined property type or property definition.
Represents the script object definition.
 
The interface for constants of colors used in BIRT.
Script wrapper of ColumnHandle.
Represents an instance of a extended report element that can work with the bound data columns.
Represents the design of an DataBinding in the scripting environment
Represents a the design of a DataItem in the scripting environment
Script wrapper of OdaDataSetHandle
Script wrapper of OdaDataSourceHandle
 
Interface for all the design elements.
Script wrapper of DesignElementHandle
Represents the BIRT design engine as a whole.
Factory class to create an instance of DesignEngine
Receives dispose events after one report design is disposed.
Represents a the design of a multi line text item in the scripting environment
Represents a extended element command that is integrated with the BIRT command stack.
The copied object created from CopyUtil.copy().
Interface for a report element definition.
Interface of the Meta-data information for an element property or an extension model property.
Defines the interface of encryption helper, which includes two methods for encryption and decryption.
Class provides a event filter logic for a transaction.
 
 
Script wrapper of ExtendedItemHandle.
Represents the design of an FilterCondition in the scripting environment
 
IFilterExprDefinition
 
Represents a the design of a Grid in the scripting environment
Script wrapper of GroupHandle
Represents the design of an HighRule in the scripting environment
Represents the design of an HighLightRule in the scripting environment
Represents a the design of an Image in the scripting environment
Represents a the design of a Label in the scripting environment
Represents the design of a List in the scripting environment
Script wrapper of ListGroupHandle
Represents the design of an Listing in the scripting environment
 
Thrown to indicate that a method has been illegally called.
Represents the abstract definition which can be localized.
If the image source is set, the corresponding image data should be set.
Represents an image report item.
Represents a master page in the scripting environment
Represents the definition of class member.
The interface for getting localized messages from extension element.
Global, shared dictionary of design meta data.
Interface to handle meta-data errors during initialization.
Represents the method information for both class and element.
The interface for the root element to store the constants.
Implements to define the keys to do some setting in a module.
 
Interface to do all managements about the element names.
Included css style sheet structure
Represents a included css style sheet in report design and theme.
Validates whether the included css style sheet file is existed or not.
This class represents one include library of report design.
Represents the handle of the included library.
Validates whether the included library file is existed or not.
This class represents a include script.
Represents the handle of the included script.
Validates the column number in columns slot and the maximum column number in rows should be consistent.
An error indicates invalid parent while setting the extends property of an element.
Base Interface for methods common to elements and structures.
 
Interface to provide information for paste checks.
BIRT defines a fixed set of predefined styles.
Defines a property or structure member provided by an peer extension.
Base Interface for both element property, extension model property and structure member definitions.
Base class for the meta-data for property types.
Script wrapper of ReportDesignHandle
Represents a the design of a report element in the scripting environment
Represents an instance of a extended report element.
Represents a the design of a report item in the scripting environment
Represents the peer extension itself.
Defines the method context that are available to the report item.
Provides the resource bundle with the given locale.
This listener is notified of changes to resources in the resource path.
Implements this interface to provide a custom file search algorithm.
Represents the design of an ResultSetColumn in the scripting environment
Represents a row in the scripting environment
 
The factory class to create scriptable objects.
Interface for the definition of a slot within an element.
Represents the design of an SortCondition in the scripting environment
The simple API class for the SortElementHandle.
Interface for objects that appear in a property list.
Interface for the definition of a property structure: an object that is "managed" by the model to allow generic member access and undo/redo support for updates.
Represents the design time style for a report element in the scripting environment
Interface to traverse all the style property values.
Represents the design of a Table in the scripting environment
Script wrapper of TableGroupHandle
Represents the method information that can provide code template.
Represents a the design of a TextItem in the scripting environment
Receives validation events after one element is validated.
Holds instrustions that inform the user if opening the old version design file may cause some auto-conversion to the original design file.
Represents a condition used for joint data set.
Represents a handle of condition used for joint dataset.
Provides API to operate a joint data set.
Represents a label report item.
The minimal item in the table.
Notification event that says that the layout of the table element has been changed.
The table group model for a TableGroup element.
An algorithm to support rowSpan, colSpan for BIRT table elements.
Represents a row in table layout.
A slot in the table.
The table model for the content layout.
Represents an overlapped area of the cell element in the table.
The table model for the UI render.
The utility class for LayoutTable.
This class represents one attribute of the level element.
Represents the handle of one column in the result set.
Represents a level element.
Notification event that says that the module need refreshing.
Indicates that the library is added, dropped or shifted.
Indicates an error while operating with library.
Represents the handle of library element.
 
Events indicating that the library is reloaded.
Represents the line item.
Receives events about a Design Element.
Represents a group in a list.
Represents a list report item.
Represents slots and common properties in the two list-oriented elements: table and list.
This class represents a style mapping rule: a translation of a database value into a set of display values.
Represents the handle of map rule.
Validates the table/list is not allowed to appear in header/footer/contents slot of master page in any level.
Represents a master page.
Validates the multiple columns and content width should be consistent.
Validates the report should have at least one master page.
Validates the page size is invalid.
Validates the page size against page type.
Handle class for MeasureGroup.
This class represents a measure element.
A handle to a member of a property structure.
Represents the definition of class member.
Represents the definition of class member.
An iterator over the members of a structure.
CrosstabMemberValueHandle
Provides constants used in the meta-data package.
Exception thrown if an error occurs when reading the meta-data description file or the building the meta-data description.
Represents the method information for both class and element.
Represents the method information for both class and element.
Defines various constants.
Implementation of BirtException in model project.
Abstract module handle which provides the common functionalities of report design and library.
Abstract module handle which provides the common functionalities of report design and library.
Provide the way to do some setting about the module.
Provides some tool methods about the modules.
Deprecated.
Implements of multi row report item.
Represents a multiple view element.
Identifies that the name of an element changed.
Indicates an error when setting the name of an element.
Deprecated.
Since BIRT 2.1, there will no such event send by BIRT
The base class of the notification hierarchy.
The format value for the number like integer, float, etc.
 
 
Represents a cube.
Represents an extended data set.
Represents the parameter for ODA drivers.
Represents the parameter for ODA drivers.
Represents a extended data source.
The structure of the Oda designer state.
The structure handle of the Oda designer state.
Represents a dimension element in the cube element.
OdaFilterExprHelper
ODAFilterExprProvider
Represents a Hierarchy.
This class represents one attribute of the level element.
Represents the handle of one column in the oda result set.
Represents a level element.
Handle class for MeasureGroup.
This class represents a measure element.
 
Represents the handle of one column in the oda result set.
Represents the utility class to help compute level of operator.
This class presents the parameter binding that bind data set input parameter to expression by position.
Represents the handle of parameter binding.
Represents the format for the default value of scalar parameter.
Represents a group of parameters.
Represents the various parameter types.
Validates the parameter value with the given data type and format pattern string.
Represents a point in application units.
Represents the "private style" for an element.
Represents the property binding structure.
Represents the handle of property binding structure.
Extension adapter class for the IPropertyDefintion.
Notification event to send when a property changes.
A handle for working with a top-level property of an element.
A handle for working with a top-level property of an element.
This class provides property masks of system or user defined properties.
Represents the handle of property mask structure.
Exception thrown when a property name is invalid.
Indicates an invalid property value.
Utility class to validate the property value.
Represents the position and size of a rectangle in application units.
Represents a rectangle element.
Defines constants for design element name.
Represents the overall report design.
Abstract base class for working with all elements except the report design.
Extension adapter class for the IReportItem.
Adapter class for the IReportItemFactory interface.
Represents a report item: any element that can appear within a section of the report.
Abstract implementation class for the report item handle
Represents a report item theme in the library.
Notification event that says that the module need refreshing.
This class represents one column in the result set.
Represents the handle of one column in the result set.
Represents an object for copy/paste in Gird/Table.
Does table row insert operation.
Does table row insert and paste operation.
Does table row paste operation.
Does table row shift operation.
Represents one row in a Grid or Table.
Prepares parameters for row operation , including copy , paste , insert and shift operation.
This class represents one rule.
Represents a rule handle.
Represents a scalar (single-value) report parameter.
 
Constants for script
Represents a script data set item.
Represents a script data source.
Represents a jar file used for script handle event.
Represents a handle of jar file used for script handle event.
Structure for optional list of search criteria.
Represents the handle of key used for search.
This class is a structure for selection-list in ScalarParameter item.
Represents the handle of selection choice.
The class provides the error code and the element with semantic error.
Represents exceptions encountered during parsing the xml file, it will include a reference to the element which causes the error.
Represents the design state -- a session for a user.
Represents a named, shared style.
The factory class to create scriptable objects.
 
Implements a simple group element handle, which has a non-empty selection element list and root module.
Validates one list property of element.
Represents a simple master page.
Implements of simple item that has no data rows.The constructor in sub class must call super(ExtendedItemHandle).
Abstract base class that represents a handle for the value to either a property or a structure member.
Represents a "slot" within an element.
An Iterator over the elements in a slot.
An sorted iterator over the elements in a slot.
 
This class represents a sort hint.
This class represents sort hint handle.
This class represents a sort entry for a table or list item, it defines the column and sort direction pair.
Represents the handle of sort key structure.
The format value for the string type.
Collection of string utilities.
Provides the factory method to create empty structures.
Handle to a structure within a list property.
Validates one list property of element.
Validates the property whose type is structure reference.
Validates a structure property of element.
Notifies that the style of an element has changed.
Indicates an error while setting the style of an element.
Represents the style properties for either a shared style or an element with a IStyleModel.
Iterates over the styles of an include style sheet.
Validates the style reference value for StyledElement.
Base class for highlight and map rules in the style.
Represents the handle of style rule.
Exception thrown if an error occurs when reading an external style sheet.
Exception thrown if an error occurs when translating an external style sheet to our own CssStyleSheet.
Utility class to provide some methods about the style element, styled element and style properties.
Represents an object of copied objects when do copy/paste operations between tables.
Represent a handle to a table group.
Represents a table element.
Validates the element is not allowed to appear in the specific slot of the given container type in any level.
Represents an object of copied objects when do copy/paste operations between tables.
Represents a cube.
Represents a dimension element in the cube element.
Represents a Hierarchy.
Represents a level element.
Handle class for MeasureGroup.
This class represents a measure element.
Handle for template data sets.
Abstract handle for template elements.
Reports an error during a template related operation.
Represents the method information that can provide code snippet as the template.
Represents a template parameter definition element.
Handle for template report items.
Notification event that says that transformation betweem a template element and a report item or data set occurs.
Represents a multi-line data item element.
Represents a text data item.
Notifies that the style of an element has changed.
Indicates an error while setting the style of an element.
Represents a theme in the library.
Validates the theme reference in the module.
Validates the ducplicat style name in the theme.
The format value for the time.
Time interval structure.
The structure handle of time interval.
The TOC structure defines a TOC.
Represents an "TOC" attached to an element.Obtain an instance of this class by calling the getTOCHandle method on the handle of an element that defines an action.
Class provided to set some options for the transaction.
Represents a translation message in the design.
Class that provides the information for undefined properties set in extended items.
The utility class to handle Unicode encoding and signatures.
Validates whether the element is unsupported in the current release.
Utility class to handle URI.
Describes the user defined choices for a user defined property.
Represents a user-defined property.
Represents a top-level user-defined property of an element.
Indicates a change to a user-defined property.
Reports an error during a user property operation.
Notification event that says that the validation is performed and whether error exists.
Indicates an invalid validation value.
Deprecated. 
Abstract base class for value-based handles.
Validates the property value is required.
Represents a variable.
Notification event that says that multiple views of a container have changed.
An error indicates wrong type while setting the extends property of an element.
The XPath string helps user locate this element in design file.