Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Static Public Member Functions

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...

#include <FormatterToText.hpp>

Inherits FormatterListener.

Inherited by StylesheetExecutionContextDefault::FormatterToTextDOMString.

Collaboration diagram for FormatterToText:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Static Public Member Functions


Detailed Description

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

Definition at line 49 of file FormatterToText.hpp.


Constructor & Destructor Documentation

FormatterToText::FormatterToText ( MemoryManager &  theManager = XalanMemMgrs::getDefaultXercesMemMgr()  ) 

FormatterToText instance constructor.

FormatterToText::FormatterToText ( Writer writer,
bool  normalizeLinefeed = true,
bool  handleIgnorableWhitespace = true,
MemoryManager &  theManager = XalanMemMgrs::getDefaultXercesMemMgr() 
)

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,
MemoryManager &  theManager = XalanMemMgrs::getDefaultXercesMemMgr() 
)

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 size_type  length 
) [virtual]

Receive notification of cdata.

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 pointer to characters from the XML document
length number of characters to read from the array
Exceptions:
SAXException 

Implements FormatterListener.

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

Implements FormatterListener.

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

Receive notification of character data.

If available, when the disable-output-escaping attribute is used, output raw text without escaping.

Parameters:
chars pointer to characters from the XML document
length number of characters to read from the array
Exceptions:
SAXException 

Implements FormatterListener.

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 ( MemoryManager &  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 [inline, virtual]

Reimplemented from FormatterListener.

Definition at line 121 of file FormatterToText.hpp.

bool FormatterToText::getHandleIgnorableWhitespace (  )  const [inline]

Definition at line 159 of file FormatterToText.hpp.

XalanDOMChar FormatterToText::getMaxCharacter (  )  const [inline]

Definition at line 135 of file FormatterToText.hpp.

MemoryManager& FormatterToText::getMemoryManager (  )  [inline]

Definition at line 98 of file FormatterToText.hpp.

bool FormatterToText::getNormalizeLinefeed (  )  const [inline]

Definition at line 147 of file FormatterToText.hpp.

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

Reimplemented from FormatterListener.

Definition at line 104 of file FormatterToText.hpp.

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

Implements FormatterListener.

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 Locator *const   locator  )  [virtual]

Implements FormatterListener.

void FormatterToText::setEncoding ( const XalanDOMString theEncoding  )  [inline]

Definition at line 127 of file FormatterToText.hpp.

void FormatterToText::setHandleIgnorableWhitespace ( bool  fHandle  )  [inline]

Definition at line 165 of file FormatterToText.hpp.

void FormatterToText::setMaxCharacter ( XalanDOMChar  theMaxChar  )  [inline]

Definition at line 141 of file FormatterToText.hpp.

void FormatterToText::setNormalizeLinefeed ( bool  fNormalize  )  [inline]

Definition at line 153 of file FormatterToText.hpp.

void FormatterToText::setWriter ( Writer theWriter  )  [inline]

Definition at line 110 of file FormatterToText.hpp.

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:

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo