Interface IReportContent
public interface IReportContent
The object represents the report content as a whole.
-
Method Summary
Modifier and TypeMethodDescriptioncreate a anction content.create the auto text content.create a cell content.create a container content.create the data content.createDataContent
(IContent content) create the data content, copy the properties from the template content.create the foreign content.create the image content.createImageContent
(IContent content) create the image content, copy the properties from the template content.create the label content.createLabelContent
(IContent content) create the label content, copy the properties from the template content.Create the list band contentCreate the list contentCreate the list group contentcreate a page content.create the row content.create a style.Create the table band contentcreate an table content.Create the table group contentcreate the text content.createTextContent
(IContent content) create the text content, copy the properties from the template content.find the named style.getACL()
Get the ACLgetContent
(InstanceID id) return the content in this report.org.eclipse.birt.report.engine.ir.Report
get the report design used to create this report content.get the error list which occurs in the generation.Get the extensionsgetPageContent
(long pageNumber) The page content in the report content.org.eclipse.birt.report.engine.api.script.IReportContext
getRoot()
Get the root contentgetTitle()
Get the titlegetTOC()
Deprecated.getTOCTree
(String format, com.ibm.icu.util.ULocale locale) Gets the toc tree of this report content.long
Get the total pageGet the user propertiesvoid
readContent
(DataInputStream in, ClassLoader loader) Read contentvoid
Set the ACLvoid
setExtensions
(Map<String, Object> properties) Set the extensionsvoid
void
Write the content
-
Method Details
-
getDesign
org.eclipse.birt.report.engine.ir.Report getDesign()get the report design used to create this report content.- Returns:
- the report design.
-
getErrors
List getErrors()get the error list which occurs in the generation.- Returns:
- error list.
-
getTOC
Deprecated.This method shoule be substituted by:
getTOCTree( format, locale ).getTOCTree( );
get the TOC structure constructed in the generation.- Returns:
- the TOC structure.
-
getTOCTree
Gets the toc tree of this report content.- Parameters:
format
-locale
-- Returns:
- the TOC Tree
-
getRoot
IContent getRoot()Get the root content- Returns:
- Return the root content
-
getTotalPage
long getTotalPage()Get the total page- Returns:
- Return the total page
-
getPageContent
The page content in the report content. If the page is not exist, return NULL.- Parameters:
pageNumber
- page number- Returns:
- the page content object.
-
getContent
return the content in this report.- Parameters:
id
- content id- Returns:
- the content object
-
findStyle
find the named style.- Parameters:
styleClass
- style name.- Returns:
- style named with the name, null if not exists.
-
createActionContent
IHyperlinkAction createActionContent()create a anction content. The action content can only be use in this report content.- Returns:
- the action content.
-
createStyle
IStyle createStyle()create a style. the style can only be used in this report.- Returns:
- style created.
-
createCellContent
ICellContent createCellContent()create a cell content. the content can only be used in this report.- Returns:
- cell content.
-
createContainerContent
IContainerContent createContainerContent()create a container content. the content can only be used in this report.- Returns:
- the container content.
-
createPageContent
IPageContent createPageContent()create a page content. the page content can only be used in this report.- Returns:
- the page content.
-
createTableContent
ITableContent createTableContent()create an table content. the table content can only be used in this report.- Returns:
- the table.
-
createTableGroupContent
ITableGroupContent createTableGroupContent()Create the table group content- Returns:
- Return the table group content
-
createTableBandContent
ITableBandContent createTableBandContent()Create the table band content- Returns:
- Return the table band content
-
createListContent
IListContent createListContent()Create the list content- Returns:
- Return the list content
-
createListGroupContent
IListGroupContent createListGroupContent()Create the list group content- Returns:
- Return the list group content
-
createListBandContent
IListBandContent createListBandContent()Create the list band content- Returns:
- Return the list band content
-
createRowContent
IRowContent createRowContent()create the row content. the row can only be used in this report.- Returns:
- the row content.
-
createTextContent
ITextContent createTextContent()create the text content. the text can only be used in this report.- Returns:
- the text content.
-
createTextContent
create the text content, copy the properties from the template content. the text can only be used in this report.- Parameters:
content
- the content template.- Returns:
- the text content.
-
createForeignContent
IForeignContent createForeignContent()create the foreign content. the foreign content can only be used in this report.- Returns:
- the foreign content
-
createImageContent
IImageContent createImageContent()create the image content. the image can only be used in this report.- Returns:
- the image content.
-
createImageContent
create the image content, copy the properties from the template content. the image can only be used in this report.- Parameters:
content
- the content template.- Returns:
- the image content.
-
createLabelContent
ILabelContent createLabelContent()create the label content. the label can only be used in this report.- Returns:
- the label content.
-
createAutoTextContent
IAutoTextContent createAutoTextContent()create the auto text content. the auto text can only be used in this report.- Returns:
- the auto text content.
-
createLabelContent
create the label content, copy the properties from the template content. the label can only be used in this report.- Parameters:
content
- the content template.- Returns:
- the label content.
-
createDataContent
IDataContent createDataContent()create the data content. the data can only be used in this report.- Returns:
- the data content.
-
createDataContent
create the data content, copy the properties from the template content. the data can only be used in this report.- Parameters:
content
- the content template.- Returns:
- the data content.
-
getACL
String getACL()Get the ACL- Returns:
- Return the ACL
-
setACL
Set the ACL- Parameters:
acl
-
-
getReportContext
org.eclipse.birt.report.engine.api.script.IReportContext getReportContext()- Returns:
- the ReportContext
-
getUserProperties
Get the user properties- Returns:
- Return the user properties
-
getExtensions
Get the extensions- Returns:
- Return the extensions
-
setExtensions
Set the extensions- Parameters:
properties
- properties of extensions
-
writeContent
Write the content- Parameters:
out
- output stream- Throws:
IOException
-
readContent
Read content- Parameters:
in
- input streamloader
- class loader- Throws:
IOException
-
getTitle
String getTitle()Get the title- Returns:
- Return the title
-
setTitle
-
getTOCTree( format, locale ).getTOCTree( );