File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Node.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module REXML::Node - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-each_recursive">#each_recursive</a>
<li ><a href="#method-i-find_first_recursive">#find_first_recursive</a>
<li ><a href="#method-i-indent">#indent</a>
<li ><a href="#method-i-index_in_parent">#index_in_parent</a>
<li ><a href="#method-i-next_sibling_node">#next_sibling_node</a>
<li ><a href="#method-i-parent-3F">#parent?</a>
<li ><a href="#method-i-previous_sibling_node">#previous_sibling_node</a>
<li ><a href="#method-i-to_s">#to_s</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-REXML::Node">
<h1 id="module-REXML::Node" class="module">
module REXML::Node
</h1>
<section class="description">
<p>Represents a node in the tree. Nodes are never encountered except as superclasses of other objects. Nodes have siblings.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-each_recursive" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_recursive</span><span
class="method-args">() { |node| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Visit all subnodes of <code>self</code> recursively</p>
<div class="method-source-code" id="each_recursive-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_recursive</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment"># :yields: node</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">node</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">each_recursive</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-find_first_recursive" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_first_recursive</span><span
class="method-args">() { |node| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Find.html"><code>Find</code></a> (and return) first subnode (recursively) for which the block evaluates to true. Returns <code>nil</code> if none was found.</p>
<div class="method-source-code" id="find_first_recursive-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_first_recursive</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment"># :yields: node</span>
<span class="ruby-identifier">each_recursive</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">node</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">node</span>)
}
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-indent" class="method-detail ">
<div class="method-heading">
<span class="method-name">indent</span><span
class="method-args">(to, ind)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="indent-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">indent</span> <span class="ruby-identifier">to</span>, <span class="ruby-identifier">ind</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">context</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">context</span>[<span class="ruby-value">:indentstyle</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
<span class="ruby-identifier">indentstyle</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">context</span>[<span class="ruby-value">:indentstyle</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">indentstyle</span> = <span class="ruby-string">' '</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">to</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">indentstyle</span><span class="ruby-operator">*</span><span class="ruby-identifier">ind</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ind</span><span class="ruby-operator"><</span><span class="ruby-value">1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-index_in_parent" class="method-detail ">
<div class="method-heading">
<span class="method-name">index_in_parent</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the position that <code>self</code> holds in its parent's array, indexed from 1.</p>
<div class="method-source-code" id="index_in_parent-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index_in_parent</span>
<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">index</span>(<span class="ruby-keyword">self</span>)<span class="ruby-value">+1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-next_sibling_node" class="method-detail ">
<div class="method-heading">
<span class="method-name">next_sibling_node</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return the next sibling (nil if unset)</p>
<div class="method-source-code" id="next_sibling_node-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 11</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">next_sibling_node</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@parent</span>[ <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">index</span>(<span class="ruby-keyword">self</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span> ]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parent-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">parent?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parent-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parent?</span>
<span class="ruby-keyword">false</span>;
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-previous_sibling_node" class="method-detail ">
<div class="method-heading">
<span class="method-name">previous_sibling_node</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@return the previous sibling (nil if unset)</p>
<div class="method-source-code" id="previous_sibling_node-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">previous_sibling_node</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">ind</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">index</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ind</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@parent</span>[ <span class="ruby-identifier">ind</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> ]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">(indent=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<dl class="rdoc-list note-list"><dt>indent
<dd>
<p><strong>DEPRECATED</strong> This parameter is now ignored. See the formatters in the <a href="Formatters.html"><code>REXML::Formatters</code></a> package for changing the output style.</p>
</dd></dl>
<div class="method-source-code" id="to_s-source">
<pre><span class="ruby-comment"># File lib/rexml/node.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span> <span class="ruby-identifier">indent</span>=<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">indent</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-constant">Kernel</span>.<span class="ruby-identifier">warn</span>( <span class="ruby-node">"#{self.class.name}.to_s(indent) parameter is deprecated"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>)
<span class="ruby-identifier">f</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatters</span><span class="ruby-operator">::</span><span class="ruby-constant">Pretty</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">indent</span> )
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>( <span class="ruby-keyword">self</span>, <span class="ruby-identifier">rv</span> = <span class="ruby-string">""</span> )
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">f</span> = <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatters</span><span class="ruby-operator">::</span><span class="ruby-constant">Default</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>( <span class="ruby-keyword">self</span>, <span class="ruby-identifier">rv</span> = <span class="ruby-string">""</span> )
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>