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  

FormatterToText.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(FORMATTERTOTEXT_HEADER_GUARD_1357924680)
00058 #define FORMATTERTOTEXT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XMLSupport/XMLSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 // Base class header file.
00072 #include <PlatformSupport/FormatterListener.hpp>
00073 
00074 
00075 
00076 class Writer;
00077 class Locator;
00078 
00079 
00080 
00085 class XALAN_XMLSUPPORT_EXPORT FormatterToText : public FormatterListener
00086 {
00087 public:
00088 
00092     FormatterToText();
00093 
00101     FormatterToText(
00102             Writer&     writer,
00103             bool        normalizeLinefeed = true,
00104             bool        handleIgnorableWhitespace = true);
00105 
00114     FormatterToText(
00115             Writer&                 writer,
00116             const XalanDOMString&   encoding,
00117             bool                    normalizeLinefeed = true,
00118             bool                    handleIgnorableWhitespace = true);
00119 
00120     virtual
00121     ~FormatterToText();
00122 
00123 
00124     Writer*
00125     getWriter() const
00126     {
00127         return m_writer;
00128     }
00129 
00130     void
00131     setWriter(Writer*   theWriter)
00132     {
00133         m_writer = theWriter;
00134 
00135         update();
00136     }
00137 
00138     void
00139     clearEncoding();
00140 
00141     const XalanDOMString&
00142     getEncoding() const
00143     {
00144         return m_encoding;
00145     }
00146 
00147     void
00148     setEncoding(const XalanDOMString&   theEncoding)
00149     {
00150         m_encoding = theEncoding;
00151 
00152         update();
00153     }
00154 
00155     XalanDOMChar
00156     getMaxCharacter() const
00157     {
00158         return m_maxCharacter;
00159     }
00160 
00161     void
00162     setMaxCharacter(XalanDOMChar    theMaxChar)
00163     {
00164         m_maxCharacter = theMaxChar;
00165     }
00166 
00167     bool
00168     getNormalizeLinefeed() const
00169     {
00170         return m_normalize;
00171     }
00172 
00173     void
00174     setNormalizeLinefeed(bool   fNormalize)
00175     {
00176         m_normalize = fNormalize;
00177     }
00178 
00179     bool
00180     getHandleIgnorableWhitespace() const
00181     {
00182         return m_handleIgnorableWhitespace;
00183     }
00184 
00185     void
00186     setHandleIgnorableWhitespace(bool   fHandle)
00187     {
00188         m_handleIgnorableWhitespace = fHandle;
00189     }
00190 
00191     // These methods are inherited from FormatterListener ...
00192 
00193     virtual void
00194     setDocumentLocator(const Locator* const     locator);
00195 
00196     virtual void
00197     startDocument();
00198 
00199     virtual void
00200     endDocument();
00201 
00202     virtual void
00203     startElement(
00204             const   XMLCh* const    name,
00205             AttributeList&          attrs);
00206 
00207     virtual void
00208     endElement(const XMLCh* const   name);
00209 
00210     virtual void
00211     characters(
00212             const XMLCh* const  chars,
00213             const unsigned int  length);
00214 
00215     virtual void
00216     charactersRaw(
00217             const XMLCh* const  chars,
00218             const unsigned int  length);
00219 
00220     virtual void
00221     entityReference(const XMLCh* const  name);
00222 
00223     virtual void
00224     ignorableWhitespace(
00225             const XMLCh* const  chars,
00226             const unsigned int  length);
00227 
00228     virtual void
00229     processingInstruction(
00230             const XMLCh* const  target,
00231             const XMLCh* const  data);
00232 
00233     virtual void
00234     resetDocument();
00235 
00236     virtual void
00237     comment(const XMLCh* const  data);
00238 
00239     virtual void
00240     cdata(
00241             const XMLCh* const  ch,
00242             const unsigned int  length);
00243 
00244 private:
00245 
00246     // These are not implemented.
00247     FormatterToText(const FormatterToText&);
00248 
00249     FormatterToText&
00250     operator=(const FormatterToText&);
00251 
00252     bool
00253     operator==(const FormatterToText&) const;
00254 
00255     // Utility function to update various member variables
00256     // when data changes.
00257     void
00258     update();
00259 
00260     // Data members...
00261     Writer*         m_writer;
00262 
00263     XalanDOMChar    m_maxCharacter;
00264 
00265     XalanDOMString  m_encoding;
00266 
00267     bool            m_haveEncoding;
00268 
00269     bool            m_normalize;
00270 
00271     bool            m_handleIgnorableWhitespace;
00272 };
00273 
00274 
00275 
00276 #endif  // FORMATTERTOTEXT_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.