File: Element.html

package info (click to toggle)
librexml-ruby 1.2.5-1
links: PTS
area: main
in suites: woody
size: 792 kB
ctags: 655
sloc: ruby: 3,778; xml: 1,609; java: 109; makefile: 43
file content (459 lines) | stat: -rw-r--r-- 9,640 bytes
<HTML>
<HEAD>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<STYLE TYPE="text/css">@import "style.css";</STYLE>
</HEAD>
<BODY>
<H1>class Element</H1>
<B>Extends </B>Parent<BR>
<B>Includes </B>Namespace<HR>
   Represents a tagged XML element.  Elements are characterized by having children, attributes, and names, and can themselves be children.
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
<H2>Attributes</H2>
<UL>
<LI>
<A HREF="#NA">attributes</A>
</LI>
<LI>
<A HREF="#N14">context</A>
</LI>
<LI>
<A HREF="#NF">elements</A>
</LI>
</UL>
<H2>Methods</H2>
<UL>
<LI>
<A HREF="#N9C">add_attribute</A>
</LI>
<LI>
<A HREF="#NA3">add_attributes</A>
</LI>
<LI>
<A HREF="#N42">add_element</A>
</LI>
<LI>
<A HREF="#N3A">add_namespace</A>
</LI>
<LI>
<A HREF="#N8E">add_text</A>
</LI>
<LI>
<A HREF="#N1C">clone</A>
</LI>
<LI>
<A HREF="#NA7">delete_attribute</A>
</LI>
<LI>
<A HREF="#N49">delete_element</A>
</LI>
<LI>
<A HREF="#N3E">delete_namespace</A>
</LI>
<LI>
<A HREF="#N5F">each_element</A>
</LI>
<LI>
<A HREF="#N57">each_element_with_attribute</A>
</LI>
<LI>
<A HREF="#N5B">each_element_with_text</A>
</LI>
<LI>
<A HREF="#NB5">each_with_something</A>
</LI>
<LI>
<A HREF="#NB2">Element</A>
</LI>
<LI>
<A HREF="#NB9">Element</A>
</LI>
<LI>
<A HREF="#N63">get_elements</A>
</LI>
<LI>
<A HREF="#N80">get_text</A>
</LI>
<LI>
<A HREF="#N95">has_attributes</A>
</LI>
<LI>
<A HREF="#N50">has_elements</A>
</LI>
<LI>
<A HREF="#N72">has_text</A>
</LI>
<LI>
<A HREF="#N18">initialize</A>
</LI>
<LI>
<A HREF="#N33">namespace</A>
</LI>
<LI>
<A HREF="#N6A">next_element</A>
</LI>
<LI>
<A HREF="#NC0">parse</A>
</LI>
<LI>
<A HREF="#NC3">parse_children</A>
</LI>
<LI>
<A HREF="#N2C">prefixes</A>
</LI>
<LI>
<A HREF="#N6E">previous_element</A>
</LI>
<LI>
<A HREF="#N29">raw</A>
</LI>
<LI>
<A HREF="#N1F">root</A>
</LI>
<LI>
<A HREF="#N79">text</A>
</LI>
<LI>
<A HREF="#N87">text=</A>
</LI>
<LI>
<A HREF="#N26">whitespace</A>
</LI>
<LI>
<A HREF="#NAE">write</A>
</LI>
<LI>
<A HREF="#NC7">write_children</A>
</LI>
</UL>
<HR>
<H2>Attributes</H2>
<DIV CLASS="attributes">
<DIV STYLE="padding-bottom: 0.5em; padding-top: 0.5em;">
<B>attributes</B> (reader)
			
     Mechanisms for accessing attributes and child elements of this element.
  </DIV>
<DIV STYLE="padding-bottom: 0.5em; padding-top: 0.5em;">
<B>context</B> (accessor)
			</DIV>
<DIV STYLE="padding-bottom: 0.5em; padding-top: 0.5em;">
<B>elements</B> (reader)
			
     Mechanisms for accessing attributes and child elements of this element.
  </DIV>
</DIV>
<H2>Methods</H2>
<DIV CLASS="method">
<A NAME="N9C">
<H3>add_attribute</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the Attribute added
    <HR>
    
     Adds an attribute to this element, overwriting any existing attribute by the same name. 
  </DIV>
<DIV CLASS="method">
<A NAME="NA3">
<H3>add_attributes</H3>
</A>
<HR>
     Add multiple attributes to this element.  EG: el.add_attributes( {"name1"=&gt;"value1", "name2"=&gt;"value2"} ) el.add_attributes( [ ["name1","value1"], ["name2"=&gt;"value2"] ] ) 
  </DIV>
<DIV CLASS="method">
<A NAME="N42">
<H3>add_element</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the Element that was added
    <HR>
    
     Adds a child to this element, optionally setting attributes in the element. 
  </DIV>
<DIV CLASS="method">
<A NAME="N3A">
<H3>add_namespace</H3>
</A>
<HR>
     Adds a namespace to this element 
  </DIV>
<DIV CLASS="method">
<A NAME="N8E">
<H3>add_text</H3>
</A><B style="padding-right: 1em;">Returns</B>
      self.  NOTE that contrary to most REXML methods, the object added to the parent is not returned.
    <HR>
    
     A helper method to add a Text child.  Actual Text instances can be added with regular Parent methods, such as add() and &lt;&lt;() 
  </DIV>
<DIV CLASS="method">
<A NAME="N1C">
<H3>clone</H3>
</A>
<HR>
</DIV>
<DIV CLASS="method">
<A NAME="NA7">
<H3>delete_attribute</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the attribute removed, or nil if this Element did not contain a matching attribute
    <HR>
    
     Removes an attribute 
  </DIV>
