<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RRTF::Document
— Documentation by YARD 0.9.9
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "RRTF::Document";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (D)</a> »
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
»
<span class="title">Document</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: RRTF::Document
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="ContainerNode.html" title="RRTF::ContainerNode (class)">ContainerNode</a></span></li>
<li class="next"><span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></li>
<li class="next">RRTF::Document</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rrtf/node/document.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This class represents an RTF document. In actuality it is just a
specialised Node type that cannot be assigned a parent and that holds
document font, colour and information tables.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'>
<p>Peter Wood</p>
</div>
</li>
<li>
<div class='inline'>
<p>Wesley Hileman</p>
</div>
</li>
</ul>
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="CS_DICTIONARY-constant" class="">CS_DICTIONARY =
<div class="docstring">
<div class="discussion">
<p>A hash mapping character set string constants to their RTF counterparts.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash<String, Symbol></tt>)</span>
—
<div class='inline'>
<p>the RTF character set dictionary.</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ANSI</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:ansi</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>MAC</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:mac</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PC</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:pc</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PCA</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='symbol'>:pca</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="LS_DICTIONARY-constant" class="">LS_DICTIONARY =
<div class="docstring">
<div class="discussion">
<p>A hash mapping langauge set string constants to their RTF counterparts.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash<String, Integer></tt>)</span>
—
<div class='inline'>
<p>the RTF langauge setting dictionary.</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>AFRIKAANS</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1078</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ARABIC</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1025</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CATALAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1027</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CHINESE_TRADITIONAL</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1028</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CHINESE_SIMPLIFIED</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2052</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>CZECH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1029</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DANISH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1030</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DUTCH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1043</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DUTCH_BELGIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2067</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ENGLISH_UK</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2057</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ENGLISH_US</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1033</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FINNISH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1035</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FRENCH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1036</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FRENCH_BELGIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2060</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FRENCH_CANADIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>3084</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FRENCH_SWISS</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>4108</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>GERMAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1031</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>GERMAN_SWISS</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2055</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>GREEK</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1032</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>HEBREW</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1037</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>HUNGARIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1038</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ICELANDIC</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1039</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>INDONESIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1057</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ITALIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1040</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>JAPANESE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1041</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>KOREAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1042</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>NORWEGIAN_BOKMAL</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1044</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>NORWEGIAN_NYNORSK</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2068</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>POLISH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1045</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PORTUGUESE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2070</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>POTUGUESE_BRAZILIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1046</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ROMANIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1048</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>RUSSIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1049</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SERBO_CROATIAN_CYRILLIC</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2074</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SERBO_CROATIAN_LATIN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1050</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SLOVAK</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1051</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SPANISH_CASTILLIAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1034</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SPANISH_MEXICAN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>2058</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SWAHILI</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1089</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SWEDISH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1053</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>THAI</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1054</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TURKISH</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1055</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>UNKNOWN</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1024</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>VIETNAMESE</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='int'>1066</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#character_set-instance_method" title="#character_set (instance method)">#<strong>character_set</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#colours-instance_method" title="#colours (instance method)">#<strong>colours</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fonts-instance_method" title="#fonts (instance method)">#<strong>fonts</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#information-instance_method" title="#information (instance method)">#<strong>information</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#language-instance_method" title="#language (instance method)">#<strong>language</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lists-instance_method" title="#lists (instance method)">#<strong>lists</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stylesheet-instance_method" title="#stylesheet (instance method)">#<strong>stylesheet</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CommandNode.html#prefix-instance_method" title="RRTF::CommandNode#prefix (method)">#prefix</a></span>, <span class='object_link'><a href="CommandNode.html#split-instance_method" title="RRTF::CommandNode#split (method)">#split</a></span>, <span class='object_link'><a href="CommandNode.html#suffix-instance_method" title="RRTF::CommandNode#suffix (method)">#suffix</a></span>, <span class='object_link'><a href="CommandNode.html#wrap-instance_method" title="RRTF::CommandNode#wrap (method)">#wrap</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="ContainerNode.html" title="RRTF::ContainerNode (class)">ContainerNode</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ContainerNode.html#children-instance_method" title="RRTF::ContainerNode#children (method)">#children</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#parent-instance_method" title="RRTF::Node#parent (method)">#parent</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#body_height-instance_method" title="#body_height (instance method)">#<strong>body_height</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches the height of the available work area space for a a
typical Document object page.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#body_width-instance_method" title="#body_width (instance method)">#<strong>body_width</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches the width of the available work area space for a
typical Document object page.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_font-instance_method" title="#default_font (instance method)">#<strong>default_font</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute accessor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_font=-instance_method" title="#default_font= (instance method)">#<strong>default_font=</strong>(font) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Attribute mutator.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#footer-instance_method" title="#footer (instance method)">#<strong>footer</strong>(type = FooterNode::UNIVERSAL) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches a footer from a Document object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#footer=-instance_method" title="#footer= (instance method)">#<strong>footer=</strong>(footer) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method assigns a new footer to a document.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_id-instance_method" title="#get_id (instance method)">#<strong>get_id</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method provides a method that can be called to generate an identifier
that is unique within the document.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#header-instance_method" title="#header (instance method)">#<strong>header</strong>(type = HeaderNode::UNIVERSAL) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method fetches a header from a Document object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#header=-instance_method" title="#header= (instance method)">#<strong>header=</strong>(header) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method assigns a new header to a document.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {}) ⇒ Document </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Represents an entire RTF document.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#load_stylesheet-instance_method" title="#load_stylesheet (instance method)">#<strong>load_stylesheet</strong>(hashmap_array) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Loads a stylesheet for the document from an array of hashmaps representing
styles.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#page_break-instance_method" title="#page_break (instance method)">#<strong>page_break</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method inserts a page break into a document.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#paper-instance_method" title="#paper (instance method)">#<strong>paper</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method provides a short cut for obtaining the Paper object associated
with a Document object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parent=-instance_method" title="#parent= (instance method)">#<strong>parent=</strong>(parent) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method overrides the parent=() method inherited from the CommandNode
class to disallow setting a parent on a Document object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>This method generates the RTF text for a Document object.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></h3>
<p class="inherited"><span class='object_link'><a href="CommandNode.html#<<-instance_method" title="RRTF::CommandNode#<< (method)">#<<</a></span>, <span class='object_link'><a href="CommandNode.html#apply-instance_method" title="RRTF::CommandNode#apply (method)">#apply</a></span>, <span class='object_link'><a href="CommandNode.html#footnote-instance_method" title="RRTF::CommandNode#footnote (method)">#footnote</a></span>, <span class='object_link'><a href="CommandNode.html#geometry-instance_method" title="RRTF::CommandNode#geometry (method)">#geometry</a></span>, <span class='object_link'><a href="CommandNode.html#image-instance_method" title="RRTF::CommandNode#image (method)">#image</a></span>, <span class='object_link'><a href="CommandNode.html#line_break-instance_method" title="RRTF::CommandNode#line_break (method)">#line_break</a></span>, <span class='object_link'><a href="CommandNode.html#link-instance_method" title="RRTF::CommandNode#link (method)">#link</a></span>, <span class='object_link'><a href="CommandNode.html#list-instance_method" title="RRTF::CommandNode#list (method)">#list</a></span>, <span class='object_link'><a href="CommandNode.html#paragraph-instance_method" title="RRTF::CommandNode#paragraph (method)">#paragraph</a></span>, <span class='object_link'><a href="CommandNode.html#table-instance_method" title="RRTF::CommandNode#table (method)">#table</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ContainerNode.html" title="RRTF::ContainerNode (class)">ContainerNode</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ContainerNode.html#[]-instance_method" title="RRTF::ContainerNode#[] (method)">#[]</a></span>, <span class='object_link'><a href="ContainerNode.html#each-instance_method" title="RRTF::ContainerNode#each (method)">#each</a></span>, <span class='object_link'><a href="ContainerNode.html#first-instance_method" title="RRTF::ContainerNode#first (method)">#first</a></span>, <span class='object_link'><a href="ContainerNode.html#last-instance_method" title="RRTF::ContainerNode#last (method)">#last</a></span>, <span class='object_link'><a href="ContainerNode.html#size-instance_method" title="RRTF::ContainerNode#size (method)">#size</a></span>, <span class='object_link'><a href="ContainerNode.html#store-instance_method" title="RRTF::ContainerNode#store (method)">#store</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="RRTF::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#is_root%3F-instance_method" title="RRTF::Node#is_root? (method)">#is_root?</a></span>, <span class='object_link'><a href="Node.html#next_node-instance_method" title="RRTF::Node#next_node (method)">#next_node</a></span>, <span class='object_link'><a href="Node.html#previous_node-instance_method" title="RRTF::Node#previous_node (method)">#previous_node</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="RRTF::Node#root (method)">#root</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(options = {}) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Document (class)">Document</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'>
<p>The “suppress_system_styles” option is ignored by most RTF platforms
including Word and LibreOffice.</p>
</div>
</div>
<p>Represents an entire RTF document.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash<String, Object></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>the options to use in creating the document.</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">"default_font"</span>
<span class="type">(<tt>String</tt>, <tt><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></tt>)</span>
<span class="default">
— default:
<tt>"SWISS:Helvetica"</tt>
</span>
— <div class='inline'>
<p>a font object OR string encapsulating the default font to be used by the
document (see <span class='object_link'><a href="Font.html#from_string-class_method" title="RRTF::Font.from_string (method)">Font.from_string</a></span> for string format).</p>
</div>
</li>
<li>
<span class="name">"character_set"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>"ANSI"</tt>
</span>
— <div class='inline'>
<p>the character set to be applied to the document (see <span class='object_link'><a href="#CS_DICTIONARY-constant" title="RRTF::Document::CS_DICTIONARY (constant)">CS_DICTIONARY</a></span> for
valid values).</p>
</div>
</li>
<li>
<span class="name">"language"</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
— default:
<tt>"ENGLISH_US"</tt>
</span>
— <div class='inline'>
<p>the language setting to be applied to the document (see <span class='object_link'><a href="#LS_DICTIONARY-constant" title="RRTF::Document::LS_DICTIONARY (constant)">LS_DICTIONARY</a></span> for
valid values).</p>
</div>
</li>
<li>
<span class="name">"suppress_system_styles"</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
— default:
<tt>false</tt>
</span>
— <div class='inline'>
<p>whether or not to suppress styles provided in the host platform (adds the
noqfpromote control word before stylesheet definition).</p>
</div>
</li>
<li>
<span class="name">"document_properties"</span>
<span class="type">(<tt><span class='object_link'><a href="DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span></tt>)</span>
<span class="default">
— default:
<tt>DocumentProperties.new</tt>
</span>
— <div class='inline'>
<p>a DocumentProperties object OR options hash encapsulating the properties to
be applied to the document.</p>
</div>
</li>
<li>
<span class="name">"stylesheet"</span>
<span class="type">(<tt>Array</tt>, <tt>Hash</tt>, <tt><span class='object_link'><a href="Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span></tt>)</span>
<span class="default">
— default:
<tt>nil</tt>
</span>
— <div class='inline'>
<p>a Stylesheet object OR array of style hashes OR hash of stylesheet options
with which to use as or construct the stylesheet for the document.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="DocumentProperties.html#initialize-instance_method" title="RRTF::DocumentProperties#initialize (method)">DocumentProperties#initialize for available document properties.</a></span></li>
<li><span class='object_link'><a href="Stylesheet.html#add_style-instance_method" title="RRTF::Stylesheet#add_style (method)">Stylesheet#initialize for available stylesheet options.</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='comment'># load default options
</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default_font</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>SWISS:Helvetica</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>document_properties</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DocumentProperties.html#initialize-instance_method" title="RRTF::DocumentProperties#initialize (method)">new</a></span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>character_set</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ANSI</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>language</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ENGLISH_US</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>suppress_system_styles</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheet</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\rtf1</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='comment'># parse font
</span> <span class='id identifier rubyid_font'>font</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>default_font</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_font'>font</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></span>
<span class='kw'>when</span> <span class='const'>String</span>
<span class='id identifier rubyid_font'>font</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Font.html" title="RRTF::Font (class)">Font</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_string'><span class='object_link'><a href="Font.html#from_string-class_method" title="RRTF::Font.from_string (method)">from_string</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_font'>font</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unreconized font format </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_font'>font</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># case
</span>
<span class='comment'># parse document properties
</span> <span class='id identifier rubyid_properties'>properties</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>document_properties</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span></span>
<span class='kw'>when</span> <span class='const'>Hash</span>
<span class='id identifier rubyid_properties'>properties</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="DocumentProperties.html" title="RRTF::DocumentProperties (class)">DocumentProperties</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DocumentProperties.html#initialize-instance_method" title="RRTF::DocumentProperties#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_properties'>properties</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unreconized document style format </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_font'>font</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># case
</span>
<span class='comment'># parse character set
</span> <span class='id identifier rubyid_cs_string'>cs_string</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>character_set</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_cs_val'>cs_val</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#CS_DICTIONARY-constant" title="RRTF::Document::CS_DICTIONARY (constant)">CS_DICTIONARY</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_cs_string'>cs_string</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_cs_val'>cs_val</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unreconized character set '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cs_string'>cs_string</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># if
</span>
<span class='comment'># parse language setting
</span> <span class='id identifier rubyid_ls_string'>ls_string</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>language</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_ls_val'>ls_val</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#LS_DICTIONARY-constant" title="RRTF::Document::LS_DICTIONARY (constant)">LS_DICTIONARY</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_ls_string'>ls_string</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ls_val'>ls_val</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unreconized language '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ls_string'>ls_string</span><span class='embexpr_end'>}</span><span class='tstring_content'>'.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='comment'># if
</span>
<span class='ivar'>@fonts</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="FontTable.html" title="RRTF::FontTable (class)">FontTable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="FontTable.html#initialize-instance_method" title="RRTF::FontTable#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_font'>font</span><span class='rparen'>)</span>
<span class='ivar'>@lists</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ListTable.html" title="RRTF::ListTable (class)">ListTable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ListTable.html#initialize-instance_method" title="RRTF::ListTable#initialize (method)">new</a></span></span>
<span class='ivar'>@default_font</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='ivar'>@colours</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ColourTable.html" title="RRTF::ColourTable (class)">ColourTable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ColourTable.html#initialize-instance_method" title="RRTF::ColourTable#initialize (method)">new</a></span></span>
<span class='ivar'>@information</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Information.html" title="RRTF::Information (class)">Information</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Information.html#initialize-instance_method" title="RRTF::Information#initialize (method)">new</a></span></span>
<span class='ivar'>@character_set</span> <span class='op'>=</span> <span class='id identifier rubyid_cs_val'>cs_val</span>
<span class='ivar'>@language</span> <span class='op'>=</span> <span class='id identifier rubyid_ls_val'>ls_val</span>
<span class='ivar'>@properties</span> <span class='op'>=</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='ivar'>@headers</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
<span class='ivar'>@footers</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rbracket'>]</span>
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='comment'># parse stylesheet (must be done after font and colour tables are
</span> <span class='comment'># initialized since declared styles may push fonts/colours onto the
</span> <span class='comment'># tables)
</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>stylesheet</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span>
<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span></span>
<span class='id identifier rubyid_stylesheet'>stylesheet</span><span class='period'>.</span><span class='id identifier rubyid_document'>document</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='kw'>when</span> <span class='const'>Array</span>
<span class='id identifier rubyid_stylesheet'>stylesheet</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Stylesheet.html#initialize-instance_method" title="RRTF::Stylesheet#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>styles</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_stylesheet'>stylesheet</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='const'>Hash</span>
<span class='id identifier rubyid_stylesheet'>stylesheet</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Stylesheet.html#initialize-instance_method" title="RRTF::Stylesheet#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unreconized stylesheet format </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_font'>font</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span> <span class='kw'>unless</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='comment'># case
</span>
<span class='ivar'>@stylesheet</span> <span class='op'>=</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span>
<span class='comment'># additional options
</span> <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="character_set=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="character_set-instance_method">
#<strong>character_set</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_character_set'>character_set</span>
<span class='ivar'>@character_set</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="colours-instance_method">
#<strong>colours</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_colours'>colours</span>
<span class='ivar'>@colours</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="fonts-instance_method">
#<strong>fonts</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fonts'>fonts</span>
<span class='ivar'>@fonts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="information-instance_method">
#<strong>information</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_information'>information</span>
<span class='ivar'>@information</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="language=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="language-instance_method">
#<strong>language</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_language'>language</span>
<span class='ivar'>@language</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="lists-instance_method">
#<strong>lists</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lists'>lists</span>
<span class='ivar'>@lists</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="properties-instance_method">
#<strong>properties</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='ivar'>@properties</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="stylesheet=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="stylesheet-instance_method">
#<strong>stylesheet</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stylesheet'>stylesheet</span>
<span class='ivar'>@stylesheet</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="body_height-instance_method">
#<strong>body_height</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches the height of the available work area space for a a
typical Document object page.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
298
299
300</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 298</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body_height'>body_height</span>
<span class='ivar'>@style</span><span class='period'>.</span><span class='id identifier rubyid_body_height'>body_height</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="body_width-instance_method">
#<strong>body_width</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches the width of the available work area space for a
typical Document object page.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
292
293
294</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 292</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body_width'>body_width</span>
<span class='ivar'>@style</span><span class='period'>.</span><span class='id identifier rubyid_body_width'>body_width</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default_font-instance_method">
#<strong>default_font</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute accessor.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
173
174
175</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 173</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_font'>default_font</span>
<span class='ivar'>@fonts</span><span class='lbracket'>[</span><span class='ivar'>@default_font</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default_font=-instance_method">
#<strong>default_font=</strong>(font) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Attribute mutator.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>font
<dd>
<p>The new default font for the Document object.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
261
262
263
264</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 261</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_font='>default_font=</span><span class='lparen'>(</span><span class='id identifier rubyid_font'>font</span><span class='rparen'>)</span>
<span class='ivar'>@fonts</span> <span class='op'><<</span> <span class='id identifier rubyid_font'>font</span>
<span class='ivar'>@default_font</span> <span class='op'>=</span> <span class='ivar'>@fonts</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_font'>font</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="footer-instance_method">
#<strong>footer</strong>(type = FooterNode::UNIVERSAL) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches a footer from a Document object.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>type
<dd>
<p>One of the footer types defined in the footer class. Defaults to
FooterNode::UNIVERSAL.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
239
240
241
242
243
244
245
246
247
248
249</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 239</span>
<span class='kw'>def</span> <span class='id identifier rubyid_footer'>footer</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='op'>=</span><span class='const'>FooterNode</span><span class='op'>::</span><span class='const'>UNIVERSAL</span><span class='rparen'>)</span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#LEFT_PAGE-constant" title="RRTF::FooterNode::LEFT_PAGE (constant)">LEFT_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>1</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#RIGHT_PAGE-constant" title="RRTF::FooterNode::RIGHT_PAGE (constant)">RIGHT_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>2</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#FIRST_PAGE-constant" title="RRTF::FooterNode::FIRST_PAGE (constant)">FIRST_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>3</span>
<span class='kw'>end</span>
<span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="footer=-instance_method">
#<strong>footer=</strong>(footer) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method assigns a new footer to a document. A Document object can have
up to four footers - a default footer, a footer for left pages, a footer
for right pages and a footer for the first page. The method checks the
footer type and stores it appropriately.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>footer
<dd>
<p>A reference to the footer object to be stored. Existing footer objects are
overwritten.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
205
206
207
208
209
210
211
212
213
214
215</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 205</span>
<span class='kw'>def</span> <span class='id identifier rubyid_footer='>footer=</span><span class='lparen'>(</span><span class='id identifier rubyid_footer'>footer</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_footer'>footer</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#UNIVERSAL-constant" title="RRTF::FooterNode::UNIVERSAL (constant)">UNIVERSAL</a></span></span>
<span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_footer'>footer</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_footer'>footer</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#LEFT_PAGE-constant" title="RRTF::FooterNode::LEFT_PAGE (constant)">LEFT_PAGE</a></span></span>
<span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_footer'>footer</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_footer'>footer</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#RIGHT_PAGE-constant" title="RRTF::FooterNode::RIGHT_PAGE (constant)">RIGHT_PAGE</a></span></span>
<span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_footer'>footer</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_footer'>footer</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="FooterNode.html" title="RRTF::FooterNode (class)">FooterNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FooterNode.html#FIRST_PAGE-constant" title="RRTF::FooterNode::FIRST_PAGE (constant)">FIRST_PAGE</a></span></span>
<span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_footer'>footer</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_id-instance_method">
#<strong>get_id</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method provides a method that can be called to generate an identifier
that is unique within the document.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
167
168
169
170</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 167</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_id'>get_id</span>
<span class='ivar'>@id</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%d%m%y</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>+</span> <span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="header-instance_method">
#<strong>header</strong>(type = HeaderNode::UNIVERSAL) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method fetches a header from a Document object.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>type
<dd>
<p>One of the header types defined in the header class. Defaults to
HeaderNode::UNIVERSAL.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
222
223
224
225
226
227
228
229
230
231
232</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 222</span>
<span class='kw'>def</span> <span class='id identifier rubyid_header'>header</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='op'>=</span><span class='const'>HeaderNode</span><span class='op'>::</span><span class='const'>UNIVERSAL</span><span class='rparen'>)</span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#LEFT_PAGE-constant" title="RRTF::HeaderNode::LEFT_PAGE (constant)">LEFT_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>1</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#RIGHT_PAGE-constant" title="RRTF::HeaderNode::RIGHT_PAGE (constant)">RIGHT_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>2</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#FIRST_PAGE-constant" title="RRTF::HeaderNode::FIRST_PAGE (constant)">FIRST_PAGE</a></span></span>
<span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='int'>3</span>
<span class='kw'>end</span>
<span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="header=-instance_method">
#<strong>header=</strong>(header) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method assigns a new header to a document. A Document object can have
up to four header - a default header, a header for left pages, a header for
right pages and a header for the first page. The method checks the header
type and stores it appropriately.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>header
<dd>
<p>A reference to the header object to be stored. Existing header objects are
overwritten.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
185
186
187
188
189
190
191
192
193
194
195</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 185</span>
<span class='kw'>def</span> <span class='id identifier rubyid_header='>header=</span><span class='lparen'>(</span><span class='id identifier rubyid_header'>header</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#UNIVERSAL-constant" title="RRTF::HeaderNode::UNIVERSAL (constant)">UNIVERSAL</a></span></span>
<span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_header'>header</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#LEFT_PAGE-constant" title="RRTF::HeaderNode::LEFT_PAGE (constant)">LEFT_PAGE</a></span></span>
<span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_header'>header</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#RIGHT_PAGE-constant" title="RRTF::HeaderNode::RIGHT_PAGE (constant)">RIGHT_PAGE</a></span></span>
<span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_header'>header</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="HeaderNode.html" title="RRTF::HeaderNode (class)">HeaderNode</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderNode.html#FIRST_PAGE-constant" title="RRTF::HeaderNode::FIRST_PAGE (constant)">FIRST_PAGE</a></span></span>
<span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_header'>header</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="load_stylesheet-instance_method">
#<strong>load_stylesheet</strong>(hashmap_array) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Loads a stylesheet for the document from an array of hashmaps representing
styles</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
253
254
255</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 253</span>
<span class='kw'>def</span> <span class='id identifier rubyid_load_stylesheet'>load_stylesheet</span><span class='lparen'>(</span><span class='id identifier rubyid_hashmap_array'>hashmap_array</span><span class='rparen'>)</span>
<span class='ivar'>@stylesheet</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Stylesheet.html" title="RRTF::Stylesheet (class)">Stylesheet</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Stylesheet.html#initialize-instance_method" title="RRTF::Stylesheet#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_hashmap_array'>hashmap_array</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="page_break-instance_method">
#<strong>page_break</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method inserts a page break into a document.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
285
286
287
288</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 285</span>
<span class='kw'>def</span> <span class='id identifier rubyid_page_break'>page_break</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="CommandNode.html" title="RRTF::CommandNode (class)">CommandNode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="CommandNode.html#initialize-instance_method" title="RRTF::CommandNode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>\page</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="paper-instance_method">
#<strong>paper</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method provides a short cut for obtaining the Paper object associated
with a Document object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
268
269
270</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 268</span>
<span class='kw'>def</span> <span class='id identifier rubyid_paper'>paper</span>
<span class='ivar'>@style</span><span class='period'>.</span><span class='id identifier rubyid_paper'>paper</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parent=-instance_method">
#<strong>parent=</strong>(parent) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method overrides the parent=() method inherited from the CommandNode
class to disallow setting a parent on a Document object.</p>
<h4 id="label-Parameters">Parameters</h4>
<dl class="rdoc-list note-list"><dt>parent
<dd>
<p>A reference to the new parent node for the Document object.</p>
</dd></dl>
<h4 id="label-Exceptions">Exceptions</h4>
<dl class="rdoc-list note-list"><dt>RTFError
<dd>
<p>Generated whenever this method is called.</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
280
281
282</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 280</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parent='>parent=</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="RTFError.html" title="RRTF::RTFError (class)">RTFError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fire'><span class='object_link'><a href="RTFError.html#fire-class_method" title="RRTF::RTFError.fire (method)">fire</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Document objects may not have a parent.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_rtf-instance_method">
#<strong>to_rtf</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>This method generates the RTF text for a Document object.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rrtf/node/document.rb', line 303</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>{</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\</span><span class='embexpr_beg'>#{</span><span class='ivar'>@character_set</span><span class='period'>.</span><span class='id identifier rubyid_id2name'>id2name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\deff</span><span class='embexpr_beg'>#{</span><span class='ivar'>@default_font</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\deflang</span><span class='embexpr_beg'>#{</span><span class='ivar'>@language</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@language</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\plain\\fs24\\fet1</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@fonts</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@colours</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@colours</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n\\noqfpromote</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>suppress_system_styles</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@stylesheet</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@stylesheet</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@information</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@lists</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>if</span> <span class='ivar'>@headers</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span> <span class='op'>!=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@headers</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@footers</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span> <span class='op'>!=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@footers</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@properties</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@properties</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span> <span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span>
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n}</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jul 31 21:48:59 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.3.3).
</div>
</div>
</body>
</html>