Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FormatterListener.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(FORMATTERLISTENER_HEADER_GUARD_1357924680)
00058 #define FORMATTERLISTENER_HEADER_GUARD_1357924680
00059 
00067 
00068 
00069 
00070 // Base include file.  Must be first.
00071 #include <XMLSupport/XMLSupportDefinitions.hpp>
00072 
00073 
00074 
00075 #include <sax/DocumentHandler.hpp>
00076 
00077 
00078 
00079 #include <XalanDOM/XalanDOMString.hpp>
00080 
00081 
00082 
00087 class XALAN_XMLSUPPORT_EXPORT FormatterListener : public DocumentHandler
00088 {
00089 public:
00090 
00094     static void
00095     initialize();
00096 
00100     static void
00101     terminate();
00102 
00103 
00104     enum eFormat
00105     {
00106         OUTPUT_METHOD_NONE = 0,
00107         OUTPUT_METHOD_XML = 1,
00108         OUTPUT_METHOD_HTML = 2,
00109         OUTPUT_METHOD_TEXT = 3,
00110         OUTPUT_METHOD_DOM = 4,
00111         OUTPUT_METHOD_OTHER = 5
00112     };
00113 
00114     FormatterListener(eFormat   theFormat);
00115 
00116     virtual
00117     ~FormatterListener();
00118 
00119 
00120     eFormat
00121     getOutputFormat() const
00122     {
00123         return m_outputFormat;
00124     }
00125 
00135     virtual void
00136     charactersRaw(
00137             const XMLCh* const  chars,
00138             const unsigned int  length) = 0;
00139 
00146     virtual void
00147     comment(const XMLCh* const  data) = 0;
00148 
00170     virtual void
00171     cdata(
00172             const XMLCh* const  ch,
00173             const unsigned int  length) = 0;
00174 
00181     virtual void
00182     entityReference(const XMLCh* const  name) = 0;
00183 
00184 
00185 // These methods are inherited from DocumentHandler ...
00186 
00187     virtual void
00188     characters(
00189             const XMLCh* const  chars,
00190             const unsigned int  length) = 0;
00191 
00192     virtual void
00193     endDocument() = 0;
00194 
00195     virtual void
00196     endElement(const XMLCh* const   name) = 0;
00197 
00198     virtual void
00199     ignorableWhitespace(
00200             const XMLCh* const  chars,
00201             const unsigned int  length) = 0;
00202 
00203     virtual void
00204     processingInstruction(
00205             const XMLCh* const  target,
00206             const XMLCh* const  data) = 0;
00207 
00208     virtual void
00209     resetDocument() = 0;
00210 
00211     virtual void
00212     setDocumentLocator(const Locator* const     locator) = 0;
00213 
00214     virtual void
00215     startDocument() = 0;
00216 
00217     virtual void
00218     startElement(
00219             const   XMLCh* const    name,
00220             AttributeList&          attrs) = 0;
00221 
00222 
00223     // Used when creating PI to work around limitations of
00224     // our interfaces...
00225     static const XalanDOMString&    s_xsltNextIsRawString;
00226 
00227     static const XalanDOMString&    s_formatterListenerString;
00228 
00229 private:
00230 
00231     const eFormat   m_outputFormat;
00232 };
00233 
00234 
00235 
00236 #endif  // FORMATTERLISTENER_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.