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 Detail

      • HTML_TYPE

        static final java.lang.String HTML_TYPE
        the content is an string which contains HTML content
        See Also:
        Constant Field Values
      • TEXT_TYPE

        static final java.lang.String TEXT_TYPE
        the content is an string which contains plain text
        See Also:
        Constant Field Values
      • TEMPLATE_TYPE

        static final java.lang.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:
        Constant Field Values
      • EXTERNAL_TYPE

        static final java.lang.String EXTERNAL_TYPE
        the content is the output of a extenal item, it is byte[]
        See Also:
        Constant Field Values
      • IMAGE_TYPE

        static final java.lang.String IMAGE_TYPE
        the content is an image content which define the image
        See Also:
        Constant Field Values
      • UNKNOWN_TYPE

        static final java.lang.String UNKNOWN_TYPE
        the content is unkown
        See Also:
        Constant Field Values
    • Method Detail

      • getRawType

        java.lang.String getRawType()
        the orginal format of the object. such as: "text/html", "text/rtf", "xml/svg" etc.
        Returns:
        type of the content
      • setRawType

        void setRawType​(java.lang.String type)
      • getRawKey

        java.lang.String getRawKey()
      • setRawKey

        void setRawKey​(java.lang.String rawKey)
      • getRawValue

        java.lang.Object getRawValue()
        the orignal content describe in raw format.
        Returns:
        Returns the content. Caller knows how to cast this object
      • setRawValue

        void setRawValue​(java.lang.Object value)
      • getAltText

        java.lang.String getAltText()
        Specified by:
        getAltText in interface IContent
        Returns:
        Returns the altText.
      • getAltTextKey

        java.lang.String getAltTextKey()
        Specified by:
        getAltTextKey in interface IContent
        Returns:
        Returns the altText key.
      • setAltText

        void setAltText​(java.lang.String altText)
        Specified by:
        setAltText in interface IContent
      • setAltTextKey

        void setAltTextKey​(java.lang.String key)
        Specified by:
        setAltTextKey in interface IContent
      • setJTidy

        void setJTidy​(boolean jTidy)
      • isJTidy

        boolean isJTidy()