Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes

FormatterListener Class Reference

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

#include <FormatterListener.hpp>

Inherited by FormatterStringLengthCounter, FormatterToDeprecatedXercesDOM, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXercesDOM, FormatterToXML, StylesheetHandler, and XalanXMLSerializerBase.

Collaboration diagram for FormatterListener:
Collaboration graph
[legend]

List of all members.

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes


Detailed Description

A SAX-based formatter interface for the XSL processor.

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

Definition at line 56 of file FormatterListener.hpp.


Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler FormatterListener::ParentType

Definition at line 60 of file FormatterListener.hpp.

typedef XalanSize_t FormatterListener::size_type

Definition at line 63 of file FormatterListener.hpp.


Member Enumeration Documentation

Enumerator:
OUTPUT_METHOD_NONE 
OUTPUT_METHOD_XML 
OUTPUT_METHOD_HTML 
OUTPUT_METHOD_TEXT 
OUTPUT_METHOD_DOM 
OUTPUT_METHOD_OTHER 

Definition at line 65 of file FormatterListener.hpp.

Enumerator:
XML_VERSION_1_0 
XML_VERSION_1_1 

Definition at line 75 of file FormatterListener.hpp.


Constructor & Destructor Documentation

FormatterListener::FormatterListener ( eFormat  theFormat  ) 
virtual FormatterListener::~FormatterListener (  )  [virtual]

Member Function Documentation

virtual 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 

Implemented in FormatterToSourceTree, StylesheetHandler, FormatterToXercesDOM, FormatterToNull, FormatterToText, XalanXMLSerializerBase, and FormatterStringLengthCounter.

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

Implemented in FormatterToSourceTree, StylesheetHandler, FormatterToXercesDOM, FormatterToNull, FormatterToText, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, XalanXMLSerializerBase, and FormatterStringLengthCounter.

virtual void FormatterListener::comment ( const XMLCh *const   data  )  [pure virtual]
virtual void FormatterListener::endDocument (  )  [pure virtual]
virtual void FormatterListener::endElement ( const XMLCh *const   name  )  [pure virtual]
virtual void FormatterListener::entityReference ( const XMLCh *const   name  )  [pure virtual]
virtual const XalanDOMString& FormatterListener::getDoctypePublic (  )  const [virtual]

Reimplemented in FormatterToXML, and XalanXMLSerializerBase.

virtual const XalanDOMString& FormatterListener::getDoctypeSystem (  )  const [virtual]

Reimplemented in FormatterToXML, and XalanXMLSerializerBase.

virtual const XalanDOMString& FormatterListener::getEncoding (  )  const [virtual]
virtual int FormatterListener::getIndent (  )  const [virtual]

Reimplemented in FormatterToXML.

virtual const XalanDOMString& FormatterListener::getMediaType (  )  const [virtual]

Reimplemented in FormatterToXML.

eFormat FormatterListener::getOutputFormat (  )  const [inline]

Get the output format for the instance.

Returns:
An enum indicating the output format.

Definition at line 92 of file FormatterListener.hpp.

const PrefixResolver* FormatterListener::getPrefixResolver (  )  const [inline]

Get the PrefixResolver for the FormatterListener.

Returns:
A pointer to the PrefixResolver, if any.

Definition at line 126 of file FormatterListener.hpp.

virtual Writer* FormatterListener::getWriter (  )  const [virtual]
eXMLVersion FormatterListener::getXMLVersion (  )  const [inline]

Get the version of XML the FormatterListener is generating.

Returns:
An enum indication the XML version.

Definition at line 104 of file FormatterListener.hpp.

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

Determine if the version of XML output is 1.1.

Returns:
true if the output version is 1.1, false if not.

Definition at line 115 of file FormatterListener.hpp.

virtual void FormatterListener::processingInstruction ( const XMLCh *const   target,
const XMLCh *const   data 
) [pure virtual]
virtual void FormatterListener::resetDocument (  )  [pure virtual]
virtual void FormatterListener::setDocumentLocator ( const Locator *const   locator  )  [pure virtual]
void FormatterListener::setPrefixResolver ( const PrefixResolver thePrefixResolver  )  [inline]

Set the PrefixResolver for the FormatterListener.

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

Definition at line 137 of file FormatterListener.hpp.

void FormatterListener::setXMLVersion ( eXMLVersion  theVersion  )  [inline, protected]

Set the output version during serializing.

Parameters:
theVersion XML version of the output

Definition at line 285 of file FormatterListener.hpp.

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

Member Data Documentation

Definition at line 275 of file FormatterListener.hpp.

Definition at line 277 of file FormatterListener.hpp.

const XalanDOMChar FormatterListener::s_piData[] [static]

Definition at line 261 of file FormatterListener.hpp.

Definition at line 268 of file FormatterListener.hpp.

const XalanDOMChar FormatterListener::s_piTarget[] [static]

Definition at line 259 of file FormatterListener.hpp.

Definition at line 267 of file FormatterListener.hpp.


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