Interface IForeignContent

All Superinterfaces:
org.eclipse.birt.report.engine.css.engine.CSSStylableElement, IContent, IElement, IStyledElement

public interface IForeignContent extends IContent
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 Details

    • HTML_TYPE

      static final String HTML_TYPE
      the content is an string which contains HTML content
      See Also:
    • TEXT_TYPE

      static final String TEXT_TYPE
      the content is an string which contains plain text
      See Also:
    • TEMPLATE_TYPE

      static final String 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

      static final String EXTERNAL_TYPE
      the content is the output of a extenal item, it is byte[]
      See Also:
    • IMAGE_TYPE

      static final String IMAGE_TYPE
      the content is an image content which define the image
      See Also:
    • UNKNOWN_TYPE

      static final String UNKNOWN_TYPE
      the content is unkown
      See Also:
    • VALUE_TYPE

      static final String 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

      void setRawType(String type)
      Set the raw type
      Parameters:
      type - raw type of content
    • getRawKey

      String getRawKey()
      Get the raw content key
      Returns:
      the raw content key
    • setRawKey

      void setRawKey(String rawKey)
      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

      void setRawValue(Object value)
      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 interface IContent
      Returns:
      Returns the altText.
    • getAltTextKey

      String getAltTextKey()
      Description copied from interface: IContent
      Get the alternative text key
      Specified by:
      getAltTextKey in interface IContent
      Returns:
      the alternative text key
    • setAltText

      void setAltText(String altText)
      Description copied from interface: IContent
      Set the alternative text
      Specified by:
      setAltText in interface IContent
      Parameters:
      altText - alternative text
    • setAltTextKey

      void setAltTextKey(String key)
      Description copied from interface: IContent
      Set the alternative text key
      Specified by:
      setAltTextKey in interface IContent
      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