# Uses of Package
org.eclipse.birt.report.model.api

Packages that use org.eclipse.birt.report.model.api
Package
Description
org.eclipse.birt.report.model.api
Tool-writer's interface for the BIRT design model (also known as the "Design Engine.")
org.eclipse.birt.report.model.api.activity
Manages the low-level undoable operations and event notifications.
org.eclipse.birt.report.model.api.command
Provides events when some command operations modify the state of the Design Engine.
org.eclipse.birt.report.model.api.core
Represents the fundamental data structures of the user-defined property and the interface of UI listener.
org.eclipse.birt.report.model.api.css
org.eclipse.birt.report.model.api.elements
Constants definition for the pre-defined choices and report elements and items.
org.eclipse.birt.report.model.api.elements.structures
Defines the structure types in Model system.
org.eclipse.birt.report.model.api.elements.table
org.eclipse.birt.report.model.api.extension
Defines the fundamental interfaces for those extensions from the reportitem extension point.
org.eclipse.birt.report.model.api.impl
org.eclipse.birt.report.model.api.metadata
Defines the elements, properties, types, structures and slots in the Report Object Model.
org.eclipse.birt.report.model.api.olap
org.eclipse.birt.report.model.api.simpleapi
Report element representations in the BIRT simple API environment.
org.eclipse.birt.report.model.api.util
Utility classes.
org.eclipse.birt.report.model.api.validators
Provides the validation classes for semantic check on multiple properties.

Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api
Class
Description
AbstractScalarParameterHandle
Represents the abstract scalar parameter types.
AbstractScalarParameterHandleImpl
Represents the abstract scalar parameter types.
AbstractThemeHandle
Represents a abstract theme in the library.
AccessControlHandle
Deprecated.
ActionHandle
Represents an "action" (hyperlink) attached to an element.
AggregationArgumentHandle
AggregationArgumentHandle.
CachedMetaDataHandle
Structure handle to deal with cached data set metadata informations.
CalculationArgumentHandle
CalculationArgumentHandle.
CascadingParameterGroupHandle
Represents the group of cascading parameters.
CascadingParameterGroupHandleImpl
Represents the group of cascading parameters.
CellHandle
Represents a cell within a table or grid.
ColorHandle
Handle to work with a color property.
ColumnBandData
Represents the data structure to store copied objects like the column and cells.
ColumnHandle
Represents a column within a table.
CommandStack
Application-level interface into the Model's command stack.
ComplexValueHandle
Abstract class for working with properties that have internal structure, such as a color, a dimension or a font.
ComputedColumnHandle
Represents the handle of computed column.
ContentElementHandle
DataSetHandle
Abstract handle for data set elements.
DataSetParameterHandle
Represents the parameter for data set drivers.
DataSourceHandle
This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
DesignConfig
Wraps around configuration settings for design engine.
DesignElementHandle
Base class for all report elements.
DesignFileException
Signals that a fatal error occurred when opening a design file.
DimensionHandle
Simplifies working with dimension properties.
DimensionJoinConditionHandle
Represents a dimension join condition in the DimensionCondition.
ElementDetailHandle
Abstract base class for property handles, slot handles, structure handles an other handles that provide detail about a report element.
ElementFactory
Creates a new report elements and returns handles to it.
EmbeddedImageHandle
Represents the handle of an embedded image.
ErrorCodes
Implements to define the error codes that are exposed to api.
ErrorDetail
Provides detail information about errors found when opening a design file.
Expression
Represents the object for the expression.
ExpressionHandle
Simplifies working with expression properties.
ExpressionListHandle
Simplifies working with expression lists.
FactoryElementHandle
Factory element handle class to retrieve some factory styles.
FactoryPropertyHandle
A specialized handle for use when creating the Factory data structures.
FilterConditionElementHandle
FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.
FontHandle
Simplifies working with the font family property.
GridHandle
Represents a grid item in the design.
GroupElementHandle
This class provides services to deal with a group of elements.
GroupHandle
Represents both list and table groups in the design.
GroupPropertyHandle
A handle for working with a top-level property of a collection of elements.
IBundleFactory
Retrieves resources in the Eclipse bundle.
IDesignConfig
IDesignEngine
Represents the BIRT design engine as a whole.
IDesignEngineFactory
Factory class to create an instance of DesignEngine
IModuleOption
Implements to define the keys to do some setting in a module.
IncludedCssStyleSheetHandle
Represents a included css style sheet in report design and theme.
IResourceLocator
Implements this interface to provide a custom file search algorithm.
JointDataSetHandle
Provides API to operate a joint data set.
LevelAttributeHandle
Represents the handle of one column in the result set.
LibraryHandle
Represents the handle of library element.
LibraryHandleImpl
ListingHandle
Represents slots and common properties in the two list-oriented elements: table and list.
MasterPageHandle
Represents a master page.
MemberHandle
A handle to a member of a property structure.
MemberValueHandle
CrosstabMemberValueHandle
ModelException
Implementation of BirtException in model project.
ModuleHandle
Abstract module handle which provides the common functionalities of report design and library.
ModuleHandleImpl
Abstract module handle which provides the common functionalities of report design and library.
OdaDesignerStateHandle
The structure handle of the Oda designer state.
ParameterGroupHandle
Represents a group of parameters.
ParameterHandle
Represents the various parameter types.
PrivateStyleHandle
Represents the "private style" for an element.
PropertyHandle
A handle for working with a top-level property of an element.
PropertyHandleImpl
A handle for working with a top-level property of an element.
ReportDesignHandle
Represents the overall report design.
ReportElementHandle
Abstract base class for working with all elements except the report design.
ReportItemHandle
Represents a report item: any element that can appear within a section of the report.
ReportItemHandleImpl
Abstract implementation class for the report item handle
ReportItemThemeHandle
Represents a report item theme in the library.
ResultSetColumnHandle
Represents the handle of one column in the result set.
RowBandAdapter
Represents an object for copy/paste in Gird/Table.
RowHandle
Represents one row in a Grid or Table.
RowOperationParameters
Prepares parameters for row operation , including copy , paste , insert and shift operation.
ScriptLibHandle
Represents a handle of jar file used for script handle event.
SessionHandle
Represents the design state -- a session for a user.
SharedStyleHandle
Represents a named, shared style.
SimpleValueHandle
Abstract base class that represents a handle for the value to either a property or a structure member.
SlotHandle
Represents a "slot" within an element.
SortHintHandle
This class represents sort hint handle.
StructureHandle
Handle to a structure within a list property.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
StyleRuleHandle
Represents the handle of style rule.
TableHandle
Represents a table element.
TemplateDataSetHandle
Handle for template data sets.
TemplateElementHandle
Abstract handle for template elements.
TextDataHandle
Represents a multi-line data item element.
ThemeHandle
Represents a theme in the library.
TOCHandle
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.
TranslationHandle
Represents a translation message in the design.
UserPropertyDefnHandle
Represents a top-level user-defined property of an element.
ValueHandle
Abstract base class for value-based handles.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.activity
Class
Description
ModelException
Implementation of BirtException in model project.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.command
Class
Description
ModelException
Implementation of BirtException in model project.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.core
Class
Description
DesignElementHandle
Base class for all report elements.
ModuleHandle
Abstract module handle which provides the common functionalities of report design and library.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.css
Class
Description
DesignElementHandle
Base class for all report elements.
ElementDetailHandle
Abstract base class for property handles, slot handles, structure handles an other handles that provide detail about a report element.
ModelException
Implementation of BirtException in model project.
ModuleHandle
Abstract module handle which provides the common functionalities of report design and library.
SharedStyleHandle
Represents a named, shared style.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.elements
Class
Description
ModelException
Implementation of BirtException in model project.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.elements.structures
Class
Description
Expression
Represents the object for the expression.
SimpleValueHandle
Abstract base class that represents a handle for the value to either a property or a structure member.
StructureHandle
Handle to a structure within a list property.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.elements.table
Class
Description
CellHandle
Represents a cell within a table or grid.
RowHandle
Represents one row in a Grid or Table.
SlotHandle
Represents a "slot" within an element.
TableGroupHandle
Represent a handle to a table group.
TableHandle
Represents a table element.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.extension
Class
Description
DesignElementHandle
Base class for all report elements.
ExtendedItemHandle
Represents an extended element.
ModelException
Implementation of BirtException in model project.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.impl
Class
Description
ActionHandle
Represents an "action" (hyperlink) attached to an element.
ComputedColumnHandle
Represents the handle of computed column.
DataSetHandle
Abstract handle for data set elements.
DataSourceHandle
This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
DesignConfig
Wraps around configuration settings for design engine.
DesignElementHandle
Base class for all report elements.
DesignFileException
Signals that a fatal error occurred when opening a design file.
ExtendedItemHandle
Represents an extended element.
FilterConditionElementHandle
FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.
HideRuleHandle
Represents the handle of visibility rule.
HighlightRuleHandle
Represents a highlight rule in the highlight property of a style.
IDesignEngine
Represents the BIRT design engine as a whole.
IDesignEngineFactory
Factory class to create an instance of DesignEngine
IModuleOption
Implements to define the keys to do some setting in a module.
ReportItemHandle
Represents a report item: any element that can appear within a section of the report.
ResultSetColumnHandle
Represents the handle of one column in the result set.
SessionHandle
Represents the design state -- a session for a user.
SortElementHandle
SortKeyHandle
Represents the handle of sort key structure.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.metadata
Class
Description
ModelException
Implementation of BirtException in model project.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.olap
Class
Description
ActionHandle
Represents an "action" (hyperlink) attached to an element.
DataSetHandle
Abstract handle for data set elements.
DesignElementHandle
Base class for all report elements.
DimensionConditionHandle
Represents the handle of the cube-dimension/hierarchy join condition.
ExpressionHandle
Simplifies working with expression properties.
FormatValueHandle
Represents a format value in the style or the highlight rule.
ReportElementHandle
Abstract base class for working with all elements except the report design.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.simpleapi
Class
Description
ActionHandle
Represents an "action" (hyperlink) attached to an element.
ComputedColumnHandle
Represents the handle of computed column.
DataSetHandle
Abstract handle for data set elements.
DataSourceHandle
This abstract class represents a data source element: a connection to an external data provider such as an SQL database.
DesignElementHandle
Base class for all report elements.
ExtendedItemHandle
Represents an extended element.
FilterConditionElementHandle
FilterConditionHandle
Represents one filter in the filter list of List, Table or their Groups.
HideRuleHandle
Represents the handle of visibility rule.
HighlightRuleHandle
Represents a highlight rule in the highlight property of a style.
ReportItemHandle
Represents a report item: any element that can appear within a section of the report.
ResultSetColumnHandle
Represents the handle of one column in the result set.
SortElementHandle
SortKeyHandle
Represents the handle of sort key structure.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.util
Class
Description
ComputedColumnHandle
Represents the handle of computed column.
DataSetHandle
Abstract handle for data set elements.
DesignElementHandle
Base class for all report elements.
DesignFileException
Signals that a fatal error occurred when opening a design file.
ExtendedItemHandle
Represents an extended element.
LibraryHandle
Represents the handle of library element.
ModuleHandle
Abstract module handle which provides the common functionalities of report design and library.
PropertyHandle
A handle for working with a top-level property of an element.
ReportDesignHandle
Represents the overall report design.
ReportItemHandle
Represents a report item: any element that can appear within a section of the report.
StructureHandle
Handle to a structure within a list property.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.
ThemeHandle
Represents a theme in the library.
Classes in org.eclipse.birt.report.model.api used by org.eclipse.birt.report.model.api.validators
Class
Description
AbstractThemeHandle
Represents a abstract theme in the library.
DesignElementHandle
Base class for all report elements.
GroupHandle
Represents both list and table groups in the design.
ListingHandle
Represents slots and common properties in the two list-oriented elements: table and list.
StyleHandle
Represents the style properties for either a shared style or an element with a IStyleModel.