Class DesignVisitor
java.lang.Object
org.eclipse.birt.report.model.api.DesignVisitor
Applies logic customized to each type of report element. This is an
implementation of the classic visitor pattern. The application creates a
derived iterator, and overrides methods for the elements of interest. The
visitor can also walk the design tree, performing actions on each element
down the containment hierarchy.
By default, each method calls the method for its parent element. That is, a DataItem method calls the ReportItem method which calls the DesignElement method.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.eclipse.birt.report.model.api.DesignVisitorImpl.Forwarder
The private internal element visitor. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs aDesignVisitor
, which is not related with the specific report. -
Method Summary
Modifier and TypeMethodDescriptionvoid
apply
(DesignElementHandle handle) Applies this visitor to the given element.protected void
Visits the abstract theme element.protected void
Visits auto text elementprotected void
Visits the cascading parameter group element.protected void
visitCell
(CellHandle obj) Visits the cell element.protected void
visitColumn
(ColumnHandle obj) Visits the column element.protected void
visitContents
(DesignElementHandle obj, String propName) Visits the content of this property.protected void
visitContents
(SlotHandle slot) Visits the content of the slot.protected void
visitCube
(CubeHandle obj) Visits the cube element.protected void
Visits the data element.protected void
Visits the data set element.protected void
Visits the data source element.protected void
Visits the derived data set element.protected void
Visits the design element.protected void
Visits the dimension element.protected void
Visits the dynamic filter parameter element.protected void
Visits the extended data set element.protected void
Visits the extended data source element.protected void
Visits the extended element.protected void
Visits the free form element.protected void
Visits the graphic master page element.protected void
visitGrid
(GridHandle obj) Visits the grid element.protected void
visitGroup
(GroupHandle obj) Visits the group element.protected void
Visits the hierarchy element.protected void
visitImage
(ImageHandle obj) Visits the image element.protected void
Visits the joint data set element.protected void
visitLabel
(LabelHandle obj) Visits the label element.protected void
visitLevel
(LevelHandle obj) Visits the level element.protected void
Visits the library element.protected void
visitLine
(LineHandle obj) Visits the line element.protected void
visitList
(ListHandle obj) Visits the list element.protected void
Visits the list group element.protected void
Visits the master page element.protected void
Visits the measure element.protected void
Visits the measure element.protected void
visitModule
(ModuleHandle obj) Visits the module elementprotected void
Visits the cube element.protected void
Visits the dimension element.protected void
Visits the hierarchy element.protected void
Visits the level element.protected void
Visits the measure element.protected void
Visits the measure element.protected void
Visits the parameter element.protected void
Visits the parameter group element.protected void
Visits the rectangle element.protected void
Visits the report design element.protected void
Visits the report item.protected void
Visits the report item theme element.protected void
Visits the row element.protected void
Visits the scalar parameter element.protected void
Visits the script data set element.protected void
Visits the extended element.protected void
Visits the simple data set element.protected void
Visits the simple master page element.protected void
visitStyle
(StyleHandle obj) Visits the style element.protected void
Visits the styled element.protected void
visitTable
(TableHandle obj) Visits the table element.protected void
Visits the table group element.protected void
Visits the cube element.protected void
Visits the dimension element.protected void
Visits the hierarchy element.protected void
Visits the level element.protected void
Visits the measure element.protected void
Visits the measure element.protected void
Visits the template data set.protected void
Visits the template element.protected void
Visits the template parameter definition.protected void
Visits the template report item.protected void
Visits the multi-line data element.protected void
Visits the text element.protected void
visitTheme
(ThemeHandle obj) Visits the theme element.
-
Field Details
-
forwarder
protected org.eclipse.birt.report.model.api.DesignVisitorImpl.Forwarder forwarderThe private internal element visitor.
-
-
Constructor Details
-
DesignVisitor
public DesignVisitor()Constructs aDesignVisitor
, which is not related with the specific report.
-
-
Method Details
-
apply
Applies this visitor to the given element.- Parameters:
handle
- handle to the element to visit.
-
visitFreeForm
Visits the free form element.- Parameters:
obj
- the handle of the free form to traverse
-
visitAutoText
Visits auto text element- Parameters:
obj
-
-
visitDataSet
Visits the data set element.- Parameters:
obj
- the handle of the data set to traverse
-
visitSimpleDataSet
Visits the simple data set element.- Parameters:
obj
- the handle of the simple data set to traverse
-
visitScriptDataSet
Visits the script data set element.- Parameters:
obj
- the handle of the script data set to traverse
-
visitJointDataSet
Visits the joint data set element.- Parameters:
obj
- the handle of the joint data set to traverse
-
visitDataSource
Visits the data source element.- Parameters:
obj
- the handle of data source to traverse
-
visitLabel
Visits the label element.- Parameters:
obj
- the handle of the label to traverse
-
visitDataItem
Visits the data element.- Parameters:
obj
- the handle of the data to traverse
-
visitTextItem
Visits the text element.- Parameters:
obj
- the handle of the text to traverse
-
visitImage
Visits the image element.- Parameters:
obj
- the handle of the image to traverse
-
visitList
Visits the list element.- Parameters:
obj
- the handle of the list to traverse
-
visitGroup
Visits the group element.- Parameters:
obj
- the handle of the group to traverse
-
visitListGroup
Visits the list group element.- Parameters:
obj
- the handle of the list group to traverse
-
visitTable
Visits the table element.- Parameters:
obj
- the handle of the table to traverse
-
visitTableGroup
Visits the table group element.- Parameters:
obj
- the handle of the table group to traverse
-
visitCell
Visits the cell element.- Parameters:
obj
- the handle of the cell to traverse
-
visitColumn
Visits the column element.- Parameters:
obj
- the handle of the column to traverse
-
visitRow
Visits the row element.- Parameters:
obj
- the handle of the row to traverse
-
visitGrid
Visits the grid element.- Parameters:
obj
- the handle of the grid to traverse
-
visitLine
Visits the line element.- Parameters:
obj
- the handle of the line to traverse
-
visitMasterPage
Visits the master page element.- Parameters:
obj
- the handle of the master page to traverse
-
visitParameterGroup
Visits the parameter group element.- Parameters:
obj
- the handle of the parameter group to traverse
-
visitCascadingParameterGroup
Visits the cascading parameter group element.- Parameters:
obj
- the handle of the cascading parameter group to traverse
-
visitModule
Visits the module element- Parameters:
obj
- the handle of the module to traverse
-
visitLibrary
Visits the library element.- Parameters:
obj
- the handle of the library to traverse
-
visitReportDesign
Visits the report design element.- Parameters:
obj
- the handle of the report design to traverse
-
visitScalarParameter
Visits the scalar parameter element.- Parameters:
obj
- the handle of the scalar parameter to traverse
-
visitDynamicFilterParameter
Visits the dynamic filter parameter element.- Parameters:
obj
- the handle of the dynamic filter parameter to traverse.
-
visitStyle
Visits the style element.- Parameters:
obj
- the handle of the style to traverse
-
visitParameter
Visits the parameter element.- Parameters:
obj
- the handle of the parameter to traverse
-
visitReportItem
Visits the report item.- Parameters:
obj
- the handle of report item to traverse
-
visitStyledElement
Visits the styled element.- Parameters:
obj
- the handle of styled element to traverse
-
visitDesignElement
Visits the design element.- Parameters:
obj
- the handle of design element to traverse
-
visitRectangle
Visits the rectangle element.- Parameters:
obj
- the handle of rectangle to traverse
-
visitContents
Visits the content of the slot.- Parameters:
slot
- the handle of a slot to traverse
-
visitContents
Visits the content of this property.- Parameters:
obj
- the container element where the contents residepropName
- name of the property where the contents reside
-
visitTextDataItem
Visits the multi-line data element.- Parameters:
obj
- the handle of a multi-line data to traverse
-
visitExtendedItem
Visits the extended element.- Parameters:
obj
- the handle of an extended element to traverse
-
visitScriptDataSource
Visits the extended element.- Parameters:
obj
- the handle of an extended element to traverse
-
visitGraphicMasterPage
Visits the graphic master page element.- Parameters:
obj
- the handle of a graphic master page to traverse
-
visitSimpleMasterPage
Visits the simple master page element.- Parameters:
obj
- the handle of a simple master page to traverse
-
visitExtendedDataSource
Visits the extended data source element.- Parameters:
obj
- the handle of a extended data source to traverse
-
visitExtendedDataSet
Visits the extended data set element.- Parameters:
obj
- the extended data set to traverse
-
visitTheme
Visits the theme element.- Parameters:
obj
- the theme to traverse
-
visitTemplateParameterDefinition
Visits the template parameter definition.- Parameters:
obj
- the template parameter definition to traverse
-
visitTemplateElement
Visits the template element.- Parameters:
obj
- the template element to traverse
-
visitTemplateReportItem
Visits the template report item.- Parameters:
obj
- the template report item to traverse
-
visitTemplateDataSet
Visits the template data set.- Parameters:
obj
- the template data set to traverse
-
visitTabularCube
Visits the cube element.- Parameters:
obj
- the cube element to traverse
-
visitTabularDimension
Visits the dimension element.- Parameters:
obj
- the dimension element to traverse
-
visitTabularHierarchy
Visits the hierarchy element.- Parameters:
obj
- the hierarchy element to traverse
-
visitTabularLevel
Visits the level element.- Parameters:
obj
- the level element to traverse
-
visitTabularMeasure
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitTabularMeasureGroup
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitOdaCube
Visits the cube element.- Parameters:
obj
- the cube element to traverse
-
visitOdaDimension
Visits the dimension element.- Parameters:
obj
- the dimension element to traverse
-
visitOdaHierarchy
Visits the hierarchy element.- Parameters:
obj
- the hierarchy element to traverse
-
visitOdaLevel
Visits the level element.- Parameters:
obj
- the level element to traverse
-
visitOdaMeasure
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitOdaMeasureGroup
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitCube
Visits the cube element.- Parameters:
obj
- the cube element to traverse
-
visitDimension
Visits the dimension element.- Parameters:
obj
- the dimension element to traverse
-
visitHierarchy
Visits the hierarchy element.- Parameters:
obj
- the hierarchy element to traverse
-
visitLevel
Visits the level element.- Parameters:
obj
- the level element to traverse
-
visitMeasure
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitMeasureGroup
Visits the measure element.- Parameters:
obj
- the measure element to traverse
-
visitDerivedDataSet
Visits the derived data set element.- Parameters:
obj
- the derived data set element to traverse
-
visitReportItemTheme
Visits the report item theme element.- Parameters:
obj
- the report item theme to traverse
-
visitAbstractTheme
Visits the abstract theme element.- Parameters:
obj
- the abstract theme to traverse
-