|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementFactory
public class ElementFactory
Creates a new report elements and returns handles to it. Use this to create
elements. After creating an element, add it to the design using the
add
method in the SlotHandle
class. Obtain an instance of
this class by calling the getElementFactory
method on any
element handle.
SlotHandle
Field Summary | |
---|---|
protected org.eclipse.birt.report.model.core.Module |
module
The module. |
Constructor Summary | |
---|---|
ElementFactory(org.eclipse.birt.report.model.core.Module module)
Constructs a element factory with the given module. |
Method Summary | |
---|---|
AccessControlHandle |
newAccessControl()
Creates an access control element. |
AutoTextHandle |
newAutoText(java.lang.String name)
Creates a new specialfield item. |
CascadingParameterGroupHandle |
newCascadingParameterGroup(java.lang.String name)
Creates a new parameter group element. |
CellHandle |
newCell()
Creates a new cell element. |
DataGroupHandle |
newDataGroup()
Creates a data group element. |
DataItemHandle |
newDataItem(java.lang.String name)
Creates a new data item. |
DesignElementHandle |
newElement(java.lang.String elementTypeName,
java.lang.String name)
Creates a design element specified by the element type name. |
DesignElementHandle |
newElementFrom(DesignElementHandle baseElement,
java.lang.String name)
Creates one new element based on the given element. |
ExtendedItemHandle |
newExtendedItem(java.lang.String name,
java.lang.String extensionName)
Creates a new extended item. |
FilterConditionElementHandle |
newFilterConditionElement()
Creates a filter condition element handle. |
FreeFormHandle |
newFreeForm(java.lang.String name)
Creates a new free-form item. |
GraphicMasterPageHandle |
newGraphicMasterPage(java.lang.String name)
Creates a new graphic master page element. |
GridHandle |
newGridItem(java.lang.String name)
Creates a new grid item. |
GridHandle |
newGridItem(java.lang.String name,
int columnNum,
int rowNum)
Creates a new grid item with pre-defined columns and rows. |
ImageHandle |
newImage(java.lang.String name)
Creates a new image item. |
JointDataSetHandle |
newJointDataSet(java.lang.String name)
Creates a new joint data set. |
LabelHandle |
newLabel(java.lang.String name)
Creates a new label item. |
LineHandle |
newLineItem(java.lang.String name)
Creates a new line item. |
ListHandle |
newList(java.lang.String name)
Creates a new list item. |
ListGroupHandle |
newListGroup()
Creates a new list group element. |
MemberValueHandle |
newMemberValue()
Creates a member value handle. |
MultiViewsHandle |
newMultiView()
Creates a multiple view element handle. |
OdaCubeHandle |
newOdaCube(java.lang.String name)
Creates a new cube element. |
OdaDataSetHandle |
newOdaDataSet(java.lang.String name)
Deprecated. see newOdaDataSet( String name, String extensionID ) |
OdaDataSetHandle |
newOdaDataSet(java.lang.String name,
java.lang.String extensionID)
Creates a new oda data set. |
OdaDataSourceHandle |
newOdaDataSource(java.lang.String name)
Deprecated. see newOdaDataSource( String name, String extensionID ) |
OdaDataSourceHandle |
newOdaDataSource(java.lang.String name,
java.lang.String extensionID)
Creates a new oda data source. |
OdaDimensionHandle |
newOdaDimension(java.lang.String name)
Creates a new dimension element. |
OdaHierarchyHandle |
newOdaHierarchy(java.lang.String name)
Creates a new hierarchy element. |
OdaLevelHandle |
newOdaLevel(DimensionHandle dimensionHandle,
java.lang.String name)
Creates a new oda level handle. |
OdaLevelHandle |
newOdaLevel(java.lang.String name)
Deprecated. replaced by newOdaLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String) |
OdaMeasureHandle |
newOdaMeasure(java.lang.String name)
Creates a new measure element. |
OdaMeasureGroupHandle |
newOdaMeasureGroup(java.lang.String name)
Creates a new measure group. |
ParameterGroupHandle |
newParameterGroup(java.lang.String name)
Creates a new parameter group element. |
RectangleHandle |
newRectangle(java.lang.String name)
Creates a new rectangle. |
ScalarParameterHandle |
newScalarParameter(java.lang.String name)
Creates a new scalar parameter element. |
ScriptDataSetHandle |
newScriptDataSet(java.lang.String name)
Creates a new script data set. |
ScriptDataSourceHandle |
newScriptDataSource(java.lang.String name)
Creates a new script data source. |
SimpleMasterPageHandle |
newSimpleMasterPage(java.lang.String name)
Creates a new simple master page element. |
SortElementHandle |
newSortElement()
Creates a sort element handle. |
SharedStyleHandle |
newStyle(java.lang.String name)
Creates a new style element. |
SharedStyleHandle |
newStyle(ThemeHandle theme,
java.lang.String name)
Creates a new style element, and the style element is supposed to be adding to some theme in Library. |
ColumnHandle |
newTableColumn()
Creates a new column element. |
TableGroupHandle |
newTableGroup()
Creates a new table group element. |
TableHandle |
newTableItem(java.lang.String name)
Creates a new table item. |
TableHandle |
newTableItem(java.lang.String name,
int columnNum)
Creates a new table item with the given name and given column number. |
TableHandle |
newTableItem(java.lang.String name,
int columnNum,
int headerRow,
int detailRow,
int footerRow)
Creates a new table item with the given name and given column number. |
RowHandle |
newTableRow()
Creates a new row element. |
RowHandle |
newTableRow(int cellNum)
Creates a new table row, filled the row with the given number of cells. |
TabularCubeHandle |
newTabularCube(java.lang.String name)
Creates a new cube element. |
TabularDimensionHandle |
newTabularDimension(java.lang.String name)
Creates a new dimension element. |
TabularHierarchyHandle |
newTabularHierarchy(java.lang.String name)
Creates a new hierarchy element. |
TabularLevelHandle |
newTabularLevel(DimensionHandle dimensionHandle,
java.lang.String name)
Creates a new level element within the given dimension handle. |
TabularLevelHandle |
newTabularLevel(java.lang.String name)
Deprecated. replaced by newTabularLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String) |
TabularMeasureHandle |
newTabularMeasure(java.lang.String name)
Creates a new measure element. |
TabularMeasureGroupHandle |
newTabularMeasureGroup(java.lang.String name)
Creates a new measure group. |
TextDataHandle |
newTextData(java.lang.String name)
Creates a new multi line data item. |
TextItemHandle |
newTextItem(java.lang.String name)
Creates a new text item. |
ThemeHandle |
newTheme(java.lang.String name)
Creates a new theme element. |
ValueAccessControlHandle |
newValueAccessControl()
Creates a value access control element. |
VariableElementHandle |
newVariableElement()
Creates a variable element. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.eclipse.birt.report.model.core.Module module
Constructor Detail |
---|
public ElementFactory(org.eclipse.birt.report.model.core.Module module)
module
- the moduleMethod Detail |
---|
public DesignElementHandle newElement(java.lang.String elementTypeName, java.lang.String name)
elementTypeName
- the element type namename
- the optional element name
null
returned if the element
definition name is not a valid element type name.public FreeFormHandle newFreeForm(java.lang.String name)
name
- the optional free-form name. Can be null
.
public DataItemHandle newDataItem(java.lang.String name)
name
- the optional data item name. Can be null
.
public LabelHandle newLabel(java.lang.String name)
name
- the optional label name. Can be null
.
public AutoTextHandle newAutoText(java.lang.String name)
name
- the optional data item name. Can be null
.
public ImageHandle newImage(java.lang.String name)
name
- the optional image name. Can be null
.
public ListGroupHandle newListGroup()
public ListHandle newList(java.lang.String name)
name
- the optional list name. Can be null
.
public GraphicMasterPageHandle newGraphicMasterPage(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the required graphic master page name
public SimpleMasterPageHandle newSimpleMasterPage(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the requirement simple master page name
public ParameterGroupHandle newParameterGroup(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the optional parameter group name. Can be null
.
public CascadingParameterGroupHandle newCascadingParameterGroup(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the optional parameter group name. Can be null
.
public ScalarParameterHandle newScalarParameter(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the required scalar parameter name
public SharedStyleHandle newStyle(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the required style name
public SharedStyleHandle newStyle(ThemeHandle theme, java.lang.String name)
name
is null, we will make a unique name for it.
theme
- the theme to add the stylename
- the required style name
public TextItemHandle newTextItem(java.lang.String name)
name
- the optional text item name. Can be null
.
public TableHandle newTableItem(java.lang.String name)
name
- the optional table item name. Can be null
.
public TableHandle newTableItem(java.lang.String name, int columnNum)
It has the same effect by calling:
newTableItem( name, columnNum, 1, 1, 1 )
.
name
- the optional table item namecolumnNum
- column number of the table, if it is less than 0, then column
won't be defined for the table at this stage.
newTableItem(String, int, int, int, int)
public TableHandle newTableItem(java.lang.String name, int columnNum, int headerRow, int detailRow, int footerRow)
name
- the optional table item namecolumnNum
- column number of the table, if it is less than 0, then column
won't be defined for the table at this stage.headerRow
- number of rows that will be added for header band. If it is
less than 0, none row will be added to header band.detailRow
- number of rows that will be added for detail band. If it is
less than 0, none row will be added to detail band.footerRow
- number of rows that will be added for footer band. If it is
less than 0, none row will be added to footer band.
public TableGroupHandle newTableGroup()
public ColumnHandle newTableColumn()
public RowHandle newTableRow()
public RowHandle newTableRow(int cellNum)
cellNum
- Number of cells to be added to the row.
public CellHandle newCell()
public GridHandle newGridItem(java.lang.String name)
name
- the optional grid item name. Can be null
.
public GridHandle newGridItem(java.lang.String name, int columnNum, int rowNum)
name
- the optional grid item name.columnNum
- column number of the grid. If it is less than 0, none column
will be added.rowNum
- row number of the grid. If it is less than 0, none row will be
added.
public LineHandle newLineItem(java.lang.String name)
name
- the optional line item name. Can be null
.
public RectangleHandle newRectangle(java.lang.String name)
name
- the optional rectangle name. Can be null
.
public TextDataHandle newTextData(java.lang.String name)
name
- the optional multi line data name. Can be null
.
public ExtendedItemHandle newExtendedItem(java.lang.String name, java.lang.String extensionName)
name
- the optional extended item name. Can be null
.extensionName
- the required extension name
null
if the
definition with the given extension name is not foundpublic ScriptDataSourceHandle newScriptDataSource(java.lang.String name)
name
- the required script data source name.
public ScriptDataSetHandle newScriptDataSet(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the required script data set name.
public OdaDataSourceHandle newOdaDataSource(java.lang.String name)
newOdaDataSource( String name, String extensionID )
name
is null, we will make a unique name for it.
name
- the required oda data source name.
public OdaDataSourceHandle newOdaDataSource(java.lang.String name, java.lang.String extensionID)
name
is null, we will make a unique name for it.The
extensionID
is used to find the extension definition.If the
extension ID is not given, the oda data source will be created without
extension. If the unknown extension ID is given, null
will
be returned.
name
- the required oda data source name.extensionID
- the extension ID
public OdaDataSetHandle newOdaDataSet(java.lang.String name)
newOdaDataSet( String name, String extensionID )
name
is null, we will make a unique name for it.
name
- the required oda data set name.
public JointDataSetHandle newJointDataSet(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the required joint data set name.
public OdaDataSetHandle newOdaDataSet(java.lang.String name, java.lang.String extensionID)
name
is null, we will make a unique name for it. The
extensionID
is used to find the extension definition.If the
extension ID is not given, the oda data source will be created without
extension. If the unknown extension ID is given, null
will
be returned.
name
- the required oda data set name.extensionID
- the extension ID
public DesignElementHandle newElementFrom(DesignElementHandle baseElement, java.lang.String name) throws ExtendsException
baseElement
- the base element.name
- the optional new element name
ExtendsException
- if the the base element is in a library that is not included
in this module, or if the "extends" relationship is illegalpublic ThemeHandle newTheme(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the theme item name.
public TabularCubeHandle newTabularCube(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the cube element name.
public TabularDimensionHandle newTabularDimension(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the dimension name
public TabularHierarchyHandle newTabularHierarchy(java.lang.String name)
name
is null, we will make a unique name for it.
name
- hierarchy name
public TabularLevelHandle newTabularLevel(java.lang.String name)
newTabularLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String)
name
is null, we will make a unique name for it.
name
- the level name
public TabularLevelHandle newTabularLevel(DimensionHandle dimensionHandle, java.lang.String name)
name
is null, we will make a unique name
with the given dimension scope for it.
dimensionHandle
- the dimension handle where the level will be insertedname
- the level name
public TabularMeasureHandle newTabularMeasure(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the measure name
public TabularMeasureGroupHandle newTabularMeasureGroup(java.lang.String name)
name
- the optional measure group name.
public AccessControlHandle newAccessControl()
public ValueAccessControlHandle newValueAccessControl()
public OdaCubeHandle newOdaCube(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the cube element name.
public OdaDimensionHandle newOdaDimension(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the dimension name
public OdaHierarchyHandle newOdaHierarchy(java.lang.String name)
name
is null, we will make a unique name for it.
name
- hierarchy name
public OdaLevelHandle newOdaLevel(java.lang.String name)
newOdaLevel(org.eclipse.birt.report.model.api.olap.DimensionHandle, String)
name
is null, we will make a unique name for it.
name
- the level name
public OdaLevelHandle newOdaLevel(DimensionHandle dimensionHandle, java.lang.String name)
dimensionHandle
- the dimension handle where the level will be insertedname
- the level name
public OdaMeasureHandle newOdaMeasure(java.lang.String name)
name
is null, we will make a unique name for it.
name
- the measure name
public OdaMeasureGroupHandle newOdaMeasureGroup(java.lang.String name)
name
- the optional measure group name.
public MemberValueHandle newMemberValue()
public SortElementHandle newSortElement()
public FilterConditionElementHandle newFilterConditionElement()
public MultiViewsHandle newMultiView()
public VariableElementHandle newVariableElement()
public DataGroupHandle newDataGroup()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |