Class ToHTMLSAXHandler

  • All Implemented Interfaces:
    DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler

    public final class ToHTMLSAXHandler
    extends ToSAXHandler
    Deprecated.
    As of Xalan 2.7.1, replaced by the use of ToXMLSAXHandler.
    This class accepts SAX-like calls, then sends true SAX calls to a wrapped SAX handler. There is optimization done knowing that the ultimate output is HTML. This class is not a public API.
    • Field Detail

      • CDATA_CONTINUE

        public static final java.lang.String CDATA_CONTINUE
        To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
        See Also:
        Constant Field Values
      • CDATA_DELIMITER_CLOSE

        public static final java.lang.String CDATA_DELIMITER_CLOSE
        The constant "]]>"
        See Also:
        Constant Field Values
      • CDATA_DELIMITER_OPEN

        public static final java.lang.String CDATA_DELIMITER_OPEN
        See Also:
        Constant Field Values
      • DEFAULT_SAX_SERIALIZER

        public static final java.lang.String DEFAULT_SAX_SERIALIZER
      • XMLVERSION11

        public static final java.lang.String XMLVERSION11
        Define the XML version.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ToHTMLSAXHandler

        public ToHTMLSAXHandler​(org.xml.sax.ContentHandler handler,
                                java.lang.String encoding)
        Deprecated.
        A constructor
        Parameters:
        handler - the wrapped SAX content handler
        encoding - the encoding of the output HTML document
      • ToHTMLSAXHandler

        public ToHTMLSAXHandler​(org.xml.sax.ContentHandler handler,
                                org.xml.sax.ext.LexicalHandler lex,
                                java.lang.String encoding)
        Deprecated.
        A constructor.
        Parameters:
        handler - the wrapped SAX content handler
        lex - the wrapped lexical handler
        encoding - the encoding of the output HTML document
    • Method Detail

      • getOutputFormat

        public java.util.Properties getOutputFormat()
        Deprecated.
        Returns null.
        Returns:
        null
        See Also:
        Serializer.getOutputFormat()
      • getOutputStream

        public java.io.OutputStream getOutputStream()
        Deprecated.
        Reurns null
        Returns:
        null
        See Also:
        Serializer.getOutputStream()
      • getWriter

        public java.io.Writer getWriter()
        Deprecated.
        Returns null
        Returns:
        null
        See Also:
        Serializer.getWriter()
      • indent

        public void indent​(int n)
                    throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
      • serialize

        public void serialize​(org.w3c.dom.Node node)
                       throws java.io.IOException
        Deprecated.
        Does nothing.
        Parameters:
        node - the DOM node to be serialized.
        Throws:
        java.io.IOException - if an I/O exception occured while serializing
        See Also:
        DOMSerializer.serialize(Node)
      • setEscaping

        public boolean setEscaping​(boolean escape)
                            throws org.xml.sax.SAXException
        Deprecated.
        Turns special character escaping on/off.
        Parameters:
        escape - true if escaping is to be set on.
        Throws:
        org.xml.sax.SAXException
        See Also:
        SerializationHandler.setEscaping(boolean)
      • setIndent

        public void setIndent​(boolean indent)
        Deprecated.
        Does nothing
        Overrides:
        setIndent in class SerializerBase
        Parameters:
        indent - the number of spaces to indent per indentation level (ignored)
        See Also:
        XSLOutputAttributes.setIndent(boolean)
      • setOutputFormat

        public void setOutputFormat​(java.util.Properties format)
        Deprecated.
        Does nothing.
        Parameters:
        format - this parameter is not used
        See Also:
        Serializer.setOutputFormat(Properties)
      • setOutputStream

        public void setOutputStream​(java.io.OutputStream output)
        Deprecated.
        Does nothing.
        Parameters:
        output - this parameter is ignored
        See Also:
        Serializer.setOutputStream(OutputStream)
      • setWriter

        public void setWriter​(java.io.Writer writer)
        Deprecated.
        Does nothing.
        Parameters:
        writer - this parameter is ignored.
        See Also:
        Serializer.setWriter(Writer)
      • attributeDecl

        public void attributeDecl​(java.lang.String eName,
                                  java.lang.String aName,
                                  java.lang.String type,
                                  java.lang.String valueDefault,
                                  java.lang.String value)
                           throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Parameters:
        eName - this parameter is ignored
        aName - this parameter is ignored
        type - this parameter is ignored
        valueDefault - this parameter is ignored
        value - this parameter is ignored
        Throws:
        org.xml.sax.SAXException
        See Also:
        DeclHandler.attributeDecl(String, String, String,String,String)
      • elementDecl

        public void elementDecl​(java.lang.String name,
                                java.lang.String model)
                         throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DeclHandler.elementDecl(String, String)
      • externalEntityDecl

        public void externalEntityDecl​(java.lang.String arg0,
                                       java.lang.String arg1,
                                       java.lang.String arg2)
                                throws org.xml.sax.SAXException
        Deprecated.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DeclHandler.externalEntityDecl(String, String, String)
      • internalEntityDecl

        public void internalEntityDecl​(java.lang.String name,
                                       java.lang.String value)
                                throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
      • endElement

        public void endElement​(java.lang.String uri,
                               java.lang.String localName,
                               java.lang.String qName)
                        throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of the end of an element.

        The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

        If the element name has a namespace prefix, the prefix will still be attached to the name.

        Parameters:
        uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
        localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
        qName - The qualified name (with prefix), or the empty string if qualified names are not available.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        ContentHandler.endElement(String, String, String)
      • endPrefixMapping

        public void endPrefixMapping​(java.lang.String prefix)
                              throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
      • ignorableWhitespace

        public void ignorableWhitespace​(char[] ch,
                                        int start,
                                        int length)
                                 throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        ContentHandler.ignorableWhitespace(char[], int, int)
      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          java.lang.String data)
                                   throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of a processing instruction.

        The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

        A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

        Specified by:
        processingInstruction in interface org.xml.sax.ContentHandler
        Overrides:
        processingInstruction in class ToSAXHandler
        Parameters:
        target - The processing instruction target.
        data - The processing instruction data, or null if none was supplied.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException
        See Also:
        ContentHandler.processingInstruction(String, String)
      • setDocumentLocator

        public void setDocumentLocator​(org.xml.sax.Locator arg0)
        Deprecated.
        Does nothing.
        Specified by:
        setDocumentLocator in interface org.xml.sax.ContentHandler
        Overrides:
        setDocumentLocator in class SerializerBase
        Parameters:
        arg0 - An object that can return the location of any SAX document event. Receive an object for locating the origin of SAX document events.

        SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

        The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

        Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

        See Also:
        ContentHandler.setDocumentLocator(Locator)
      • skippedEntity

        public void skippedEntity​(java.lang.String arg0)
                           throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        ContentHandler.skippedEntity(String)
      • startElement

        public void startElement​(java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String qName,
                                 org.xml.sax.Attributes atts)
                          throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element.
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class ToSAXHandler
        Parameters:
        namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
        localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
        qName - The elements name.
        atts - The attributes attached to the element, if any.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException
        See Also:
        ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), AttributeList, ContentHandler.startElement(String, String, String, Attributes)
      • comment

        public void comment​(char[] ch,
                            int start,
                            int length)
                     throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of a comment anywhere in the document. This callback will be used for comments inside or outside the document element.
        Parameters:
        ch - An array holding the characters in the comment.
        start - The starting position in the array.
        length - The number of characters to use from the array.
        Throws:
        org.xml.sax.SAXException - The application may raise an exception.
        See Also:
        LexicalHandler.comment(char[], int, int)
      • endCDATA

        public void endCDATA()
                      throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        LexicalHandler.endCDATA()
      • endDTD

        public void endDTD()
                    throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        LexicalHandler.endDTD()
      • startCDATA

        public void startCDATA()
                        throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        LexicalHandler.startCDATA()
      • startEntity

        public void startEntity​(java.lang.String arg0)
                         throws org.xml.sax.SAXException
        Deprecated.
        Does nothing.
        Throws:
        org.xml.sax.SAXException
        See Also:
        LexicalHandler.startEntity(String)
      • endDocument

        public void endDocument()
                         throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of the end of a document.

        The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException
      • startElement

        public void startElement​(java.lang.String elementNamespaceURI,
                                 java.lang.String elementLocalName,
                                 java.lang.String elementName)
                          throws org.xml.sax.SAXException
        Deprecated.
        An element starts, but attributes are not fully known yet.
        Specified by:
        startElement in interface ExtendedContentHandler
        Overrides:
        startElement in class ToSAXHandler
        Parameters:
        elementNamespaceURI - the URI of the namespace of the element (optional)
        elementLocalName - the element name, but without prefix (optional)
        elementName - the element name, with prefix, if any (required)
        Throws:
        org.xml.sax.SAXException
        See Also:
        ExtendedContentHandler.startElement(String)
      • endElement

        public void endElement​(java.lang.String elementName)
                        throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of the end of an element.
        Parameters:
        elementName - The element type name
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        ExtendedContentHandler.endElement(String)
      • characters

        public void characters​(char[] ch,
                               int off,
                               int len)
                        throws org.xml.sax.SAXException
        Deprecated.
        Receive notification of character data.

        The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

        The application must not attempt to read from the array outside of the specified range.

        Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

        Parameters:
        ch - The characters from the XML document.
        off - The start position in the array.
        len - The number of characters to read from the array.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException
        See Also:
        ignorableWhitespace(char[], int, int), Locator, ContentHandler.characters(char[], int, int)
      • flushPending

        public void flushPending()
                          throws org.xml.sax.SAXException
        Deprecated.
        This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.
        Specified by:
        flushPending in interface SerializationHandler
        Overrides:
        flushPending in class ToSAXHandler
        Throws:
        org.xml.sax.SAXException
      • startPrefixMapping

        public boolean startPrefixMapping​(java.lang.String prefix,
                                          java.lang.String uri,
                                          boolean shouldFlush)
                                   throws org.xml.sax.SAXException
        Deprecated.
        Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. Need to close any open start tag to make sure than any name space attributes due to this event are associated wih the up comming element, not the current one.
        Parameters:
        prefix - The Namespace prefix being declared.
        uri - The Namespace URI the prefix is mapped to.
        shouldFlush - true if any open tags need to be closed first, this will impact which element the mapping applies to (open parent, or its up comming child)
        Returns:
        returns true if the call made a change to the current namespace information, false if it did not change anything, e.g. if the prefix/namespace mapping was already in scope from before.
        Throws:
        org.xml.sax.SAXException - The client may throw an exception during processing.
        See Also:
        ExtendedContentHandler.startPrefixMapping(java.lang.String, java.lang.String, boolean)
      • startPrefixMapping

        public void startPrefixMapping​(java.lang.String prefix,
                                       java.lang.String uri)
                                throws org.xml.sax.SAXException
        Deprecated.
        Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. This call will close any open tags so that the prefix mapping will not apply to the current element, but the up comming child.
        Parameters:
        prefix - The Namespace prefix being declared.
        uri - The Namespace URI the prefix is mapped to.
        Throws:
        org.xml.sax.SAXException - The client may throw an exception during processing.
        See Also:
        ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
      • reset

        public boolean reset()
        Deprecated.
        Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).
        Specified by:
        reset in interface Serializer
        Overrides:
        reset in class ToSAXHandler
        Returns:
        true if the class was successfuly reset.
        See Also:
        Serializer.reset()