documentation/RRTF/Style.html in rrtf-0.1.2 vs documentation/RRTF/Style.html in rrtf-1.0.0
- old
+ new
@@ -58,24 +58,26 @@
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: RRTF::Style
+ <span class="abstract note title">Abstract</span>
-
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
- <span class="inheritName">Object</span>
+ <span class="inheritName"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></span>
<ul class="fullTree">
<li>Object</li>
+ <li class="next"><span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></li>
+
<li class="next">RRTF::Style</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
@@ -99,22 +101,72 @@
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-
-<p>This is a parent class that all style classes will derive from.</p>
+ <div class="note abstract">
+ <strong>This class is abstract.</strong>
+ <div class='inline'></div>
+</div>
+<p>Represents an abstract style that can be applied to elements within a
+document AND appear in a document's stylesheet (i.e. paragraph,
+character, table, & section styles).</p>
+
</div>
</div>
<div class="tags">
+<p class="tag_title">Author:</p>
+<ul class="author">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>Wesley Hileman</p>
+</div>
+
+ </li>
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>Peter Wood</p>
+</div>
+
+ </li>
+
+</ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
- <p class="children"><span class='object_link'><a href="CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="DocumentStyle.html" title="RRTF::DocumentStyle (class)">DocumentStyle</a></span>, <span class='object_link'><a href="ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span></p>
+ <p class="children"><span class='object_link'><a href="CharacterStyle.html" title="RRTF::CharacterStyle (class)">CharacterStyle</a></span>, <span class='object_link'><a href="ParagraphStyle.html" title="RRTF::ParagraphStyle (class)">ParagraphStyle</a></span></p>
</div>
@@ -139,13 +191,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute additive.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -166,13 +216,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute auto_update.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -193,13 +241,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute based_on_style_handle.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -220,13 +266,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute handle.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -247,13 +291,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute hidden.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -274,13 +316,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute name.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -301,13 +341,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute next_style_handle.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -328,13 +366,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute primary.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
@@ -355,13 +391,11 @@
- <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute priority.</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
@@ -404,248 +438,45 @@
<li class="public ">
<span class="summary_signature">
- <a href="#is_character_style%3F-instance_method" title="#is_character_style? (instance method)">#<strong>is_character_style?</strong> ⇒ Boolean </a>
+ <a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(document) ⇒ Object </a>
</span>
+ <span class="abstract note title">abstract</span>
-
<span class="summary_desc"><div class='inline'>
-<p>Used to determine if the style applies to characters.</p>
+<p>Constructs the RTF formatting representing the style in a Stylesheet.</p>
</div></span>
</li>
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#is_document_style%3F-instance_method" title="#is_document_style? (instance method)">#<strong>is_document_style?</strong> ⇒ Boolean </a>
-
-
-
- </span>
+ </ul>
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Used to determine if the style applies to documents.</p>
-</div></span>
-
-</li>
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#is_paragraph_style%3F-instance_method" title="#is_paragraph_style? (instance method)">#<strong>is_paragraph_style?</strong> ⇒ Boolean </a>
-
-
-
- </span>
-
- <span class="summary_desc"><div class='inline'>
-<p>Used to determine if the style applies to paragraphs.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#is_table_style%3F-instance_method" title="#is_table_style? (instance method)">#<strong>is_table_style?</strong> ⇒ Boolean </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Used to determine if the style applies to tables.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#prefix-instance_method" title="#prefix (instance method)">#<strong>prefix</strong>(document) ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>This method retrieves the command prefix text associated with a Style
-object.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#rtf_formatting-instance_method" title="#rtf_formatting (instance method)">#<strong>rtf_formatting</strong> ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'></div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#styledef-instance_method" title="#styledef (instance method)">#<strong>styledef</strong> ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Constructs an RTF identifier for the style.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#stylename-instance_method" title="#stylename (instance method)">#<strong>stylename</strong> ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'></div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#suffix-instance_method" title="#suffix (instance method)">#<strong>suffix</strong>(document) ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>This method retrieves the command suffix text associated with a Style
-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>(document) ⇒ Object </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Constructs the RTF formatting representing the style.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="AnonymousStyle.html" title="RRTF::AnonymousStyle (class)">AnonymousStyle</a></span></h3>
+ <p class="inherited"><span class='object_link'><a href="AnonymousStyle.html#prefix-instance_method" title="RRTF::AnonymousStyle#prefix (method)">#prefix</a></span>, <span class='object_link'><a href="AnonymousStyle.html#push_colours-instance_method" title="RRTF::AnonymousStyle#push_colours (method)">#push_colours</a></span>, <span class='object_link'><a href="AnonymousStyle.html#push_fonts-instance_method" title="RRTF::AnonymousStyle#push_fonts (method)">#push_fonts</a></span>, <span class='object_link'><a href="AnonymousStyle.html#rtf_formatting-instance_method" title="RRTF::AnonymousStyle#rtf_formatting (method)">#rtf_formatting</a></span>, <span class='object_link'><a href="AnonymousStyle.html#suffix-instance_method" title="RRTF::AnonymousStyle#suffix (method)">#suffix</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">
@@ -837,24 +668,33 @@
</li>
</ul>
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-19
-20
-21
-22
-23
-24
-25
26
27
28
29
30
@@ -867,14 +707,22 @@
37
38
39
40
41
-42</pre>
+42
+43
+44
+45
+46
+47
+48
+49
+50</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 19</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 26</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'>name</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
@@ -885,10 +733,11 @@
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>next_style_handle</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>auto_update</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'>based_on_style_handle</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>hidden</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='kw'>false</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='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='ivar'>@handle</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'>handle</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@name</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'>name</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@priority</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'>priority</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@flow</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'>flow</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
@@ -920,30 +769,44 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute additive</p>
-
</div>
</div>
<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-3
-4
-5</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_additive'>additive</span>
<span class='ivar'>@additive</span>
<span class='kw'>end</span></pre>
</td>
@@ -963,30 +826,44 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute auto_update</p>
-
</div>
</div>
<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-3
-4
-5</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_auto_update'>auto_update</span>
<span class='ivar'>@auto_update</span>
<span class='kw'>end</span></pre>
</td>
@@ -1006,30 +883,44 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute based_on_style_handle</p>
-
</div>
</div>
<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-3
-4
-5</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_based_on_style_handle'>based_on_style_handle</span>
<span class='ivar'>@based_on_style_handle</span>
<span class='kw'>end</span></pre>
</td>
@@ -1049,30 +940,44 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute handle</p>
-
</div>
</div>
<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-3
-4
-5</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_handle'>handle</span>
<span class='ivar'>@handle</span>
<span class='kw'>end</span></pre>
</td>
@@ -1092,30 +997,44 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute hidden</p>
-
</div>
</div>
<div class="tags">
+<p class="tag_title">Since:</p>
+<ul class="since">
+
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
+
+ </li>
+
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-3
-4
-5</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hidden'>hidden</span>
<span class='ivar'>@hidden</span>
<span class='kw'>end</span></pre>
</td>
@@ -1135,204 +1054,27 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Returns the value of attribute name</p>
-
</div>
</div>
<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-3
-4
-5</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
- <span class='ivar'>@name</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="next_style_handle=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="next_style_handle-instance_method">
+<p class="tag_title">Since:</p>
+<ul class="since">
- #<strong>next_style_handle</strong> ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Returns the value of attribute next_style_handle</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-3
-4
-5</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_next_style_handle'>next_style_handle</span>
- <span class='ivar'>@next_style_handle</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="primary=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="primary-instance_method">
-
- #<strong>primary</strong> ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Returns the value of attribute primary</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-3
-4
-5</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_primary'>primary</span>
- <span class='ivar'>@primary</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="priority=-instance_method"></span>
- <div class="method_details ">
- <h3 class="signature " id="priority-instance_method">
-
- #<strong>priority</strong> ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Returns the value of attribute priority</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-3
-4
-5</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 3</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
- <span class='ivar'>@priority</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="is_character_style?-instance_method">
-
- #<strong>is_character_style?</strong> ⇒ <tt>Boolean</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Used to determine if the style applies to characters. This method always
-returns false and should be overridden by derived classes as needed.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-
<li>
- <span class='type'>(<tt>Boolean</tt>)</span>
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
</li>
</ul>
@@ -1340,54 +1082,56 @@
<tr>
<td>
<pre class="lines">
-80
-81
-82</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 80</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_is_character_style?'>is_character_style?</span>
- <span class='kw'>false</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
+ <span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
+
+ <span id="next_style_handle=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="is_document_style?-instance_method">
+ <h3 class="signature " id="next_style_handle-instance_method">
- #<strong>is_document_style?</strong> ⇒ <tt>Boolean</tt>
+ #<strong>next_style_handle</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Used to determine if the style applies to documents. This method always
-returns false and should be overridden by derived classes as needed.</p>
-
</div>
</div>
<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
+<p class="tag_title">Since:</p>
+<ul class="since">
<li>
- <span class='type'>(<tt>Boolean</tt>)</span>
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
</li>
</ul>
@@ -1395,54 +1139,56 @@
<tr>
<td>
<pre class="lines">
-92
-93
-94</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 92</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_is_document_style?'>is_document_style?</span>
- <span class='kw'>false</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_next_style_handle'>next_style_handle</span>
+ <span class='ivar'>@next_style_handle</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
+
+ <span id="primary=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="is_paragraph_style?-instance_method">
+ <h3 class="signature " id="primary-instance_method">
- #<strong>is_paragraph_style?</strong> ⇒ <tt>Boolean</tt>
+ #<strong>primary</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Used to determine if the style applies to paragraphs. This method always
-returns false and should be overridden by derived classes as needed.</p>
-
</div>
</div>
<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
+<p class="tag_title">Since:</p>
+<ul class="since">
<li>
- <span class='type'>(<tt>Boolean</tt>)</span>
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
</li>
</ul>
@@ -1450,54 +1196,56 @@
<tr>
<td>
<pre class="lines">
-86
-87
-88</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 86</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_is_paragraph_style?'>is_paragraph_style?</span>
- <span class='kw'>false</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_primary'>primary</span>
+ <span class='ivar'>@primary</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
+
+ <span id="priority=-instance_method"></span>
<div class="method_details ">
- <h3 class="signature " id="is_table_style?-instance_method">
+ <h3 class="signature " id="priority-instance_method">
- #<strong>is_table_style?</strong> ⇒ <tt>Boolean</tt>
+ #<strong>priority</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
-<p>Used to determine if the style applies to tables. This method always
-returns false and should be overridden by derived classes as needed.</p>
-
</div>
</div>
<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
+<p class="tag_title">Since:</p>
+<ul class="since">
<li>
- <span class='type'>(<tt>Boolean</tt>)</span>
+
+ <div class='inline'>
+<p>legacy</p>
+</div>
</li>
</ul>
@@ -1505,233 +1253,72 @@
<tr>
<td>
<pre class="lines">
-98
-99
-100</pre>
+10
+11
+12</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 98</span>
+ <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 10</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_is_table_style?'>is_table_style?</span>
- <span class='kw'>false</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
+ <span class='ivar'>@priority</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
- <div class="method_details ">
- <h3 class="signature " id="prefix-instance_method">
-
- #<strong>prefix</strong>(document) ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>This method retrieves the command prefix text associated with a Style
-object. This method always returns nil and should be overridden by derived
-classes as needed.</p>
-
-
</div>
-</div>
-<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
-63
-64
-65</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 63</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</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="rtf_formatting-instance_method">
+ <div class="method_details first">
+ <h3 class="signature first" id="to_rtf-instance_method">
- #<strong>rtf_formatting</strong> ⇒ <tt>Object</tt>
+ #<strong>to_rtf</strong>(document) ⇒ <tt>Object</tt>
-</h3><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/style/style.rb', line 67</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_rtf_formatting'>rtf_formatting</span>
- <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="styledef-instance_method">
-
- #<strong>styledef</strong> ⇒ <tt>Object</tt>
-
-
-
-
-
</h3><div class="docstring">
<div class="discussion">
-
-<p>Constructs an RTF identifier for the style. (override in derived classes as
-needed)</p>
-
-
- </div>
+ <div class="note abstract">
+ <strong>This method is abstract.</strong>
+ <div class='inline'></div>
</div>
-<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
+<p>Constructs the RTF formatting representing the style in a Stylesheet.
+(override in derived classes as needed).</p>
-46
-47
-48</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 46</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_styledef'>styledef</span>
- <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="stylename-instance_method">
-
- #<strong>stylename</strong> ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-50
-51
-52</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 50</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_stylename'>stylename</span>
- <span class='id identifier rubyid_name'>name</span>
-<span class='kw'>end</span></pre>
- </td>
- </tr>
-</table>
-</div>
-
- <div class="method_details ">
- <h3 class="signature " id="suffix-instance_method">
-
- #<strong>suffix</strong>(document) ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>This method retrieves the command suffix text associated with a Style
-object. This method always returns nil and should be overridden by derived
-classes as needed.</p>
-
-
</div>
</div>
<div class="tags">
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-74
-75
-76</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/rrtf/style/style.rb', line 74</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</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="to_rtf-instance_method">
+<p class="tag_title">Since:</p>
+<ul class="since">
- #<strong>to_rtf</strong>(document) ⇒ <tt>Object</tt>
-
-
-
-
-
-</h3><div class="docstring">
- <div class="discussion">
-
-<p>Constructs the RTF formatting representing the style. (override in derived
-classes as needed)</p>
-
-
- </div>
+ <li>
+
+
+
+
+
+ <div class='inline'>
+<p>0.0.1</p>
</div>
-<div class="tags">
+
+ </li>
+</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -1755,10 +1342,10 @@
</div>
</div>
<div id="footer">
- Generated on Mon Jul 24 15:49:02 2017 by
+ 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>
\ No newline at end of file