Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

FormatterToText Class Reference

This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and produces simple text only. More...

Inheritance diagram for FormatterToText:

List of all members.

Public Member Functions

• FormatterToText (MemoryManagerType &theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR)

  FormatterToText instance constructor.
  

• FormatterToText (Writer &writer, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManagerType &theManager XALAN_DEFAULT_MEMMGR)

  FormatterToText instance constructor.
  

• FormatterToText (Writer &writer, const XalanDOMString &encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManagerType &theManager XALAN_DEFAULT_MEMMGR)

  FormatterToText instance constructor.
  

• virtual ~FormatterToText ()
• MemoryManagerType & getMemoryManager ()
• Writer * getWriter () const
• void setWriter (Writer *theWriter)
• void clearEncoding ()
• const XalanDOMString & getEncoding () const
• void setEncoding (const XalanDOMString &theEncoding)
• XalanDOMChar getMaxCharacter () const
• void setMaxCharacter (XalanDOMChar theMaxChar)
• bool getNormalizeLinefeed () const
• void setNormalizeLinefeed (bool fNormalize)
• bool getHandleIgnorableWhitespace () const
• void setHandleIgnorableWhitespace (bool fHandle)
• virtual void setDocumentLocator (const LocatorType *const locator)
• virtual void startDocument ()
• virtual void endDocument ()
• virtual void startElement (const XMLCh *const name, AttributeListType &attrs)
• virtual void endElement (const XMLCh *const name)
• virtual void characters (const XMLCh *const chars, const unsigned int length)
• virtual void charactersRaw (const XMLCh *const chars, const unsigned int length)
• virtual void entityReference (const XMLCh *const name)

  Receive notification of a entityReference.
  

• virtual void ignorableWhitespace (const XMLCh *const chars, const unsigned int length)
• virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)
• virtual void resetDocument ()
• virtual void comment (const XMLCh *const data)

  Called when a Comment is to be constructed.
  

• virtual void cdata (const XMLCh *const ch, const unsigned int length)

Static Public Member Functions

• static FormatterToText * create (MemoryManagerType &theManager, Writer &writer, const XalanDOMString &encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true)

---

Detailed Description

This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and produces simple text only.

---

Constructor & Destructor Documentation

FormatterToText::FormatterToText (  MemoryManagerType &theManager  XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR  )

FormatterToText instance constructor.

FormatterToText::FormatterToText (  Writer &  writer, bool  normalizeLinefeed = true, bool  handleIgnorableWhitespace = true, MemoryManagerType &theManager  XALAN_DEFAULT_MEMMGR )

FormatterToText instance constructor. Parameters: writer  writer for output normalizeLindefeed  Normalize or (on certain platforms). handleIgnorableWhitespace  If true ignorableWhitespace() will write data to the Writer

FormatterToText::FormatterToText (  Writer &  writer, const XalanDOMString &  encoding, bool  normalizeLinefeed = true, bool  handleIgnorableWhitespace = true, MemoryManagerType &theManager  XALAN_DEFAULT_MEMMGR )

FormatterToText instance constructor. Parameters: writer  writer for output encoding  character encoding for the writer normalizeLindefeed  Normalize or on certain platforms. handleIgnorableWhitespace  If true ignorableWhitespace() will write data to the Writer

virtual FormatterToText::~FormatterToText (   )  [virtual]

---

Member Function Documentation

virtual void FormatterToText::cdata (  const XMLCh *const   ch, const unsigned int  length )  [virtual]

virtual void FormatterToText::characters (  const XMLCh *const   chars, const unsigned int  length )  [virtual]

virtual void FormatterToText::charactersRaw (  const XMLCh *const   chars, const unsigned int  length )  [virtual]

void FormatterToText::clearEncoding (   )

virtual void FormatterToText::comment (  const XMLCh *const   data  )  [virtual]

Called when a Comment is to be constructed. Parameters: data  pointer to comment data Exceptions: SAXException  Implements FormatterListener.

static FormatterToText* FormatterToText::create (  MemoryManagerType &  theManager, Writer &  writer, const XalanDOMString &  encoding, bool  normalizeLinefeed = true, bool  handleIgnorableWhitespace = true )  [static]

virtual void FormatterToText::endDocument (   )  [virtual]

Implements FormatterListener.

virtual void FormatterToText::endElement (  const XMLCh *const   name  )  [virtual]

Implements FormatterListener.

virtual void FormatterToText::entityReference (  const XMLCh *const   name  )  [virtual]

Receive notification of a entityReference. Parameters: data  pointer to characters from the XML document Exceptions: SAXException  Implements FormatterListener.

const XalanDOMString& FormatterToText::getEncoding (   )  const [virtual]

Reimplemented from FormatterListener.

bool FormatterToText::getHandleIgnorableWhitespace (   )  const

XalanDOMChar FormatterToText::getMaxCharacter (   )  const

MemoryManagerType& FormatterToText::getMemoryManager (   )

bool FormatterToText::getNormalizeLinefeed (   )  const

Writer* FormatterToText::getWriter (   )  const [virtual]

Reimplemented from FormatterListener.

virtual void FormatterToText::ignorableWhitespace (  const XMLCh *const   chars, const unsigned int  length )  [virtual]

virtual void FormatterToText::processingInstruction (  const XMLCh *const   target, const XMLCh *const   data )  [virtual]

Implements FormatterListener.

virtual void FormatterToText::resetDocument (   )  [virtual]

Implements FormatterListener.

virtual void FormatterToText::setDocumentLocator (  const LocatorType *const   locator  )  [virtual]

void FormatterToText::setEncoding (  const XalanDOMString &  theEncoding  )

void FormatterToText::setHandleIgnorableWhitespace (  bool  fHandle  )

void FormatterToText::setMaxCharacter (  XalanDOMChar  theMaxChar  )

void FormatterToText::setNormalizeLinefeed (  bool  fNormalize  )

void FormatterToText::setWriter (  Writer *  theWriter  )

virtual void FormatterToText::startDocument (   )  [virtual]

Implements FormatterListener.

virtual void FormatterToText::startElement (  const XMLCh *const   name, AttributeListType &  attrs )  [virtual]

---

The documentation for this class was generated from the following file:

• FormatterToText.hpp

Interpreting class diagrams

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

Xalan-C++ XSLT Processor Version 1.10 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.