diff options
Diffstat (limited to 'doc/Axlsx/CellAlignment.html')
| -rw-r--r-- | doc/Axlsx/CellAlignment.html | 1219 |
1 files changed, 0 insertions, 1219 deletions
diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html deleted file mode 100644 index 480b145f..00000000 --- a/doc/Axlsx/CellAlignment.html +++ /dev/null @@ -1,1219 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<title> - Class: Axlsx::CellAlignment - - — AXLSX - -</title> - - <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> - - <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> - -<script type="text/javascript" charset="utf-8"> - relpath = '..'; - if (relpath != '') 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> - <script type="text/javascript" charset="utf-8"> - if (window.top.frames.main) document.body.className = 'frames'; - </script> - - <div id="header"> - <div id="menu"> - - <a href="../_index.html">Index (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">CellAlignment</span> - - - <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> -</div> - - <div id="search"> - - <a id="class_list_link" href="#">Class List</a> - - <a id="method_list_link" href="#">Method List</a> - - <a id="file_list_link" href="#">File List</a> - -</div> - <div class="clear"></div> - </div> - - <iframe id="search_frame"></iframe> - - <div id="content"><h1>Class: Axlsx::CellAlignment - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName">Object</span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next">Axlsx::CellAlignment</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/cell_alignment.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>Using Styles#add_style is the recommended way to manage cell alignment.</p> -</div> - </div> - - -<p>CellAlignment stores information about the cell alignment of a style Xf -Object.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</a></span></li> - - </ul> - -</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="#horizontal-instance_method" title="#horizontal (instance method)">- (Symbol) <strong>horizontal</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The horizontal alignment of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#indent-instance_method" title="#indent (instance method)">- (Integer) <strong>indent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The amount of indent.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#justifyLastLine-instance_method" title="#justifyLastLine (instance method)">- (Boolean) <strong>justifyLastLine</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the last line should be justified.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#readingOrder-instance_method" title="#readingOrder (instance method)">- (Integer) <strong>readingOrder</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#relativeIndent-instance_method" title="#relativeIndent (instance method)">- (Integer) <strong>relativeIndent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The amount of relativeIndent.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#shrinkToFit-instance_method" title="#shrinkToFit (instance method)">- (Boolean) <strong>shrinkToFit</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text should be shrunk to the fit in the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#textRotation-instance_method" title="#textRotation (instance method)">- (Integer) <strong>textRotation</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The textRotation of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#vertical-instance_method" title="#vertical (instance method)">- (Symbol) <strong>vertical</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The vertical alignment of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#wrapText-instance_method" title="#wrapText (instance method)">- (Boolean) <strong>wrapText</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text of the cell should wrap.</p> -</div></span> - -</li> - - - </ul> - - - - - - <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="#initialize-instance_method" title="#initialize (instance method)">- (CellAlignment) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Create a new cell_alignment object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the cell alignment.</p> -</div></span> - -</li> - - - </ul> - - -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <div class="method_details first"> - <p class="signature first" id="initialize-instance_method"> - - - (<tt><span class='object_link'><a href="" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Create a new cell_alignment object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>options</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - <em class="default">(defaults to: <tt>{}</tt>)</em> - - - — - <div class='inline'> -<p>a customizable set of options</p> -</div> - - </li> - -</ul> - - - - - <h3>Options Hash (<tt>options</tt>):</h3> - <ul class="option"> - - <li> - <span class="name">horizontal</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">vertical</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">textRotation</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">wrapText</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">indent</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">relativeIndent</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">justifyLastLine</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">shrinkToFit</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">readingOrder</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -72 -73 -74 -75 -76</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 72</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> - <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> - - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id="horizontal=-instance_method"></span> - <span id="horizontal-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="horizontal-instance_method"> - - - (<tt>Symbol</tt>) <strong>horizontal</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The horizontal cell alignement style must be one of</p> - -<pre class="code"><span class='symbol val'>:general</span> -<span class='symbol val'>:left</span> -<span class='symbol val'>:center</span> -<span class='symbol val'>:right</span> -<span class='symbol val'>:fill</span> -<span class='symbol val'>:justify</span> -<span class='symbol val'>:centerContinuous</span> -<span class='symbol val'>:distributed</span> -</pre> -</div> - </div> - - -<p>The horizontal alignment of the cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='horizontal identifier id'>horizontal</span> - <span class='@horizontal ivar id'>@horizontal</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="indent=-instance_method"></span> - <span id="indent-instance_method"></span> - <div class="method_details "> - <p class="signature " id="indent-instance_method"> - - - (<tt>Integer</tt>) <strong>indent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The amount of indent</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 41</span> - -<span class='def def kw'>def</span> <span class='indent identifier id'>indent</span> - <span class='@indent ivar id'>@indent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="justifyLastLine=-instance_method"></span> - <span id="justifyLastLine-instance_method"></span> - <div class="method_details "> - <p class="signature " id="justifyLastLine-instance_method"> - - - (<tt>Boolean</tt>) <strong>justifyLastLine</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the last line should be justified.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -49 -50 -51</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 49</span> - -<span class='def def kw'>def</span> <span class='justifyLastLine identifier id'>justifyLastLine</span> - <span class='@justifyLastLine ivar id'>@justifyLastLine</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="readingOrder=-instance_method"></span> - <span id="readingOrder-instance_method"></span> - <div class="method_details "> - <p class="signature " id="readingOrder-instance_method"> - - - (<tt>Integer</tt>) <strong>readingOrder</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -60 -61 -62</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 60</span> - -<span class='def def kw'>def</span> <span class='readingOrder identifier id'>readingOrder</span> - <span class='@readingOrder ivar id'>@readingOrder</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="relativeIndent=-instance_method"></span> - <span id="relativeIndent-instance_method"></span> - <div class="method_details "> - <p class="signature " id="relativeIndent-instance_method"> - - - (<tt>Integer</tt>) <strong>relativeIndent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The amount of relativeIndent</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -45 -46 -47</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 45</span> - -<span class='def def kw'>def</span> <span class='relativeIndent identifier id'>relativeIndent</span> - <span class='@relativeIndent ivar id'>@relativeIndent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="shrinkToFit=-instance_method"></span> - <span id="shrinkToFit-instance_method"></span> - <div class="method_details "> - <p class="signature " id="shrinkToFit-instance_method"> - - - (<tt>Boolean</tt>) <strong>shrinkToFit</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the text should be shrunk to the fit in the cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 53</span> - -<span class='def def kw'>def</span> <span class='shrinkToFit identifier id'>shrinkToFit</span> - <span class='@shrinkToFit ivar id'>@shrinkToFit</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="textRotation=-instance_method"></span> - <span id="textRotation-instance_method"></span> - <div class="method_details "> - <p class="signature " id="textRotation-instance_method"> - - - (<tt>Integer</tt>) <strong>textRotation</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The textRotation of the cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='textRotation identifier id'>textRotation</span> - <span class='@textRotation ivar id'>@textRotation</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="vertical=-instance_method"></span> - <span id="vertical-instance_method"></span> - <div class="method_details "> - <p class="signature " id="vertical-instance_method"> - - - (<tt>Symbol</tt>) <strong>vertical</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The vertical cell allingment style must be one of the following:</p> - -<pre class="code"><span class='symbol val'>:top</span> -<span class='symbol val'>:center</span> -<span class='symbol val'>:bottom</span> -<span class='symbol val'>:justify</span> -<span class='symbol val'>:distributed</span> -</pre> -</div> - </div> - - -<p>The vertical alignment of the cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='vertical identifier id'>vertical</span> - <span class='@vertical ivar id'>@vertical</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="wrapText=-instance_method"></span> - <span id="wrapText-instance_method"></span> - <div class="method_details "> - <p class="signature " id="wrapText-instance_method"> - - - (<tt>Boolean</tt>) <strong>wrapText</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the text of the cell should wrap</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='wrapText identifier id'>wrapText</span> - <span class='@wrapText ivar id'>@wrapText</span> -<span class='end end 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"> - <p class="signature first" id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the cell alignment</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>xml</span> - - - <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> - - - - — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -100 -101 -102</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 100</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Nov 30 08:46:30 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.8.7). -</div> - - </body> -</html>
\ No newline at end of file |