Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

FormatterListener Class Reference

A SAX-based formatter interface for the XSL processor. More...

#include <FormatterListener.hpp>

Inheritance diagram for FormatterListener:

DocumentHandler FormatterToDOM FormatterToNull FormatterToSourceTree FormatterToText FormatterToXML StylesheetHandler FormatterToHTML Collaboration diagram for FormatterListener:

List of all members.

Public Types

Public Methods

Static Public Attributes

Protected Attributes


Detailed Description

A SAX-based formatter interface for the XSL processor.

This interface will be called as result tree elements are constructed.


Member Typedef Documentation

typedef unsigned int FormatterListener::size_type


Member Enumeration Documentation

enum FormatterListener::eFormat

Enumeration values:
OUTPUT_METHOD_NONE  
OUTPUT_METHOD_XML  
OUTPUT_METHOD_HTML  
OUTPUT_METHOD_TEXT  
OUTPUT_METHOD_DOM  
OUTPUT_METHOD_OTHER  

Constructor & Destructor Documentation

FormatterListener::FormatterListener ( eFormat theFormat)

virtual FormatterListener::~FormatterListener () [virtual]


Member Function Documentation

void FormatterListener::cdata ( const XMLCh * const ch,
const size_type length) [pure 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  

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

void FormatterListener::charactersRaw ( const XMLCh * const chars,
const size_type length) [pure 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  

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

Called when a Comment is to be constructed.

Parameters:
data   pointer to comment data
Exceptions:
SAXException  

Reimplemented in FormatterToDOM, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

virtual void FormatterListener::endDocument () [pure virtual]

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

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

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

void FormatterListener::entityReference ( const XMLCh * const data) [pure virtual]

Receive notification of a entityReference.

Parameters:
data   pointer to characters from the XML document
Exceptions:
SAXException  

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

eFormat FormatterListener::getOutputFormat () const

const PrefixResolver * FormatterListener::getPrefixResolver () const

Get the PrefixResolver for the FormatterListener.

Returns:
A pointer to the PrefixResolver, if any.

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

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

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

virtual void FormatterListener::resetDocument () [pure virtual]

Reimplemented in FormatterToDOM, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

virtual void FormatterListener::setDocumentLocator ( const Locator * const locator) [pure virtual]

Reimplemented in FormatterToDOM, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

void FormatterListener::setPrefixResolver ( const PrefixResolver * thePrefixResolver)

Set the PrefixResolver for the FormatterListener.

Parameters:
thePrefixResolver   A pointer to the PrefixResolver, if any.

virtual void FormatterListener::startDocument () [pure virtual]

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.

virtual void FormatterListener::startElement ( const XMLCh * const name,
AttributeList & attrs) [pure virtual]

Reimplemented in FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXML, and StylesheetHandler.


Member Data Documentation

const PrefixResolver * FormatterListener::m_prefixResolver [protected]

const XalanDOMChar FormatterListener::s_piData[] [static]

const XalanDOMString::size_type FormatterListener::s_piDataLength [static]

const XalanDOMChar FormatterListener::s_piTarget[] [static]

const XalanDOMString::size_type FormatterListener::s_piTargetLength [static]


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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.