<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Prismic::Fragments::StructuredText::Block::Heading — Documentation by YARD 0.9.8 </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 = "Prismic::Fragments::StructuredText::Block::Heading"; 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 (H)</a> » <span class='title'><span class='object_link'><a href="../../../../Prismic.html" title="Prismic (module)">Prismic</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Fragments.html" title="Prismic::Fragments (module)">Fragments</a></span></span> » <span class='title'><span class='object_link'><a href="../../StructuredText.html" title="Prismic::Fragments::StructuredText (class)">StructuredText</a></span></span> » <span class='title'><span class='object_link'><a href="../Block.html" title="Prismic::Fragments::StructuredText::Block (class)">Block</a></span></span> » <span class="title">Heading</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: Prismic::Fragments::StructuredText::Block::Heading </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="Text.html" title="Prismic::Fragments::StructuredText::Block::Text (class)">Text</a></span></span> <ul class="fullTree"> <li>Object</li> <li class="next"><span class='object_link'><a href="Text.html" title="Prismic::Fragments::StructuredText::Block::Text (class)">Text</a></span></li> <li class="next">Prismic::Fragments::StructuredText::Block::Heading</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/prismic/fragments/structured_text.rb</dd> </dl> </div> <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="#level-instance_method" title="#level (instance method)">#<strong>level</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'><p>Returns the value of attribute level.</p> </div></span> </li> </ul> <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Text.html" title="Prismic::Fragments::StructuredText::Block::Text (class)">Text</a></span></h3> <p class="inherited"><span class='object_link'><a href="Text.html#label-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#label (method)">#label</a></span>, <span class='object_link'><a href="Text.html#spans-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#spans (method)">#spans</a></span>, <span class='object_link'><a href="Text.html#text-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#text (method)">#text</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="#as_html-instance_method" title="#as_html (instance method)">#<strong>as_html</strong>(link_resolver = nil, html_serializer = nil) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(text, spans, level, label = nil) ⇒ Heading </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of Heading.</p> </div></span> </li> </ul> <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Text.html" title="Prismic::Fragments::StructuredText::Block::Text (class)">Text</a></span></h3> <p class="inherited"><span class='object_link'><a href="Text.html#as_text-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#as_text (method)">#as_text</a></span>, <span class='object_link'><a href="Text.html#prepare_spans-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#prepare_spans (method)">#prepare_spans</a></span>, <span class='object_link'><a href="Text.html#serialize-instance_method" title="Prismic::Fragments::StructuredText::Block::Text#serialize (method)">#serialize</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>(text, spans, level, label = nil) ⇒ <tt><span class='object_link'><a href="" title="Prismic::Fragments::StructuredText::Block::Heading (class)">Heading</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of Heading</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 267 268 269 270</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/prismic/fragments/structured_text.rb', line 267</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='comma'>,</span> <span class='id identifier rubyid_spans'>spans</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='comma'>,</span> <span class='id identifier rubyid_label'>label</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='comma'>,</span> <span class='id identifier rubyid_spans'>spans</span><span class='comma'>,</span> <span class='id identifier rubyid_label'>label</span><span class='rparen'>)</span> <span class='ivar'>@level</span> <span class='op'>=</span> <span class='id identifier rubyid_level'>level</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="level=-instance_method"></span> <div class="method_details first"> <h3 class="signature first" id="level-instance_method"> #<strong>level</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns the value of attribute level</p> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 265 266 267</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/prismic/fragments/structured_text.rb', line 265</span> <span class='kw'>def</span> <span class='id identifier rubyid_level'>level</span> <span class='ivar'>@level</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="as_html-instance_method"> #<strong>as_html</strong>(link_resolver = nil, html_serializer = nil) ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 272 273 274 275 276 277 278 279</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/prismic/fragments/structured_text.rb', line 272</span> <span class='kw'>def</span> <span class='id identifier rubyid_as_html'>as_html</span><span class='lparen'>(</span><span class='id identifier rubyid_link_resolver'>link_resolver</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_html_serializer'>html_serializer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='id identifier rubyid_custom_html'>custom_html</span> <span class='op'>=</span> <span class='id identifier rubyid_html_serializer'>html_serializer</span> <span class='op'>&&</span> <span class='id identifier rubyid_html_serializer'>html_serializer</span><span class='period'>.</span><span class='id identifier rubyid_serialize'>serialize</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='kw'>super</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_custom_html'>custom_html</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='tstring'><span class='tstring_beg'>%(</span><span class='tstring_content'><h</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_level'>level</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_class_code'>class_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='embexpr_beg'>#{</span><span class='kw'>super</span><span class='embexpr_end'>}</span><span class='tstring_content'></h</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_level'>level</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>)</span></span> <span class='kw'>else</span> <span class='id identifier rubyid_custom_html'>custom_html</span> <span class='kw'>end</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Mon Jan 16 16:05:10 2017 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.8 (ruby-2.3.1). </div> </div> </body> </html>