File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Formatters/Default.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Formatters::Default - 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="../../Object.html">Object</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">#write</a>
<li ><a href="#method-i-write_cdata">#write_cdata</a>
<li ><a href="#method-i-write_comment">#write_comment</a>
<li ><a href="#method-i-write_document">#write_document</a>
<li ><a href="#method-i-write_element">#write_element</a>
<li ><a href="#method-i-write_instruction">#write_instruction</a>
<li ><a href="#method-i-write_text">#write_text</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Formatters::Default">
<h1 id="class-REXML::Formatters::Default" class="class">
class REXML::Formatters::Default
</h1>
<section class="description">
</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">( ie_hack=false )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prints out the <a href="../../XML.html"><code>XML</code></a> document with no formatting – except if ie_hack is set.</p>
<dl class="rdoc-list note-list"><dt>ie_hack
<dd>
<p>If set to true, then inserts whitespace before the close of an empty tag, so that IE's bad <a href="../../XML.html"><code>XML</code></a> parser doesn't choke.</p>
</dd></dl>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 12</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-identifier">ie_hack</span>=<span class="ruby-keyword">false</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="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">( node, output )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes the node to some output.</p>
<dl class="rdoc-list note-list"><dt>node
<dd>
<p>The node to write</p>
</dd><dt>output
<dd>
<p>A class implementing <code>&lt;&lt;</code>. Pass in an <a href="../Output.html"><code>Output</code></a> object to change the output encoding.</p>
</dd></dl>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">case</span> <span class="ruby-identifier">node</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Document</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">xml_decl</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-string">'UTF-8'</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">output</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Output</span>)
<span class="ruby-identifier">output</span> = <span class="ruby-constant">Output</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">output</span>, <span class="ruby-identifier">node</span>.<span class="ruby-identifier">xml_decl</span>.<span class="ruby-identifier">encoding</span> )
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">write_document</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">Element</span>
<span class="ruby-identifier">write_element</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">Declaration</span>, <span class="ruby-constant">ElementDecl</span>, <span class="ruby-constant">NotationDecl</span>, <span class="ruby-constant">ExternalEntity</span>, <span class="ruby-constant">Entity</span>,
<span class="ruby-constant">Attribute</span>, <span class="ruby-constant">AttlistDecl</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">write</span>( <span class="ruby-identifier">output</span>,<span class="ruby-value">-1</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">Instruction</span>
<span class="ruby-identifier">write_instruction</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">DocType</span>, <span class="ruby-constant">XMLDecl</span>
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">write</span>( <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">Comment</span>
<span class="ruby-identifier">write_comment</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">CData</span>
<span class="ruby-identifier">write_cdata</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">when</span> <span class="ruby-constant">Text</span>
<span class="ruby-identifier">write_text</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</span> )
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"XML FORMATTING ERROR"</span>)
<span class="ruby-keyword">end</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_cdata" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_cdata</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_cdata-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_cdata</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-constant">CData</span><span class="ruby-operator">::</span><span class="ruby-constant">START</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-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">CData</span><span class="ruby-operator">::</span><span class="ruby-constant">STOP</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_comment" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_comment</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_comment-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_comment</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-constant">Comment</span><span class="ruby-operator">::</span><span class="ruby-constant">START</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-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Comment</span><span class="ruby-operator">::</span><span class="ruby-constant">STOP</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_document" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_document</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_document-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_document</span>( <span class="ruby-identifier">node</span>, <span class="ruby-identifier">output</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-keyword">end</span></pre>
</div>
</div>
</div>
<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/default.rb, line 65</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">to_a</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
<span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">a</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">values</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">a</span>
}.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">sort_by</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">attr</span><span class="ruby-operator">|</span> <span class="ruby-identifier">attr</span>.<span class="ruby-identifier">name</span>}.<span class="ruby-identifier">each</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-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-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-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"</#{node.expanded_name}"</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_instruction" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_instruction</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_instruction-source">
<pre><span class="ruby-comment"># File lib/rexml/formatters/default.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_instruction</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-constant">Instruction</span><span class="ruby-operator">::</span><span class="ruby-constant">START</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">target</span>
<span class="ruby-identifier">content</span> = <span class="ruby-identifier">node</span>.<span class="ruby-identifier">content</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">content</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">' '</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">content</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Instruction</span><span class="ruby-operator">::</span><span class="ruby-constant">STOP</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/default.rb, line 88</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>