Interface IForeignContent
- All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement
,IContent
,IElement
,IStyledElement
The content of foreign object is not handle by report engine.
It is the object's responsibility to convert itself to standard content type.
Such as object described in HTML/RTF or other format.
For foreign object in "text/html" format, the PDF writer output the standard
content while the HTML writer output the raw value directly.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
the content is the output of a extenal item, it is byte[]static final String
the content is an string which contains HTML contentstatic final String
the content is an image content which define the imagestatic final String
the content is an template.static final String
the content is an string which contains plain textstatic final String
the content is unkownstatic final String
the object valueFields inherited from interface org.eclipse.birt.report.engine.content.IContent
AUTOTEXT_CONTENT, CELL_CONTENT, CONTAINER_CONTENT, DATA_CONTENT, DOCUMENT_EXTENSION, FOREIGN_CONTENT, GROUP_CONTENT, IMAGE_CONTENT, LABEL_CONTENT, LAYOUT_EXTENSION, LIST_BAND_CONTENT, LIST_CONTENT, LIST_GROUP_CONTENT, PAGE_CONTENT, REPORT_CONTENT, ROW_CONTENT, SERIALIZE_CONTENT, TABLE_BAND_CONTENT, TABLE_CONTENT, TABLE_GROUP_CONTENT, TEXT_CONTENT
-
Method Summary
Modifier and TypeMethodDescriptionGet the alternative textGet the alternative text keyGet the raw content keyGet the original format of the object.the orignal content describe in raw format.boolean
isJTidy()
Is JTidy to be usedvoid
setAltText
(String altText) Set the alternative textvoid
setAltTextKey
(String key) Set the alternative text keyvoid
setJTidy
(boolean jTidy) Set the use of JTidy for document generationvoid
Set the raw content keyvoid
setRawType
(String type) Set the raw typevoid
setRawValue
(Object value) Set the raw content valueMethods inherited from interface org.eclipse.birt.report.engine.css.engine.CSSStylableElement
getComputedStyle, getCSSEngine, getStyle
Methods inherited from interface org.eclipse.birt.report.engine.content.IContent
accept, cloneContent, getACL, getBookmark, getContentType, getExtension, getExtensions, getGenerateBy, getHeight, getHelpText, getHyperlinkAction, getInlineStyle, getInstanceID, getName, getReportContent, getResultSet, getTOC, getUserProperties, getWidth, getX, getY, hasChildren, isDirectionRTL, isLastChild, isRTL, readContent, setACL, setBookmark, setExtension, setExtensions, setGenerateBy, setHasChildren, setHeight, setHelpText, setHyperlinkAction, setInlineStyle, setInstanceID, setLastChild, setName, setReportContent, setTOC, setUserProperties, setWidth, setX, setY, writeContent
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
-
HTML_TYPE
the content is an string which contains HTML content- See Also:
-
TEXT_TYPE
the content is an string which contains plain text- See Also:
-
TEMPLATE_TYPE
the content is an template. In this condition the raw value should be a Object[2], the first object is the template text, the second object is the value map.- See Also:
-
EXTERNAL_TYPE
the content is the output of a extenal item, it is byte[]- See Also:
-
IMAGE_TYPE
the content is an image content which define the image- See Also:
-
UNKNOWN_TYPE
the content is unkown- See Also:
-
VALUE_TYPE
the object value- See Also:
-
-
Method Details
-
getRawType
String getRawType()Get the original format of the object. such as: "text/html", "text/rtf", "xml/svg" etc.- Returns:
- type of the content
-
setRawType
Set the raw type- Parameters:
type
- raw type of content
-
getRawKey
String getRawKey()Get the raw content key- Returns:
- the raw content key
-
setRawKey
Set the raw content key- Parameters:
rawKey
- raw content key
-
getRawValue
Object getRawValue()the orignal content describe in raw format.- Returns:
- Returns the content. Caller knows how to cast this object
-
setRawValue
Set the raw content value- Parameters:
value
- raw content value
-
getAltText
String getAltText()Description copied from interface:IContent
Get the alternative text- Specified by:
getAltText
in interfaceIContent
- Returns:
- Returns the altText.
-
getAltTextKey
String getAltTextKey()Description copied from interface:IContent
Get the alternative text key- Specified by:
getAltTextKey
in interfaceIContent
- Returns:
- the alternative text key
-
setAltText
Description copied from interface:IContent
Set the alternative text- Specified by:
setAltText
in interfaceIContent
- Parameters:
altText
- alternative text
-
setAltTextKey
Description copied from interface:IContent
Set the alternative text key- Specified by:
setAltTextKey
in interfaceIContent
- Parameters:
key
- alternative text key
-
setJTidy
void setJTidy(boolean jTidy) Set the use of JTidy for document generation- Parameters:
jTidy
- JTidy usage
-
isJTidy
boolean isJTidy()Is JTidy to be used- Returns:
- is JTidy to be used
-