<DIV CLASS="method">
<A NAME="N49">
<H3>delete_element</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the element that was removed.
    <HR>
    
     Deletes a child element. 
  </DIV>
<DIV CLASS="method">
<A NAME="N3E">
<H3>delete_namespace</H3>
</A>
<HR>
     NEEDS DOCUMENTATION
  </DIV>
<DIV CLASS="method">
<A NAME="N5F">
<H3>each_element</H3>
</A>
<HR>
     Synonym for elements.each
  </DIV>
<DIV CLASS="method">
<A NAME="N57">
<H3>each_element_with_attribute</H3>
</A>
<HR>
     Iterates through the children, yielding for each Element that has a particular attribute set. 
  </DIV>
<DIV CLASS="method">
<A NAME="N5B">
<H3>each_element_with_text</H3>
</A>
<HR>
     Iterates through the children, yielding for each Element that has a particular text set. @see text
  </DIV>
<DIV CLASS="method">
<A NAME="NB5">
<H3>each_with_something</H3>
</A>
<HR>
     A private helper method
  </DIV>
<DIV CLASS="method">
<A NAME="NB2">
<H3>Element</H3>
</A>
<HR>
</DIV>
<DIV CLASS="method">
<A NAME="NB9">
<H3>Element</H3>
</A><B style="padding-right: 1em;">Returns</B>
      an array with [tag_name_S, closed_B, attributes_A]
    <HR>
    
     A helper method, to consolidate the common code between parse and parse_stream. @return an array with [tag_name_S, closed_B, attributes_A]
  </DIV>
<DIV CLASS="method">
<A NAME="N63">
<H3>get_elements</H3>
</A><B style="padding-right: 1em;">Returns</B>
      an array of Elements that match the supplied path 
    <HR>
    
     This is a little slower than calling elements.each directly. 
  </DIV>
<DIV CLASS="method">
<A NAME="N80">
<H3>get_text</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the first Text child encountered.
    <HR>
    
     This is the same method as text(), only this method returns the actual Text object, rather than the String content. 
  </DIV>
<DIV CLASS="method">
<A NAME="N95">
<H3>has_attributes</H3>
</A><B style="padding-right: 1em;">Returns</B>
      true if this element has any attributes set, false otherwise.
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N50">
<H3>has_elements</H3>
</A><B style="padding-right: 1em;">Returns</B>
      true if this element has at least one child Element
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N72">
<H3>has_text</H3>
</A><B style="padding-right: 1em;">Returns</B>
      true if this element has at least one Text child
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N18">
<H3>initialize</H3>
</A>
<HR>
     Constructor 
  </DIV>
<DIV CLASS="method">
<A NAME="N33">
<H3>namespace</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the URI for a namespace, or the empty string if no such  namespace is declared
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N6A">
<H3>next_element</H3>
</A>
<HR>
     Returns the next sibling that is an element, or nil if there is no Element sibling after this one
  </DIV>
<DIV CLASS="method">
<A NAME="NC0">
<H3>parse</H3>
</A>
<HR>
</DIV>
<DIV CLASS="method">
<A NAME="NC3">
<H3>parse_children</H3>
</A>
<HR>
     A private helper method
  </DIV>
<DIV CLASS="method">
<A NAME="N2C">
<H3>prefixes</H3>
</A><B style="padding-right: 1em;">Returns</B>
      an Array of all defined namespaces
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N6E">
<H3>previous_element</H3>
</A>
<HR>
     Returns the previous sibling that is an element, or nil if there is no Element sibling prior to this one
  </DIV>
<DIV CLASS="method">
<A NAME="N29">
<H3>raw</H3>
</A>
<HR>
</DIV>
<DIV CLASS="method">
<A NAME="N1F">
<H3>root</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the root of the document that this element belongs to. If this element doesn't belong to a document, but does belong to another Element, the parent's root will be returned, until the earliest ancestor is found.
    <HR>
    
     
  
</DIV>
<DIV CLASS="method">
<A NAME="N79">
<H3>text</H3>
</A><B style="padding-right: 1em;">Returns</B>
      the String content of the first child text element  encountered.  
    <HR>
    
     A convenience method which returns the first child text element. NOTE that an element may have multiple Text elements, perhaps separated by other children; consider: "&lt;p&gt;some text &lt;b&gt;this is bold!&lt;/b&gt; more text&lt;p&gt;" The element &lt;p&gt; has two text elements, "some text " and " more text". This method would return only the first, "some text ". 
  </DIV>
<DIV CLASS="method">
<A NAME="N87">
<H3>text=</H3>
</A><B style="padding-right: 1em;">Returns</B>
      self.  NOTE that contrary to most REXML methods, the replaced content is not returned.
    <HR>
    
     Sets the first Text child of this object.  See text() for a discussion about Text children. If a Text child already exists, the child is replaced by this content.  This means that Text content can be deleted by calling this method with a nil argument.  In this case, the next Text child becomes the first Text child.  In no case is the order of any siblings disturbed. 
  </DIV>
<DIV CLASS="method">
<A NAME="N26">
<H3>whitespace</H3>
</A>
<HR>
</DIV>
<DIV CLASS="method">
<A NAME="NAE">
<H3>write</H3>
</A>
<HR>
     Writes out this element, and recursively, all children. 
  </DIV>
<DIV CLASS="method">
<A NAME="NC7">
<H3>write_children</H3>
</A>
<HR>
     A private helper method
  </DIV>
<DIV CLASS="footer">
			API documentation generated by <A HREF="http://www.germane-software.com/~ser/Software/api2xml">API2XML</A>
</DIV>
</BODY>
</HTML>