123456789_123456789_123456789_123456789_123456789_

Module: REXML::StreamListener

Relationships & Source Files
Defined in: lib/rexml/streamlistener.rb

Overview

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.

Instance Method Summary

Instance Method Details

#attlistdecl(element_name, attributes, raw_content)

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

[ GitHub ] 

  


# File 'lib/rexml/streamlistener.rb', line 51



def attlistdecl element_name, attributes, raw_content
end


  








  

    #cdata(content)  
  



  

    
Called when  is encountered in a document.

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 83



def cdata content
end


  








  

    #comment(comment)  
  



  

    
Called when a comment is encountered.

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 33



def comment comment
end


  








  

    #doctype(name, pub_sys, long_name, uri)  
  



  

    
Handles a doctype declaration. Any attributes of the doctype which are
not supplied will be nil.  # EG, 

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 41



def doctype name, pub_sys, long_name, uri
end


  








  

    #doctype_end  
  



  

    
Called when the doctype is done

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 44



def doctype_end
end


  








  

    #elementdecl(content)  
  



  

    
  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 54



def elementdecl content
end


  








  

    #entity(content)  
  



  

    
Called when %foo; is encountered in a doctype declaration.

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 79



def entity content
end


  








  

    #entitydecl(content)  
  



  

    

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):

 

["YN", ""Yes"", "%"]

 

["YN", "Yes", "%"]

 

["WhatHeSaid", "He said %YN;"]

 

["open-hatch", "SYSTEM", "http://www.textuality.com/boilerplate/OpenHatch.xml"]

 

["open-hatch", "PUBLIC", "-//Textuality//TEXT Standard open-hatch boilerplate//EN", "http://www.textuality.com/boilerplate/OpenHatch.xml"]

 

["hatch-pic", "SYSTEM", "../grafix/OpenHatch.gif", "gif"]

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 72



def entitydecl content
end


  








  

    #instruction(name, instruction)  
  



  

    
Called when an instruction is encountered.  EG: 
"sheet='foo'"

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 29



def instruction name, instruction
end


  








  

    #notationdecl(content)  
  



  

    
  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 75



def notationdecl content
end


  








  

    #tag_end(name)  
  



  

    
Called when the end tag is reached.  In the case of , tag_end
will be called immediately after tag_start

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 19



def tag_end name
end


  








  

    #tag_start(name, attrs)  
  



  

    
Called when a tag is encountered.
use with assoc or rassoc.  IE, 
will result in
tag_start( "tag", # [["attr1","value1"],["attr2","value2"]])

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 14



def tag_start name, attrs
end


  








  

    #text(text)  
  



  

    
Called when text is encountered in the document

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 23



def text text
end


  








  

    #xmldecl(version, encoding, standalone)  
  



  

    
Called when an XML PI is encountered in the document.
EG: 

  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 90



def xmldecl version, encoding, standalone
end