Class XhtmlDocument

  • All Implemented Interfaces:
    OutputFile

    public class XhtmlDocument
    extends DOMDocument
    An implementation of Document for XHTML documents.
    • Field Detail

      • XHTML10

        public static final int XHTML10
        Constant to identify XHTML 1.0 strict documents
        See Also:
        Constant Field Values
      • XHTML11

        public static final int XHTML11
        Constant to identify XHTML 1.1 documents
        See Also:
        Constant Field Values
      • XHTML_MATHML

        public static final int XHTML_MATHML
        Constant to identify XHTML + MathML documents
        See Also:
        Constant Field Values
      • HTML5

        public static final int HTML5
        Constant to identify HTML5 documents
        See Also:
        Constant Field Values
    • Constructor Detail

      • XhtmlDocument

        public XhtmlDocument​(java.lang.String name,
                             int nType)
        Constructor. This constructor also creates the DOM (minimal: root, head, title and body node only)
        Parameters:
        name - name of this document
        nType - the type of document
    • Method Detail

      • getExtension

        public static final java.lang.String getExtension​(int nType)
      • getMIMEType

        public java.lang.String getMIMEType()
        Description copied from interface: OutputFile
        Get the MIME type of the OutputFile.
        Specified by:
        getMIMEType in interface OutputFile
        Overrides:
        getMIMEType in class DOMDocument
        Returns:
        string representation of the MIME type
      • isMasterDocument

        public boolean isMasterDocument()
        Description copied from interface: OutputFile
        Test whether this document is part of the main document flow (master documents) or an auxiliary document
        Specified by:
        isMasterDocument in interface OutputFile
        Overrides:
        isMasterDocument in class DOMDocument
        Returns:
        true if this document is a master document
      • getHeadNode

        public org.w3c.dom.Element getHeadNode()
      • getBodyNode

        public org.w3c.dom.Element getBodyNode()
      • getTitleNode

        public org.w3c.dom.Element getTitleNode()
      • getContentNode

        public org.w3c.dom.Element getContentNode()
      • setContentNode

        public void setContentNode​(org.w3c.dom.Element contentNode)
      • getPanelNode

        public org.w3c.dom.Element getPanelNode()
      • getHeaderNode

        public org.w3c.dom.Element getHeaderNode()
      • getFooterNode

        public org.w3c.dom.Element getFooterNode()
      • createHeaderFooter

        public void createHeaderFooter()
      • setContentDOM

        public void setContentDOM​(org.w3c.dom.Document doc)
      • hasMath

        public boolean hasMath()
        Does this document contain any math nodes?
        Returns:
        true if so
      • read

        public void read​(java.io.InputStream is)
                  throws java.io.IOException
        Description copied from class: DOMDocument
        Read the Office Document from the specified InputStream.
        Overrides:
        read in class DOMDocument
        Parameters:
        is - Office document InputStream.
        Throws:
        java.io.IOException - If any I/O error occurs.
      • readFromTemplate

        public void readFromTemplate​(XhtmlDocument template)
      • setConfig

        public void setConfig​(XhtmlConfig config)
      • getEncoding

        public java.lang.String getEncoding()
      • getFileExtension

        public java.lang.String getFileExtension()
        Description copied from class: DOMDocument
        Returns the file extension of the Document represented.
        Overrides:
        getFileExtension in class DOMDocument
        Returns:
        file extension of the Document.
      • write

        public void write​(java.io.OutputStream os)
                   throws java.io.IOException
        Write out content to the supplied OutputStream. (with pretty printing)
        Specified by:
        write in interface OutputFile
        Overrides:
        write in class DOMDocument
        Parameters:
        os - XML OutputStream.
        Throws:
        java.io.IOException - If any I/O error occurs.