Interface IContent
- All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement
,IElement
,IStyledElement
- All Known Subinterfaces:
IAutoTextContent
,IBandContent
,ICellContent
,IContainerContent
,IDataContent
,IForeignContent
,IGroupContent
,IImageContent
,ILabelContent
,IListBandContent
,IListContent
,IListGroupContent
,IPageContent
,IRowContent
,ITableBandContent
,ITableContent
,ITableGroupContent
,ITextContent
public interface IContent
extends IElement, org.eclipse.birt.report.engine.css.engine.CSSStylableElement, IStyledElement
object created by report generator.
the content of report document.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
property: auto text content keystatic final int
property: cell content keystatic final int
property: container content keystatic final int
property: data content keystatic final int
property: document extensionstatic final int
property: foreign content keystatic final int
property: group content keystatic final int
property: image content keystatic final int
property: label content keystatic final int
property: layout extensionstatic final int
property: list band content keystatic final int
property: list content keystatic final int
property: list group content keystatic final int
property: page content keystatic final int
property: report content keystatic final int
property: row content keystatic final int
property: serialize content keystatic final int
property: table band content keystatic final int
property: table content keystatic final int
property: table group content keystatic final int
property: text content key -
Method Summary
Modifier and TypeMethodDescriptionaccept
(IContentVisitor visitor, Object value) Use visitor to process the object.cloneContent
(boolean isDeep) Clone the contentgetACL()
Get ACLGet the alternative textGet the alternative text keyGet the bookmarkint
the content type, must be one of the predefines.getExtension
(int extension) Get the extensionGet the extensionsGet the design object which create this content.org.eclipse.birt.report.engine.ir.DimensionType
Get the specified value, the actual height is defined in IBoundsGet the help textGet the hyperlink actionGet the inline styleget the instance id of the content.getName()
Get the name.Get the report which contains/create this content.Get the result setgetTOC()
Get the table of contentGet user propertiesorg.eclipse.birt.report.engine.ir.DimensionType
getWidth()
specified value, the real value is defined in IBoundsorg.eclipse.birt.report.engine.ir.DimensionType
getX()
Get the specified value, the real value is defined in IBoundsorg.eclipse.birt.report.engine.ir.DimensionType
getY()
Get the specified value, the real value is defined in IBoundsboolean
Has childrenboolean
Is direction RTLboolean
Check is last childboolean
isRTL()
Is RTL usedvoid
readContent
(DataInputStream in, ClassLoader loader) Read the contentvoid
Set the ACLvoid
setAltText
(String altText) Set the alternative textvoid
setAltTextKey
(String altTextKey) Set the alternative text keyvoid
setBookmark
(String bookmark) Set the bookmarkvoid
setExtension
(int extension, Object value) Set the extension of the content.void
setExtensions
(Map<String, Object> values) Set the extensionsvoid
setGenerateBy
(Object generateBy) Set the generated by objectvoid
setHasChildren
(boolean hasChildren) Set has childrenvoid
setHeight
(org.eclipse.birt.report.engine.ir.DimensionType height) Set the element heightvoid
setHelpText
(String help) Set the help textvoid
setHyperlinkAction
(IHyperlinkAction hyperlink) Set the hyperlink actionvoid
setInlineStyle
(IStyle style) Set the inline stylevoid
set the instace id of the content.void
setLastChild
(boolean isLastChild) Set is last childvoid
Set the namevoid
setReportContent
(IReportContent report) Set the report content.void
setTagType
(String tagType) Set the PDF tag typevoid
Get the table of contentvoid
setUserProperties
(Map<String, Object> values) Set the user propertiesvoid
setWidth
(org.eclipse.birt.report.engine.ir.DimensionType width) Set the element widthvoid
setX
(org.eclipse.birt.report.engine.ir.DimensionType x) Set the x position of the report itemvoid
setY
(org.eclipse.birt.report.engine.ir.DimensionType y) Set the y position of the report itemvoid
Write the contentMethods inherited from interface org.eclipse.birt.report.engine.css.engine.CSSStylableElement
getComputedStyle, getCSSEngine, getStyle
Methods inherited from interface org.eclipse.birt.report.engine.content.IElement
getChildren, getParent, setParent
Methods inherited from interface org.eclipse.birt.report.engine.content.IStyledElement
getComputedStyle, getStyle, getStyleClass, setStyleClass
-
Field Details
-
SERIALIZE_CONTENT
static final int SERIALIZE_CONTENTproperty: serialize content key- See Also:
-
REPORT_CONTENT
static final int REPORT_CONTENTproperty: report content key- See Also:
-
CELL_CONTENT
static final int CELL_CONTENTproperty: cell content key- See Also:
-
CONTAINER_CONTENT
static final int CONTAINER_CONTENTproperty: container content key- See Also:
-
DATA_CONTENT
static final int DATA_CONTENTproperty: data content key- See Also:
-
FOREIGN_CONTENT
static final int FOREIGN_CONTENTproperty: foreign content key- See Also:
-
IMAGE_CONTENT
static final int IMAGE_CONTENTproperty: image content key- See Also:
-
LABEL_CONTENT
static final int LABEL_CONTENTproperty: label content key- See Also:
-
PAGE_CONTENT
static final int PAGE_CONTENTproperty: page content key- See Also:
-
ROW_CONTENT
static final int ROW_CONTENTproperty: row content key- See Also:
-
TABLE_BAND_CONTENT
static final int TABLE_BAND_CONTENTproperty: table band content key- See Also:
-
TABLE_CONTENT
static final int TABLE_CONTENTproperty: table content key- See Also:
-
TEXT_CONTENT
static final int TEXT_CONTENTproperty: text content key- See Also:
-
AUTOTEXT_CONTENT
static final int AUTOTEXT_CONTENTproperty: auto text content key- See Also:
-
LIST_CONTENT
static final int LIST_CONTENTproperty: list content key- See Also:
-
LIST_BAND_CONTENT
static final int LIST_BAND_CONTENTproperty: list band content key- See Also:
-
GROUP_CONTENT
static final int GROUP_CONTENTproperty: group content key- See Also:
-
LIST_GROUP_CONTENT
static final int LIST_GROUP_CONTENTproperty: list group content key- See Also:
-
TABLE_GROUP_CONTENT
static final int TABLE_GROUP_CONTENTproperty: table group content key- See Also:
-
DOCUMENT_EXTENSION
static final int DOCUMENT_EXTENSIONproperty: document extension- See Also:
-
LAYOUT_EXTENSION
static final int LAYOUT_EXTENSIONproperty: layout extension- See Also:
-
-
Method Details
-
getContentType
int getContentType()the content type, must be one of the predefines.- Returns:
- content type
-
getInstanceID
InstanceID getInstanceID()get the instance id of the content. the instance id is the unique id of the content.- Returns:
- instance id
-
setInstanceID
set the instace id of the content. the instance id can only be set by the content generator.- Parameters:
id
-
-
getExtension
Get the extension- Parameters:
extension
-- Returns:
- extension
-
setExtension
Set the extension of the content. Only 2 extension supported so far- 0: document extension
- 1: layout extension
- Parameters:
extension
- extension typevalue
- extension value- Throws:
ArrayIndexOutOfBoundsException
- if index is out of range {0,1}
-
getReportContent
IReportContent getReportContent()Get the report which contains/create this content.- Returns:
- report the report which contains/create this content.
-
setReportContent
Set the report content.- Parameters:
report
- report content
-
getName
String getName()Get the name.- Returns:
- name
-
setName
Set the name- Parameters:
name
-
-
getGenerateBy
Object getGenerateBy()Get the design object which create this content.- Returns:
- the design object which create this content.
-
setGenerateBy
Set the generated by object- Parameters:
generateBy
- generated by
-
getInlineStyle
IStyle getInlineStyle()Get the inline style- Returns:
- the inline style
-
setInlineStyle
Set the inline style- Parameters:
style
- inline style
-
accept
Object accept(IContentVisitor visitor, Object value) throws org.eclipse.birt.core.exception.BirtException Use visitor to process the object.- Parameters:
visitor
- content visitorvalue
-- Returns:
- processed object
- Throws:
org.eclipse.birt.core.exception.BirtException
-
getBookmark
String getBookmark()Get the bookmark- Returns:
- the bookmark value
-
setBookmark
Set the bookmark- Parameters:
bookmark
- element bookmark
-
getHyperlinkAction
IHyperlinkAction getHyperlinkAction()Get the hyperlink action- Returns:
- hyperlink actions
-
setHyperlinkAction
Set the hyperlink action- Parameters:
hyperlink
- hyperlink action
-
getAltText
String getAltText()Get the alternative text- Returns:
- the alternative text.
-
setAltText
Set the alternative text- Parameters:
altText
- alternative text
-
getAltTextKey
String getAltTextKey()Get the alternative text key- Returns:
- the alternative text key
-
setAltTextKey
Set the alternative text key- Parameters:
altTextKey
- alternative text key
-
getHelpText
String getHelpText()Get the help text- Returns:
- the help text
-
setHelpText
Set the help text- Parameters:
help
- help text
-
getHeight
org.eclipse.birt.report.engine.ir.DimensionType getHeight()Get the specified value, the actual height is defined in IBounds- Returns:
- the height of the report item
-
setHeight
void setHeight(org.eclipse.birt.report.engine.ir.DimensionType height) Set the element height- Parameters:
height
- element height
-
getWidth
org.eclipse.birt.report.engine.ir.DimensionType getWidth()specified value, the real value is defined in IBounds- Returns:
- the width of the report item
-
setWidth
void setWidth(org.eclipse.birt.report.engine.ir.DimensionType width) Set the element width- Parameters:
width
- element width
-
getX
org.eclipse.birt.report.engine.ir.DimensionType getX()Get the specified value, the real value is defined in IBounds- Returns:
- the x position of the report item
-
setX
void setX(org.eclipse.birt.report.engine.ir.DimensionType x) Set the x position of the report item- Parameters:
x
- x position of the report item
-
getY
org.eclipse.birt.report.engine.ir.DimensionType getY()Get the specified value, the real value is defined in IBounds- Returns:
- the y position of the report item
-
setY
void setY(org.eclipse.birt.report.engine.ir.DimensionType y) Set the y position of the report item- Parameters:
y
- y position of the report item
-
getTOC
Object getTOC()Get the table of content- Returns:
- table of content
-
setTOC
Get the table of content- Parameters:
toc
- table of content
-
writeContent
Write the content- Parameters:
out
- data output sream- Throws:
IOException
-
readContent
Read the content- Parameters:
in
- data input streamloader
- class loader- Throws:
IOException
-
cloneContent
Clone the content- Parameters:
isDeep
- deep copy is used- Returns:
- the cloned content
-
isRTL
boolean isRTL()Is RTL used- Returns:
- is RTL used
-
isDirectionRTL
boolean isDirectionRTL()Is direction RTL- Returns:
- is direction RTL
-
getACL
String getACL()Get ACL- Returns:
- ACL
-
setACL
Set the ACL- Parameters:
acl
- ACL
-
getResultSet
IBaseResultSet getResultSet()Get the result set- Returns:
- result set
-
isLastChild
boolean isLastChild()Check is last child- Returns:
- is last child
-
setLastChild
void setLastChild(boolean isLastChild) Set is last child- Parameters:
isLastChild
- is last child
-
hasChildren
boolean hasChildren()Has children- Returns:
- has children
-
setHasChildren
void setHasChildren(boolean hasChildren) Set has children- Parameters:
hasChildren
- has children
-
getUserProperties
Get user properties- Returns:
- user properties
-
setUserProperties
Set the user properties- Parameters:
values
- user properties
-
getExtensions
Get the extensions- Returns:
- extensions
-
setExtensions
Set the extensions- Parameters:
values
- extensions
-
getTagType
String getTagType()- Returns:
- PDF tag type
-
setTagType
Set the PDF tag type
-