module REXML::SAX2Listener - rexml: Ruby Standard Library Documentation

# module REXML::SAX2Listener

A template for stream parser listeners. Note that the declarations (attlistdecl, elementdecl, etc) are trivially processed; `REXML` doesn’t yet handle doctype entity declarations, so you have to parse them out yourself.

### Missing methods from SAX2¶ ↑

    ignorable_whitespace

### Methods extending SAX2¶ ↑

`WARNING` These methods are certainly going to change, until DTDs are fully supported. Be aware of this.

    start_document
    end_document
    doctype
    elementdecl
    attlistdecl
    entitydecl
    notationdecl
    cdata
    xmldecl
    comment

### Public Instance Methods

attlistdecl(element, pairs, contents) click to toggle source

If a doctype includes an ATTLIST declaration, it will cause this method to be called. The content is the declaration itself, unparsed. EG, <!ATTLIST el attr CDATA REQUIRED> will come to this method as “el attr CDATA REQUIRED”. This is the same for all of the .*decl methods.

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 53
    def attlistdecl(element, pairs, contents)
    end

cdata(content) click to toggle source

Called when <![CDATA[ … ]]> is encountered in a document. @p content “…”

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 81
    def cdata content
    end

characters(text) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 36
    def characters text
    end

comment(comment) click to toggle source

Called when a comment is encountered. @p comment The content of the comment

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 93
    def comment comment
    end

doctype(name, pub_sys, long_name, uri) click to toggle source

Handles a doctype declaration. Any attributes of the doctype which are not supplied will be nil. # EG, <!DOCTYPE me PUBLIC “foo” “bar”> @p name the name of the doctype; EG, “me” @p pub_sys “PUBLIC”, “SYSTEM”, or nil. EG, “PUBLIC” @p long_name the supplied long name, or nil. EG, “foo” @p uri the uri of the doctype, or nil. EG, “bar”

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 46
    def doctype name, pub_sys, long_name, uri
    end

elementdecl(content) click to toggle source

<!ELEMENT …>

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 56
    def elementdecl content
    end

end_document() click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 26
    def end_document
    end

end_element(uri, localname, qname) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 34
    def end_element uri, localname, qname
    end

end_prefix_mapping(prefix) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 30
    def end_prefix_mapping prefix
    end

entitydecl(declaration) click to toggle source

<!ENTITY …> The argument passed to this method is an array of the entity declaration. It can be in a number of formats, but in general it returns (example, result):

    <!ENTITY % YN '"Yes"'>
    ["%", "YN", "\"Yes\""]
    <!ENTITY % YN 'Yes'>
    ["%", "YN", "Yes"]
    <!ENTITY WhatHeSaid "He said %YN;">
    ["WhatHeSaid", "He said %YN;"]
    <!ENTITY open-hatch SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml">
    ["open-hatch", "SYSTEM", "http://www.textuality.com/boilerplate/OpenHatch.xml"]
    <!ENTITY open-hatch PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN" "http://www.textuality.com/boilerplate/OpenHatch.xml">

“open-hatch”, “PUBLIC”, “-//Textuality//TEXT Standard open-hatch boilerplate//EN”, “www.textuality.com/boilerplate/OpenHatch.xml”

  <!ENTITY hatch-pic SYSTEM “../grafix/OpenHatch.gif” NDATA gif>

  “hatch-pic”, “SYSTEM”, “../grafix/OpenHatch.gif”, “NDATA”, “gif”

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 74
    def entitydecl declaration
    end

notationdecl(name, public_or_system, public_id, system_id) click to toggle source

<!NOTATION …>

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 77
    def notationdecl name, public_or_system, public_id, system_id
    end

processing_instruction(target, data) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 38
    def processing_instruction target, data
    end

progress(position) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 95
    def progress position
    end

start_document() click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 24
    def start_document
    end

start_element(uri, localname, qname, attributes) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 32
    def start_element uri, localname, qname, attributes
    end

start_prefix_mapping(prefix, uri) click to toggle source

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 28
    def start_prefix_mapping prefix, uri
    end

xmldecl(version, encoding, standalone) click to toggle source

Called when an XML PI is encountered in the document. EG: <?xml version=“1.0” encoding=“utf”?> @p version the version attribute value. EG, “1.0” @p encoding the encoding attribute value, or nil. EG, “utf” @p standalone the standalone attribute value, or nil. EG, nil @p spaced the declaration is followed by a line break

    # File rexml-3.4.0/lib/rexml/sax2listener.rb, line 89
    def xmldecl version, encoding, standalone
    end