Interface OutputFormat

All Known Implementing Classes:
XSLOutput

public interface OutputFormat
A class for maintaining state information for the output of the XSL result tree
Since:
XSLT 19990813 (XSL:P version 19990928)
Version:
$Revision: 4773 $ $Date: 2004-09-28 20:39:18 +0200 (Tue, 28 Sep 2004) $
Author:
Keith Visco
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the Public Id that should be used for the Doctype
    Returns the System Id that should be used in the Doctype
    Returns the specified encoding, or null if no encoding was specified.
    boolean
    Returns whether or not indenting the result is allowed
    Returns the output method
    Predefined output methods are: xml, html, and text
    boolean
    Returns whether or not the XML declaration should be supressed when serializing the result
    Returns the XML version that should be output during serialization of the result tree
    void
    Sets the Public Id that should be used for the Doctype
    void
    Sets the System Id that should be used in the Doctype
    void
    setEncoding(String encoding)
    Sets the character encoding.
    void
    setIndent(boolean allowIndentation)
    Returns whether or not indenting the result is allowed
    void
    setMethod(String method)
    Sets the output method
    void
    setOmitXMLDeclaration(boolean omitDeclaration)
    Sets whether or not the XML declaration should be supressed when serializing the result
    void
    setVersion(String version)
    Sets the version of the XML output (eg "1.0")
  • Method Details

    • getDoctypePublicId

      String getDoctypePublicId()
      Returns the Public Id that should be used for the Doctype
      Returns:
      the Public Id that should be used for the Doctype, or null if none has been set
    • getDoctypeSystemId

      String getDoctypeSystemId()
      Returns the System Id that should be used in the Doctype
      Returns:
      the System Id that should be used for the Doctype, or null if none has been set
    • getEncoding

      String getEncoding()
      Returns the specified encoding, or null if no encoding was specified.
      Returns:
      the encoding, or null if no encoding specified.
    • getIndent

      boolean getIndent()
      Returns whether or not indenting the result is allowed
      Returns:
      true if whitespace may be added to the output result for indentation and readability, otherwise returns false
    • getMethod

      String getMethod()
      Returns the output method
      Predefined output methods are: xml, html, and text
      Returns:
      the output method
    • getOmitXMLDeclaration

      boolean getOmitXMLDeclaration()
      Returns whether or not the XML declaration should be supressed when serializing the result
      Returns:
      true if the XML declaration should be supressed when serializing the result
    • getVersion

      String getVersion()
      Returns the XML version that should be output during serialization of the result tree
      Returns:
      the XML version that should be used during serialization of of the result tree
    • setEncoding

      void setEncoding(String encoding)
      Sets the character encoding.
      Parameters:
      encoding - the character encoding
      See Also:
    • setIndent

      void setIndent(boolean allowIndentation)
      Returns whether or not indenting the result is allowed
    • setMethod

      void setMethod(String method)
      Sets the output method
      Parameters:
      method - , the output method of this xsl:output object
      Predefined output methods are: xml, html, and text
    • setOmitXMLDeclaration

      void setOmitXMLDeclaration(boolean omitDeclaration)
      Sets whether or not the XML declaration should be supressed when serializing the result
      Parameters:
      omitDeclaration - , the flag indicating whether or not the XML declaration should be supressed when serializing the result. Use true if you do NOT want the XML Declaration to appear in the output. The default value depends on the Method. If the method is "xml", this value will be false by default. If the method is "html", this value will be true by default.
    • setVersion

      void setVersion(String version)
      Sets the version of the XML output (eg "1.0")
      Parameters:
      version - , the xml version to output
    • setDoctypePublicId

      void setDoctypePublicId(String publicId)
      Sets the Public Id that should be used for the Doctype
      Parameters:
      publicId - the Public Id that should be used for the Doctype
    • setDoctypeSystemId

      void setDoctypeSystemId(String systemId)
      Sets the System Id that should be used in the Doctype
      Parameters:
      systemId - the System Id for the Doctype