File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Formatters/Transitive.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Formatters::Transitive - 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Default.html">REXML::Formatters::Default</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-write_element">#write_element</a>
<li ><a href="#method-i-write_text">#write_text</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Formatters::Transitive">
<h1 id="class-REXML::Formatters::Transitive" class="class">
class REXML::Formatters::Transitive
</h1>
<section class="description">
<p>The <a href="Transitive.html"><code>Transitive</code></a> formatter writes an <a href="../../XML.html"><code>XML</code></a> document that parses to an identical document as the source document. This means that no extra whitespace nodes are inserted, and whitespace within text nodes is preserved. Within these constraints, the document is pretty-printed, with whitespace inserted into the metadata to introduce formatting.</p>
<p>Note that this is only useful if the original <a href="../../XML.html"><code>XML</code></a> is not already formatted. Since this formatter does not alter whitespace nodes, the results of formatting already formatted <a href="../../XML.html"><code>XML</code></a> will be odd.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">( indentation=2, ie_hack=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/transitive.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">indentation</span>=<span class="ruby-value">2</span>, <span class="ruby-identifier">ie_hack</span>=<span class="ruby-keyword">false</span> )
<span class="ruby-ivar">@indentation</span> = <span class="ruby-identifier">indentation</span>
<span class="ruby-ivar">@level</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@ie_hack</span> = <span class="ruby-identifier">ie_hack</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-write_element" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_element</span><span
class="method-args">( node, output )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_element-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/transitive.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_element</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<#{node.expanded_name}"</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each_attribute</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span>
<span class="ruby-identifier">attr</span>.<span class="ruby-identifier">write</span>( <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span><span class="ruby-operator">*</span><span class="ruby-ivar">@level</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" "</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@ie_hack</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"/"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">">"</span>
<span class="ruby-comment"># If compact and all children are text, and if the formatted output</span>
<span class="ruby-comment"># is less than the specified width, then try to print everything on</span>
<span class="ruby-comment"># one line</span>
<span class="ruby-ivar">@level</span> <span class="ruby-operator">+=</span> <span class="ruby-ivar">@indentation</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">write</span>( <span class="ruby-identifier">child</span>, <span class="ruby-identifier">output</span> )
}
<span class="ruby-ivar">@level</span> <span class="ruby-operator">-=</span> <span class="ruby-ivar">@indentation</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"</#{node.expanded_name}"</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span><span class="ruby-operator">*</span><span class="ruby-ivar">@level</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">">"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_text" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_text</span><span
class="method-args">( node, output )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="write_text-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/transitive.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_text</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">to_s</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>