nsISAXLexicalHandler

SAX2 extension handler for lexical events.

This is an extension handler for SAX2 to provide lexical
information about an XML document, such as comments and CDATA
section boundaries.

The events in the lexical handler apply to the entire document,
not just to the document element, and all lexical handler events
must appear between the content handler’s startDocument and
endDocument events.

Methods

comment(chars)

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the
document element, including comments in the external DTD subset
(if read). Comments in the DTD must be properly nested inside
start/endDTD and start/endEntity events (if used).

Parameters

chars The characters in the comment.

startDTD(name, publicId, systemId)

Report the start of DTD declarations, if any.

This method is intended to report the beginning of the
DOCTYPE declaration; if the document has no DOCTYPE declaration,
this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler
events must appear between the startDTD and endDTD events.
Declarations are assumed to belong to the internal DTD subset
unless they appear between startEntity and endEntity events.
Comments and processing instructions from the DTD should also be
reported between the startDTD and endDTD events, in their
original order of (logical) occurrence; they are not required to
appear in their correct locations relative to DTDHandler or
DeclHandler events, however.

Note that the start/endDTD events will appear within the
start/endDocument events from ContentHandler and before the first
startElement event.

Parameters

name The document type name.
publicId The declared public identifier for the external DTD subset, or null if none was declared.
systemId The declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

endDTD()

Report the end of DTD declarations.

This method is intended to report the end of the
DOCTYPE declaration; if the document has no DOCTYPE declaration,
this method will not be invoked.

startCDATA()

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the
regular characters event; this event is intended only to report
the boundary.

endCDATA()

Report the end of a CDATA section.

startEntity(name)

Report the beginning of some internal and external XML entities.

Because of the streaming event model that SAX uses, some
entity boundaries cannot be reported under any circumstances:

1.) general entities within attribute values
2.) parameter entities within declarations

These will be silently expanded, with no indication of where
the original entity boundaries were.

Note also that the boundaries of character references (which
are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Parameters

name The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

endEntity(name)

Report the end of an entity.

Parameters

name The name of the entity that is ending.