org.eclipse.birt.report.engine.content
Interface IContent

All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement, IElement
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

object created by report generator. the content of report document.


Field Summary
static int AUTOTEXT_CONTENT
           
static int CELL_CONTENT
           
static int CONTAINER_CONTENT
           
static int DATA_CONTENT
           
static int DOCUMENT_EXTENSION
           
static int FOREIGN_CONTENT
           
static int GROUP_CONTENT
           
static int IMAGE_CONTENT
           
static int LABEL_CONTENT
           
static int LAYOUT_EXTENSION
           
static int LIST_BAND_CONTENT
           
static int LIST_CONTENT
           
static int LIST_GROUP_CONTENT
           
static int PAGE_CONTENT
           
static int ROW_CONTENT
           
static int SERIALIZE_CONTENT
           
static int TABLE_BAND_CONTENT
           
static int TABLE_CONTENT
           
static int TABLE_GROUP_CONTENT
           
static int TEXT_CONTENT
           
 
Method Summary
 java.lang.Object accept(IContentVisitor visitor, java.lang.Object value)
          use visitor to process the object.
 java.lang.String getBookmark()
           
 int getContentType()
          the content type, must be one of the predefines.
 java.lang.Object getExtension(int extension)
           
 java.lang.Object getGenerateBy()
          the design object which create this content.
 org.eclipse.birt.report.engine.ir.DimensionType getHeight()
          sepcified value, the actual height is defined in IBounds
 java.lang.String getHelpText()
           
 IHyperlinkAction getHyperlinkAction()
           
 IStyle getInlineStyle()
           
 InstanceID getInstanceID()
          get the instance id of the content.
 java.lang.String getName()
          unique id of the content.
 IReportContent getReportContent()
          return the report which contains/create this content.
 java.lang.String getStyleClass()
           
 java.lang.Object getTOC()
           
 org.eclipse.birt.report.engine.ir.DimensionType getWidth()
          specified value, the real value is defined in IBounds
 org.eclipse.birt.report.engine.ir.DimensionType getX()
          specified value, the real value is defined in IBounds
 org.eclipse.birt.report.engine.ir.DimensionType getY()
          specified value, the real value is defined in IBounds
 void readContent(java.io.DataInputStream in)
           
 void setBookmark(java.lang.String bookmark)
           
 void setExtension(int extension, java.lang.Object value)
          Set the extension of the content.
 void setGenerateBy(java.lang.Object generateBy)
           
 void setHeight(org.eclipse.birt.report.engine.ir.DimensionType height)
           
 void setHelpText(java.lang.String help)
           
 void setHyperlinkAction(IHyperlinkAction hyperlink)
           
 void setInlineStyle(IStyle style)
           
 void setInstanceID(InstanceID id)
          set the instace id of the content.
 void setName(java.lang.String name)
           
 void setReportContent(IReportContent report)
          set the report content.
 void setStyleClass(java.lang.String styleClass)
           
 void setTOC(java.lang.Object toc)
           
 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 writeContent(java.io.DataOutputStream out)
           
 
Methods inherited from interface org.eclipse.birt.report.engine.content.IElement
getChildren, getParent, setParent
 
Methods inherited from interface org.eclipse.birt.report.engine.css.engine.CSSStylableElement
getComputedStyle, getCSSEngine, getStyle
 

Field Detail

SERIALIZE_CONTENT

public static final int SERIALIZE_CONTENT
See Also:
Constant Field Values

CELL_CONTENT

public static final int CELL_CONTENT
See Also:
Constant Field Values

CONTAINER_CONTENT

public static final int CONTAINER_CONTENT
See Also:
Constant Field Values

DATA_CONTENT

public static final int DATA_CONTENT
See Also:
Constant Field Values

FOREIGN_CONTENT

public static final int FOREIGN_CONTENT
See Also:
Constant Field Values

IMAGE_CONTENT

public static final int IMAGE_CONTENT
See Also:
Constant Field Values

LABEL_CONTENT

public static final int LABEL_CONTENT
See Also:
Constant Field Values

PAGE_CONTENT

public static final int PAGE_CONTENT
See Also:
Constant Field Values

ROW_CONTENT

public static final int ROW_CONTENT
See Also:
Constant Field Values

TABLE_BAND_CONTENT

public static final int TABLE_BAND_CONTENT
See Also:
Constant Field Values

TABLE_CONTENT

public static final int TABLE_CONTENT
See Also:
Constant Field Values

