4Suite™ API Documentation

# ► Module Ft.Xml.Lib.XmlPrinter

This module supports document serialization in XML syntax.

    Copyright 2005 Fourthought, Inc. (USA).
    Detailed license and copyright information: http://4suite.org/COPYRIGHT
    Project home, documentation, distributions: http://4suite.org/

Classes: XmlPrinter

## Classes

class XmlPrinter
  An XmlPrinter instance provides functions for serializing an XML or XML-like document to a stream, based on SAX-like event calls initiated by an Ft.Xml.Lib.Print.PrintVisitor instance.

      The methods in this base class attempt to emit a well-formed parsed
      general entity conformant to XML 1.0 syntax, with no extra
      whitespace added for visual formatting. Subclasses may emit
      documents conformant to other syntax specifications or with
      additional whitespace for indenting.

      The degree of well-formedness of the output depends on the data
      supplied in the event calls; no checks are done for conditions that
      would result in syntax errors, such as two attributes with the same
      name, "--" in a comment, etc. However, attribute() will do nothing
      if the previous event was not startElement(), thus preventing
      spurious attribute serializations.

  ### Methods

  __init__(self, stream, encoding)
    Creates an XmlPrinter instance.

        stream must be a file-like object open for writing binary
        data. encoding specifies the encoding which is to be used for
        writing to the stream.

  attribute(self, elementUri, elementName, name, value)
    Handles an attribute event.

        Writes an attribute to the stream as a space followed by
        the name, '=', and quote-delimited value. It is the caller's
        responsibility to ensure that this is called in the correct
        context, if well-formed output is desired.

        Preference is given to quotes (") around attribute values, in
        accordance with the DomWriter interface in DOM Level 3 Load and
        Save (25 July 2002 WD), although a value that contains quotes
        but no apostrophes will be delimited by apostrophes (') instead.
        The elementName arguments are not used by default,
        but may be used by subclasses.

  cdataSection(self, data)
    Handles a cdataSection event.

        Writes character data to the stream as a CDATA section.

  comment(self, data)
    Handles a comment event.

        Writes a comment to the stream.

  doctype(self, name, publicId, systemId)
    Handles a doctype event.

        Writes a document type declaration to the stream.

  endDocument(self)
    Handles an endDocument event.

        Writes any necessary final output to the stream.

  endElement(self, namespaceUri, tagName)
    Handles an endElement event.

        Writes the closing tag for an element to the stream, or, if the
        element had no content, finishes writing the empty element tag.

        The namespaceUri argument is ignored in this class.

  processingInstruction(self, target, data)
    Handles a processingInstruction event.

        Writes a processing instruction to the stream.

  startDocument(self, version='1.0', standalone=None)
    Handles a startDocument event.

        Writes XML declaration or text declaration to the stream.

  startElement(self, namespaceUri, tagName, namespaces, attributes)
    Handles a startElement event.

        Writes part of an element's start-tag or empty-element tag to
        the stream, and closes the start tag of the previous element,
        if one remained open. Writes the xmlns attributes for the given
        dictionary of namespaces, and invokes attribute() as neeeded to
        write the given dictionary of attributes.

        The namespaceUri argument is ignored in this class.

  text(self, text, disableEscaping=0)
    Handles a text event.

        Writes character data to the stream. If the disableEscaping flag
        is not set, then unencodable characters are replaced with
        numeric character references; "&" and "<" are escaped as "&amp;"
        and "&lt;"; and ">" is escaped as "&gt;" if it is preceded by
        "]]". If the disableEscaping flag is set, then the characters
        are written to the stream with no escaping of any kind, which
        will result in an exception if there are unencodable characters.

  ### Members

  attrEntitiesApos = <cEntityMap>
  attrEntitiesQuot = <cEntityMap>
  textEntities = <cEntityMap>