Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

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

Inheritance diagram for FormatterToText:
FormatterListener

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.


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:
writerwriter for output
normalizeLindefeedNormalize
or
(on certain platforms).
handleIgnorableWhitespaceIf 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:
writerwriter for output
encodingcharacter encoding for the writer
normalizeLindefeedNormalize
or
on certain platforms.
handleIgnorableWhitespaceIf 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]

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

Implements FormatterListener.

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

Implements FormatterListener.

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

Receive notification of character data.

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

Parameters:
charspointer to characters from the XML document
lengthnumber 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:
datapointer 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:
datapointer 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]

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

Interpreting class diagrams

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

dot

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

Apache Logo