TEXT_CONTENT

public static final int TEXT_CONTENT
See Also:
Constant Field Values

AUTOTEXT_CONTENT

public static final int AUTOTEXT_CONTENT
See Also:
Constant Field Values

LIST_CONTENT

public static final int LIST_CONTENT
See Also:
Constant Field Values

LIST_BAND_CONTENT

public static final int LIST_BAND_CONTENT
See Also:
Constant Field Values

GROUP_CONTENT

public static final int GROUP_CONTENT
See Also:
Constant Field Values

LIST_GROUP_CONTENT

public static final int LIST_GROUP_CONTENT
See Also:
Constant Field Values

TABLE_GROUP_CONTENT

public static final int TABLE_GROUP_CONTENT
See Also:
Constant Field Values

DOCUMENT_EXTENSION

public static final int DOCUMENT_EXTENSION
See Also:
Constant Field Values

LAYOUT_EXTENSION

public static final int LAYOUT_EXTENSION
See Also:
Constant Field Values
Method Detail

getContentType

public int getContentType()
the content type, must be one of the predefines.

Returns:

getInstanceID

public InstanceID getInstanceID()
get the instance id of the content. the instance id is the unique id of the content.

Returns:

setInstanceID

public void setInstanceID(InstanceID id)
set the instace id of the content. the instance id can only be set by the content generator.

Parameters:
id -

getExtension

public java.lang.Object getExtension(int extension)

setExtension

public void setExtension(int extension,
                         java.lang.Object value)
Set the extension of the content. Only 2 extension supported so far
  • 0: document extension
  • 1: layout extension
  • Parameters:
    extension - extension type
    value - extension value
    Throws:
    java.lang.ArrayIndexOutOfBoundsException - if index is outof range {0,1}

    getReportContent

    public IReportContent getReportContent()
    return the report which contains/create this content.

    Returns:

    setReportContent

    public void setReportContent(IReportContent report)
    set the report content.

    Parameters:
    report -

    getName

    public java.lang.String getName()
    unique id of the content.

    Returns:

    setName

    public void setName(java.lang.String name)

    getGenerateBy

    public java.lang.Object getGenerateBy()
    the design object which create this content.

    Returns:

    setGenerateBy

    public void setGenerateBy(java.lang.Object generateBy)

    getInlineStyle

    public IStyle getInlineStyle()
    Returns:
    inline style

    setInlineStyle

    public void setInlineStyle(IStyle style)

    getStyleClass

    public java.lang.String getStyleClass()

    setStyleClass

    public void setStyleClass(java.lang.String styleClass)

    accept

    public java.lang.Object accept(IContentVisitor visitor,
                                   java.lang.Object value)
    use visitor to process the object.

    Parameters:
    visitor -

    getBookmark

    public java.lang.String getBookmark()
    Returns:
    the bookmark value

    setBookmark

    public void setBookmark(java.lang.String bookmark)

    getHyperlinkAction

    public IHyperlinkAction getHyperlinkAction()
    Returns:
    hyperlink actions

    setHyperlinkAction

    public void setHyperlinkAction(IHyperlinkAction hyperlink)

    getHelpText

    public java.lang.String getHelpText()
    Returns:
    Returns the helpText.

    setHelpText

    public void setHelpText(java.lang.String help)

    getHeight

    public 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

    public void setHeight(org.eclipse.birt.report.engine.ir.DimensionType height)

    getWidth

    public 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

    public void setWidth(org.eclipse.birt.report.engine.ir.DimensionType width)

    getX

    public org.eclipse.birt.report.engine.ir.DimensionType getX()
    specified value, the real value is defined in IBounds

    Returns:
    the x position of the repor titem.

    setX

    public void setX(org.eclipse.birt.report.engine.ir.DimensionType x)

    getY

    public org.eclipse.birt.report.engine.ir.DimensionType getY()
    specified value, the real value is defined in IBounds

    Returns:
    Returns the y position of the repor titem.

    setY

    public void setY(org.eclipse.birt.report.engine.ir.DimensionType y)

    getTOC

    public java.lang.Object getTOC()

    setTOC

    public void setTOC(java.lang.Object toc)

    writeContent

    public void writeContent(java.io.DataOutputStream out)
                      throws java.io.IOException
    Throws:
    java.io.IOException

    readContent

    public void readContent(java.io.DataInputStream in)
                     throws java.io.IOException
    Throws:
    java.io.IOException


    Copyright © 2005 Actuate Corp. All rights reserved.