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
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionaccept
(IContentVisitor visitor, Object value) use visitor to process the object.cloneContent
(boolean isDeep) getACL()
int
the content type, must be one of the predefines.getExtension
(int extension) the design object which create this content.org.eclipse.birt.report.engine.ir.DimensionType
sepcified value, the actual height is defined in IBoundsget the instance id of the content.getName()
unique id of the content.return the report which contains/create this content.getTOC()
org.eclipse.birt.report.engine.ir.DimensionType
getWidth()
specified value, the real value is defined in IBoundsorg.eclipse.birt.report.engine.ir.DimensionType
getX()
specified value, the real value is defined in IBoundsorg.eclipse.birt.report.engine.ir.DimensionType
getY()
specified value, the real value is defined in IBoundsboolean
boolean
boolean
boolean
isRTL()
void
readContent
(DataInputStream in, ClassLoader loader) void
void
setAltText
(String altText) void
setAltTextKey
(String altTextKey) void
setBookmark
(String bookmark) void
setExtension
(int extension, Object value) Set the extension of the content.void
setExtensions
(Map<String, Object> values) void
setGenerateBy
(Object generateBy) void
setHasChildren
(boolean hasChildren) void
setHeight
(org.eclipse.birt.report.engine.ir.DimensionType height) void
setHelpText
(String help) void
setHyperlinkAction
(IHyperlinkAction hyperlink) void
setInlineStyle
(IStyle style) void
set the instace id of the content.void
setLastChild
(boolean isLastChild) void
void
setReportContent
(IReportContent report) set the report content.void
void
setUserProperties
(Map<String, Object> values) void
setWidth
(org.eclipse.birt.report.engine.ir.DimensionType width) void
setX
(org.eclipse.birt.report.engine.ir.DimensionType x) void
setY
(org.eclipse.birt.report.engine.ir.DimensionType y) void
Methods 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_CONTENT- See Also:
-
REPORT_CONTENT
static final int REPORT_CONTENT- See Also:
-
CELL_CONTENT
static final int CELL_CONTENT- See Also:
-
CONTAINER_CONTENT
static final int CONTAINER_CONTENT- See Also:
-
DATA_CONTENT
static final int DATA_CONTENT- See Also:
-
FOREIGN_CONTENT
static final int FOREIGN_CONTENT- See Also:
-
IMAGE_CONTENT
static final int IMAGE_CONTENT- See Also:
-
LABEL_CONTENT
static final int LABEL_CONTENT- See Also:
-
PAGE_CONTENT
static final int PAGE_CONTENT- See Also:
-
ROW_CONTENT
static final int ROW_CONTENT- See Also:
-
TABLE_BAND_CONTENT
static final int TABLE_BAND_CONTENT- See Also:
-
TABLE_CONTENT
static final int TABLE_CONTENT- See Also:
-
TEXT_CONTENT
static final int TEXT_CONTENT- See Also:
-
AUTOTEXT_CONTENT
static final int AUTOTEXT_CONTENT- See Also:
-
LIST_CONTENT
static final int LIST_CONTENT- See Also:
-
LIST_BAND_CONTENT
static final int LIST_BAND_CONTENT- See Also:
-
GROUP_CONTENT
static final int GROUP_CONTENT- See Also:
-
LIST_GROUP_CONTENT
static final int LIST_GROUP_CONTENT- See Also:
-
TABLE_GROUP_CONTENT
static final int TABLE_GROUP_CONTENT- See Also:
-
DOCUMENT_EXTENSION
static final int DOCUMENT_EXTENSION- See Also:
-
LAYOUT_EXTENSION
static final int LAYOUT_EXTENSION- See Also:
-
-
Method Details
-
getContentType
int getContentType()the content type, must be one of the predefines.- Returns:
-
getInstanceID
InstanceID getInstanceID()get the instance id of the content. the instance id is the unique id of the content.- Returns:
-
setInstanceID
set the instace id of the content. the instance id can only be set by the content generator.- Parameters:
id
-
-
getExtension
-
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 outof range {0,1}
-
getReportContent
IReportContent getReportContent()return the report which contains/create this content.- Returns:
-
setReportContent
set the report content.- Parameters:
report
-
-
getName
String getName()unique id of the content.- Returns:
-
setName
-
getGenerateBy
Object getGenerateBy()the design object which create this content.- Returns:
-
setGenerateBy
-
getInlineStyle
IStyle getInlineStyle()- Returns:
- inline style
-
setInlineStyle
-
accept
Object accept(IContentVisitor visitor, Object value) throws org.eclipse.birt.core.exception.BirtException use visitor to process the object.- Parameters:
visitor
-- Throws:
org.eclipse.birt.core.exception.BirtException
-
getBookmark
String getBookmark()- Returns:
- the bookmark value
-
setBookmark
-
getHyperlinkAction
IHyperlinkAction getHyperlinkAction()- Returns:
- hyperlink actions
-
setHyperlinkAction
-
getAltText
String getAltText()- Returns:
- Returns the altText.
-
setAltText
-
getAltTextKey
String getAltTextKey()- Returns:
- Returns the altText key.
-
setAltTextKey
-
getHelpText
String getHelpText()- Returns:
- Returns the helpText.
-
setHelpText
-
getHeight
org.eclipse.birt.report.engine.ir.DimensionType getHeight()sepcified 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) -
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) -
getX
org.eclipse.birt.report.engine.ir.DimensionType getX()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) -
getY
org.eclipse.birt.report.engine.ir.DimensionType getY()specified value, the real value is defined in IBounds- Returns:
- Returns the y position of the report item.
-
setY
void setY(org.eclipse.birt.report.engine.ir.DimensionType y) -
getTOC
Object getTOC() -
setTOC
-
writeContent
- Throws:
IOException
-
readContent
- Throws:
IOException
-
cloneContent
-
isRTL
boolean isRTL() -
isDirectionRTL
boolean isDirectionRTL() -
getACL
String getACL() -
setACL
-
getResultSet
IBaseResultSet getResultSet() -
isLastChild
boolean isLastChild() -
setLastChild
void setLastChild(boolean isLastChild) -
hasChildren
boolean hasChildren() -
setHasChildren
void setHasChildren(boolean hasChildren) -
getUserProperties
-
setUserProperties
-
getExtensions
-
setExtensions
-