<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class RubyXL::OOXMLTopLevelObject - rubyXL 3.3.19</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
<script src="../js/jquery.js"></script>
<script src="../js/darkfish.js"></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="OOXMLObject.html">RubyXL::OOXMLObject</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-parse_file">::parse_file</a>
<li ><a href="#method-c-set_namespaces">::set_namespaces</a>
<li ><a href="#method-i-add_to_zip">#add_to_zip</a>
<li ><a href="#method-i-file_index">#file_index</a>
<li ><a href="#method-i-xlsx_path">#xlsx_path</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-RubyXL::OOXMLTopLevelObject">
<h1 id="class-RubyXL::OOXMLTopLevelObject" class="class">
class RubyXL::OOXMLTopLevelObject
</h1>
<section class="description">
<p><a href="Extension.html">Extension</a> class providing functionality for
top-level OOXML objects that are represented by their own <code>.xml</code>
files in <code>.xslx</code> zip container.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ROOT">ROOT
<dd>
<dt id="SAVE_ORDER">SAVE_ORDER
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-root" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">root</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-parse_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_file</span><span
class="method-args">(zip_file, file_path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Generates the top-level OOXML object by parsing its XML file from the
contents of the <code>.xslx</code> container.</p>
<h3 id="method-c-parse_file-label-Parameters">Parameters<span><a href="#method-c-parse_file-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><code>zip_file</code> - <code>.xslx</code> file as <code>Zip::File</code>
object</p>
</li><li>
<p><code>file_path</code> - path to the subject file inside the
<code>.xslx</code> zip archive</p>
</li></ul>
<div class="method-source-code" id="parse_file-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 437</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">parse_file</span>(<span class="ruby-identifier">zip_file</span>, <span class="ruby-identifier">file_path</span>)
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">zip_file</span>.<span class="ruby-identifier">find_entry</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-identifier">from_root</span>(<span class="ruby-identifier">file_path</span>))
<span class="ruby-comment"># Accomodate for Nokogiri Java implementation which is incapable of reading from a stream</span>
<span class="ruby-identifier">entry</span> <span class="ruby-operator">&&</span> (<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">get_input_stream</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">parse</span>(<span class="ruby-keyword">defined?</span>(<span class="ruby-constant">JRUBY_VERSION</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">read</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">f</span>) })
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-set_namespaces" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_namespaces</span><span
class="method-args">(namespace_hash)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the list of namespaces on this object to be added when writing out
XML. Valid only on top-level objects.</p>
<h3 id="method-c-set_namespaces-label-Parameters">Parameters<span><a href="#method-c-set_namespaces-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><code>namespace_hash</code> - Hash of namespaces in the form of
<code>"url" => "prefix"</code></p>
</li></ul>
<h4 id="method-c-set_namespaces-label-Examples">Examples<span><a href="#method-c-set_namespaces-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
<pre class="ruby"><span class="ruby-identifier">set_namespaces</span>(<span class="ruby-string">'http://schemas.openxmlformats.org/spreadsheetml/2006/main'</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>,
<span class="ruby-string">'http://schemas.openxmlformats.org/officeDocument/2006/relationships'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'r'</span>)
</pre>
<div class="method-source-code" id="set_namespaces-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 429</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">set_namespaces</span>(<span class="ruby-identifier">namespace_hash</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_namespaces</span>, <span class="ruby-identifier">namespace_hash</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-add_to_zip" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_to_zip</span><span
class="method-args">(zip_stream)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Saves the contents of the object as XML to respective location in
<code>.xslx</code> zip container.</p>
<h3 id="method-i-add_to_zip-label-Parameters">Parameters<span><a href="#method-i-add_to_zip-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
<ul><li>
<p><code>zipfile</code> - ::Zip::File to which the resulting XNMML should be
added.</p>
</li></ul>
<div class="method-source-code" id="add_to_zip-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 446</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_to_zip</span>(<span class="ruby-identifier">zip_stream</span>)
<span class="ruby-identifier">xml_string</span> = <span class="ruby-identifier">write_xml</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xml_string</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">zip_stream</span>.<span class="ruby-identifier">put_next_entry</span>(<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-identifier">from_root</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">xlsx_path</span>))
<span class="ruby-identifier">zip_stream</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">xml_string</span>)
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-file_index" class="method-detail ">
<div class="method-heading">
<span class="method-name">file_index</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="file_index-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 454</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">file_index</span>
<span class="ruby-identifier">root</span>.<span class="ruby-identifier">rels_hash</span>[<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>].<span class="ruby-identifier">index</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-keyword">self</span>) }.<span class="ruby-identifier">to_i</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-xlsx_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">xlsx_path</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prototype method. For top-level OOXML object, returns the path at which the
current object's XML file is located within the <code>.xlsx</code> zip
container.</p>
<div class="method-source-code" id="xlsx_path-source">
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 419</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">xlsx_path</span>
<span class="ruby-identifier">raise</span> <span class="ruby-string">'Subclass responsebility'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>