Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

FormatterListener Class Reference

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

Inheritance diagram for FormatterListener:

FormatterStringLengthCounter FormatterToDeprecatedXercesDOM FormatterToDOM FormatterToNull FormatterToSourceTree FormatterToText FormatterToXercesDOM FormatterToXML StylesheetHandler XalanXMLSerializerBase 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.


Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler FormatterListener::ParentType
 

typedef unsigned int FormatterListener::size_type
 

Reimplemented in FormatterStringLengthCounter.


Member Enumeration Documentation

enum FormatterListener::eFormat
 

Enumerator:
OUTPUT_METHOD_NONE 
OUTPUT_METHOD_XML 
OUTPUT_METHOD_HTML 
OUTPUT_METHOD_TEXT 
OUTPUT_METHOD_DOM 
OUTPUT_METHOD_OTHER 

enum FormatterListener::eXMLVersion
 

Enumerator:
XML_VERSION_1_0 
XML_VERSION_1_1 


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, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToText, FormatterToXML, XalanXMLSerializerBase, FormatterStringLengthCounter, and StylesheetHandler.

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

Implemented in FormatterToSourceTree, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToText, FormatterToXML, XalanXMLSerializerBase, FormatterStringLengthCounter, and StylesheetHandler.

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, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToNull, FormatterToText, FormatterToXML, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, XalanXMLSerializerBase, FormatterStringLengthCounter, and StylesheetHandler.

virtual 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 

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

virtual void FormatterListener::endDocument  )  [pure virtual]
 

Implemented in FormatterToSourceTree, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToText, FormatterToXML, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, FormatterStringLengthCounter, and StylesheetHandler.

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

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

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

Receive notification of a entityReference.

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

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

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]
 

Reimplemented in FormatterToText, FormatterToXML, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, and XalanXMLSerializerBase.

virtual int FormatterListener::getIndent  )  const [virtual]
 

Reimplemented in FormatterToXML.

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

Reimplemented in FormatterToXML.

eFormat FormatterListener::getOutputFormat  )  const
 

Get the output format for the instance.

Returns:
An enum indicating the output format.

const PrefixResolver* FormatterListener::getPrefixResolver  )  const
 

Get the PrefixResolver for the FormatterListener.

Returns:
A pointer to the PrefixResolver, if any.

virtual Writer* FormatterListener::getWriter  )  const [virtual]
 

Reimplemented in FormatterToText, FormatterToXML, and FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >.

eXMLVersion FormatterListener::getXMLVersion  )  const
 

Get the version of XML the FormatterListener is generating.

Returns:
An enum indication the XML version.

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

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

bool FormatterListener::isXML1_1Version  )  const
 

Determine if the version of XML output is 1.1.

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

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

Implemented in FormatterToSourceTree, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToText, FormatterToXML, XalanXMLSerializerBase, FormatterStringLengthCounter, and StylesheetHandler.

virtual void FormatterListener::resetDocument  )  [pure virtual]
 

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

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

Implemented in XalanXMLSerializerBase.

void FormatterListener::setPrefixResolver const PrefixResolver thePrefixResolver  ) 
 

Set the PrefixResolver for the FormatterListener.

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

void FormatterListener::setXMLVersion eXMLVersion  theVersion  )  [protected]
 

Set the output version during serializing.

Parameters:
theVersion XML version of the output

virtual void FormatterListener::startDocument  )  [pure virtual]
 

Implemented in FormatterToSourceTree, FormatterToXercesDOM, FormatterToDeprecatedXercesDOM, FormatterToDOM, FormatterToHTML, FormatterToNull, FormatterToText, FormatterToXML, XalanXMLSerializerBase, FormatterStringLengthCounter, and StylesheetHandler.

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

Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, and XalanXMLSerializerBase.


Member Data Documentation

const PrefixResolver* FormatterListener::m_prefixResolver [protected]
 

const XalanDOMString FormatterListener::s_emptyString [static, 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.

dot

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

Apache Logo