A SAX-based formatter interface for the XSL processor.
More...
#include <FormatterListener.hpp>
Inherits XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler.
Inherited by FormatterStringLengthCounter, FormatterToDeprecatedXercesDOM, FormatterToNull, FormatterToSourceTree, FormatterToText, FormatterToXercesDOM, FormatterToXML, StylesheetHandler, and XalanXMLSerializerBase.
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.
◆ ParentType
◆ size_type
◆ eFormat
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.
◆ eXMLVersion
◆ FormatterListener()
FormatterListener::FormatterListener |
( |
eFormat |
theFormat | ) |
|
◆ ~FormatterListener()
virtual FormatterListener::~FormatterListener |
( |
| ) |
|
|
virtual |
◆ cdata()
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
-
Implemented in FormatterToText, FormatterToXML, StylesheetHandler, XalanXMLSerializerBase, FormatterToSourceTree, FormatterToHTML, FormatterStringLengthCounter, FormatterToNull, and FormatterToXercesDOM.
◆ characters()
virtual void FormatterListener::characters |
( |
const XMLCh *const |
chars, |
|
|
const size_type |
length |
|
) |
| |
|
pure virtual |
◆ charactersRaw()
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
-
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, FormatterToText, FormatterToXML, StylesheetHandler, FormatterToSourceTree, XalanXMLSerializerBase, FormatterToXercesDOM, FormatterStringLengthCounter, and FormatterToNull.
◆ comment()
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
-
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, StylesheetHandler, FormatterToText, FormatterToXML, XalanXMLSerializerBase, FormatterToSourceTree, FormatterToDeprecatedXercesDOM, FormatterStringLengthCounter, FormatterToNull, and FormatterToXercesDOM.
◆ endDocument()
virtual void FormatterListener::endDocument |
( |
| ) |
|
|
pure virtual |
Implemented in StylesheetHandler, FormatterToText, FormatterToSourceTree, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, FormatterToXML, FormatterToDeprecatedXercesDOM, FormatterToXercesDOM, FormatterToHTML, FormatterStringLengthCounter, and FormatterToNull.
◆ endElement()
virtual void FormatterListener::endElement |
( |
const XMLCh *const |
name | ) |
|
|
pure virtual |
Implemented in StylesheetHandler, FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, FormatterToText, FormatterToSourceTree, FormatterToXML, FormatterToDeprecatedXercesDOM, XalanXMLSerializerBase, FormatterToXercesDOM, FormatterToHTML, FormatterStringLengthCounter, and FormatterToNull.
◆ entityReference()
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
-
Implemented in FormatterToXMLUnicode< UnicodeWriter, ConstantsType, CharPredicate, IndentHandler, XMLVersion >, StylesheetHandler, FormatterToText, FormatterToXML, FormatterToSourceTree, FormatterToHTML, XalanXMLSerializerBase, FormatterToDeprecatedXercesDOM, FormatterToXercesDOM, FormatterStringLengthCounter, and FormatterToNull.
◆ getDoctypePublic()
virtual const XalanDOMString& FormatterListener::getDoctypePublic |
( |
| ) |
const |
|
virtual |
◆ getDoctypeSystem()
virtual const XalanDOMString& FormatterListener::getDoctypeSystem |
( |
| ) |
const |
|
virtual |
◆ getEncoding()
virtual const XalanDOMString& FormatterListener::getEncoding |
( |
| ) |
const |
|
virtual |
◆ getIndent()
virtual int FormatterListener::getIndent |
( |
| ) |
const |
|
virtual |
◆ getMediaType()
virtual const XalanDOMString& FormatterListener::getMediaType |
( |
| ) |
const |
|
virtual |
◆ getOutputFormat()
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.
◆ getPrefixResolver()
◆ getWriter()
virtual Writer* FormatterListener::getWriter |
( |
| ) |
const |
|
virtual |
◆ getXMLVersion()
◆ ignorableWhitespace()
virtual void FormatterListener::ignorableWhitespace |
( |
const XMLCh *const |
chars, |
|
|
const size_type |
length |
|
) |
| |
|
pure virtual |
◆ isXML1_1Version()
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.
◆ processingInstruction()
virtual void FormatterListener::processingInstruction |
( |
const XMLCh *const |
target, |
|
|
const XMLCh *const |
data |
|
) |
| |
|
pure virtual |
◆ resetDocument()
virtual void FormatterListener::resetDocument |
( |
| ) |
|
|
pure virtual |
◆ setDocumentLocator()
virtual void FormatterListener::setDocumentLocator |
( |
const Locator *const |
locator | ) |
|
|
pure virtual |
◆ setPrefixResolver()
void FormatterListener::setPrefixResolver |
( |
const PrefixResolver * |
thePrefixResolver | ) |
|
|
inline |
◆ setXMLVersion()
void FormatterListener::setXMLVersion |
( |
eXMLVersion |
theVersion | ) |
|
|
inlineprotected |
Set the output version during serializing.
- Parameters
-
theVersion | XML version of the output |
Definition at line 285 of file FormatterListener.hpp.
◆ startDocument()
virtual void FormatterListener::startDocument |
( |
| ) |
|
|
pure virtual |
◆ startElement()
virtual void FormatterListener::startElement |
( |
const XMLCh *const |
name, |
|
|
AttributeList & |
attrs |
|
) |
| |
|
pure virtual |
◆ m_prefixResolver
◆ s_emptyString
◆ s_piData
const XalanDOMChar FormatterListener::s_piData[] |
|
static |
◆ s_piDataLength
◆ s_piTarget
const XalanDOMChar FormatterListener::s_piTarget[] |
|
static |
◆ s_piTargetLength
The documentation for this class was generated from the following file: