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 Details

  • 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

      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

      Object getExtension(int extension)
    • setExtension

      void setExtension(int extension, 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:
      ArrayIndexOutOfBoundsException - if index is outof range {0,1}
    • getReportContent

      IReportContent getReportContent()
      return the report which contains/create this content.
      Returns:
    • setReportContent

      void setReportContent(IReportContent report)
      set the report content.
      Parameters:
      report -
    • getName

      String getName()
      unique id of the content.
      Returns:
    • setName

      void setName(String name)
    • getGenerateBy

      Object getGenerateBy()
      the design object which create this content.
      Returns:
    • setGenerateBy

      void setGenerateBy(Object generateBy)
    • getInlineStyle

      IStyle getInlineStyle()
      Returns:
      inline style
    • setInlineStyle

      void setInlineStyle(IStyle style)
    • 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

      void setBookmark(String bookmark)
    • getHyperlinkAction

      IHyperlinkAction getHyperlinkAction()
      Returns:
      hyperlink actions
    • setHyperlinkAction

      void setHyperlinkAction(IHyperlinkAction hyperlink)
    • getAltText

      String getAltText()
      Returns:
      Returns the altText.
    • setAltText

      void setAltText(String altText)
    • getAltTextKey

      String getAltTextKey()
      Returns:
      Returns the altText key.
    • setAltTextKey

      void setAltTextKey(String altTextKey)
    • getHelpText

      String getHelpText()
      Returns:
      Returns the helpText.
    • setHelpText

      void setHelpText(String help)
    • 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

      void setTOC(Object toc)
    • writeContent

      void writeContent(DataOutputStream out) throws IOException
      Throws:
      IOException
    • readContent

      void readContent(DataInputStream in, ClassLoader loader) throws IOException
      Throws:
      IOException
    • cloneContent

      IContent cloneContent(boolean isDeep)
    • isRTL

      boolean isRTL()
    • isDirectionRTL

      boolean isDirectionRTL()
    • getACL

      String getACL()
    • setACL

      void setACL(String acl)
    • getResultSet

      IBaseResultSet getResultSet()
    • isLastChild

      boolean isLastChild()
    • setLastChild

      void setLastChild(boolean isLastChild)
    • hasChildren

      boolean hasChildren()
    • setHasChildren

      void setHasChildren(boolean hasChildren)
    • getUserProperties

      Map<String,Object> getUserProperties()
    • setUserProperties

      void setUserProperties(Map<String,Object> values)
    • getExtensions

      Map<String,Object> getExtensions()
    • setExtensions

      void setExtensions(Map<String,Object> values)