workbook 0.3.1 → 0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.yardoc/checksums +21 -18
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/Gemfile.lock +4 -4
- data/README.md +8 -5
- data/doc/RubyXL/Cell.html +18 -19
- data/doc/RubyXL/Workbook.html +116 -114
- data/doc/RubyXL.html +3 -3
- data/doc/Workbook/Book.html +513 -145
- data/doc/Workbook/Cell.html +181 -170
- data/doc/Workbook/Format.html +591 -77
- data/doc/Workbook/Modules/RawObjectsStorage.html +39 -45
- data/doc/Workbook/Modules/TableDiffSort.html +225 -87
- data/doc/Workbook/Modules/TypeParser.html +182 -131
- data/doc/Workbook/Modules.html +3 -3
- data/doc/Workbook/Readers/CsvReader.html +101 -39
- data/doc/Workbook/Readers/OdsReader.html +564 -0
- data/doc/Workbook/Readers/TxtReader.html +12 -14
- data/doc/Workbook/Readers/XlsReader.html +154 -138
- data/doc/Workbook/Readers/XlsShared.html +71 -72
- data/doc/Workbook/Readers/XlsxReader.html +89 -82
- data/doc/Workbook/Readers.html +6 -6
- data/doc/Workbook/Row.html +421 -206
- data/doc/Workbook/Sheet.html +379 -32
- data/doc/Workbook/Table.html +328 -90
- data/doc/Workbook/Template.html +55 -60
- data/doc/Workbook/Writers/CsvTableWriter.html +33 -8
- data/doc/Workbook/Writers/HtmlWriter.html +393 -0
- data/doc/Workbook/Writers/XlsWriter.html +132 -92
- data/doc/Workbook/Writers.html +5 -5
- data/doc/Workbook.html +16 -4
- data/doc/_index.html +45 -15
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -0
- data/doc/file.README.html +53 -48
- data/doc/frames.html +1 -1
- data/doc/index.html +53 -48
- data/doc/method_list.html +232 -56
- data/doc/top-level-namespace.html +3 -3
- data/lib/workbook/book.rb +27 -1
- data/lib/workbook/format.rb +46 -7
- data/lib/workbook/modules/type_parser.rb +8 -1
- data/lib/workbook/readers/ods_reader.rb +93 -0
- data/lib/workbook/row.rb +7 -0
- data/lib/workbook/sheet.rb +10 -0
- data/lib/workbook/version.rb +1 -1
- data/lib/workbook/writers/html_writer.rb +56 -0
- data/test/artifacts/book_with_tabs_and_colours.ods +0 -0
- data/test/artifacts/complex_types.ods +0 -0
- data/test/artifacts/excel_different_types.ods +0 -0
- data/test/artifacts/simple_sheet.ods +0 -0
- data/test/test_book.rb +6 -0
- data/test/test_format.rb +39 -0
- data/test/test_modules_type_parser.rb +2 -0
- data/test/test_readers_csv_reader.rb +44 -0
- data/test/test_readers_ods_reader.rb +51 -0
- data/test/test_readers_txt_reader.rb +53 -0
- data/test/test_row.rb +12 -0
- data/test/test_sheet.rb +12 -0
- data/test/test_writers_html_writer.rb +37 -0
- data/workbook.gemspec +2 -2
- metadata +21 -4
data/doc/Workbook/Format.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Workbook::Format
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -108,9 +108,9 @@
|
|
108
108
|
<h2>Overview</h2><div class="docstring">
|
109
109
|
<div class="discussion">
|
110
110
|
|
111
|
-
<p>Format is an object used for maintinaing a cell
|
112
|
-
|
113
|
-
|
111
|
+
<p>Format is an object used for maintinaing a cell's formatting. It can belong
|
112
|
+
to many cells. It maintains a relation to the raw template's equivalent, to
|
113
|
+
preserve attributes Workbook cannot modify/access.</p>
|
114
114
|
|
115
115
|
|
116
116
|
</div>
|
@@ -149,6 +149,33 @@ equivalent, to preserve attributes Workbook cannot modify/access.</p>
|
|
149
149
|
<p>Returns the value of attribute name.</p>
|
150
150
|
</div></span>
|
151
151
|
|
152
|
+
</li>
|
153
|
+
|
154
|
+
|
155
|
+
<li class="public ">
|
156
|
+
<span class="summary_signature">
|
157
|
+
|
158
|
+
<a href="#parent-instance_method" title="#parent (instance method)">- (Object) <strong>parent</strong> </a>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
</span>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
176
|
+
<p>Returns the value of attribute parent.</p>
|
177
|
+
</div></span>
|
178
|
+
|
152
179
|
</li>
|
153
180
|
|
154
181
|
|
@@ -168,6 +195,81 @@ equivalent, to preserve attributes Workbook cannot modify/access.</p>
|
|
168
195
|
<li class="public ">
|
169
196
|
<span class="summary_signature">
|
170
197
|
|
198
|
+
<a href="#all_names-instance_method" title="#all_names (instance method)">- (Array<String>) <strong>all_names</strong> </a>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
</span>
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
<span class="summary_desc"><div class='inline'>
|
213
|
+
<p>returns an array of all format-names this style is inheriting from (and
|
214
|
+
this style).</p>
|
215
|
+
</div></span>
|
216
|
+
|
217
|
+
</li>
|
218
|
+
|
219
|
+
|
220
|
+
<li class="public ">
|
221
|
+
<span class="summary_signature">
|
222
|
+
|
223
|
+
<a href="#flattened-instance_method" title="#flattened (instance method)">- (Workbook::Format) <strong>flattened</strong> </a>
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
</span>
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
<span class="summary_desc"><div class='inline'>
|
238
|
+
<p>Applies the formatting options of self with its parents until no parent can
|
239
|
+
be found.</p>
|
240
|
+
</div></span>
|
241
|
+
|
242
|
+
</li>
|
243
|
+
|
244
|
+
|
245
|
+
<li class="public ">
|
246
|
+
<span class="summary_signature">
|
247
|
+
|
248
|
+
<a href="#formats-instance_method" title="#formats (instance method)">- (Array<Workbook::Format>) <strong>formats</strong> </a>
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
</span>
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
<span class="summary_desc"><div class='inline'>
|
263
|
+
<p>returns an array of all formats this style is inheriting from (including
|
264
|
+
itself).</p>
|
265
|
+
</div></span>
|
266
|
+
|
267
|
+
</li>
|
268
|
+
|
269
|
+
|
270
|
+
<li class="public ">
|
271
|
+
<span class="summary_signature">
|
272
|
+
|
171
273
|
<a href="#has_background_color%3F-instance_method" title="#has_background_color? (instance method)">- (Boolean) <strong>has_background_color?</strong>(color = :any) </a>
|
172
274
|
|
173
275
|
|
@@ -183,8 +285,8 @@ equivalent, to preserve attributes Workbook cannot modify/access.</p>
|
|
183
285
|
|
184
286
|
|
185
287
|
<span class="summary_desc"><div class='inline'>
|
186
|
-
<p>Does the current format feature a background <
|
187
|
-
|
288
|
+
<p>Does the current format feature a background <b>color</b>? (not black or
|
289
|
+
white or transparant).</p>
|
188
290
|
</div></span>
|
189
291
|
|
190
292
|
</li>
|
@@ -193,7 +295,7 @@ black or white or transparant).</p>
|
|
193
295
|
<li class="public ">
|
194
296
|
<span class="summary_signature">
|
195
297
|
|
196
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Format) <strong>initialize</strong>(options = {}) </a>
|
298
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Format) <strong>initialize</strong>(options = {}, name = nil) </a>
|
197
299
|
|
198
300
|
|
199
301
|
|
@@ -219,7 +321,7 @@ black or white or transparant).</p>
|
|
219
321
|
<li class="public ">
|
220
322
|
<span class="summary_signature">
|
221
323
|
|
222
|
-
<a href="#merge-instance_method" title="#merge (instance method)">- (
|
324
|
+
<a href="#merge-instance_method" title="#merge (instance method)">- (Workbook::Format) <strong>merge</strong>(other_format) </a>
|
223
325
|
|
224
326
|
|
225
327
|
|
@@ -235,7 +337,32 @@ black or white or transparant).</p>
|
|
235
337
|
|
236
338
|
<span class="summary_desc"><div class='inline'>
|
237
339
|
<p>Combines the formatting options of one with another, removes as a
|
238
|
-
consequence the reference to the raw object
|
340
|
+
consequence the reference to the raw object's equivalent.</p>
|
341
|
+
</div></span>
|
342
|
+
|
343
|
+
</li>
|
344
|
+
|
345
|
+
|
346
|
+
<li class="public ">
|
347
|
+
<span class="summary_signature">
|
348
|
+
|
349
|
+
<a href="#merge%21-instance_method" title="#merge! (instance method)">- (Workbook::Format) <strong>merge!</strong>(other_format) </a>
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
</span>
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
<span class="summary_desc"><div class='inline'>
|
364
|
+
<p>Applies the formatting options of self with another, removes as a
|
365
|
+
consequence the reference to the raw object's equivalent.</p>
|
239
366
|
</div></span>
|
240
367
|
|
241
368
|
</li>
|
@@ -266,7 +393,29 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
266
393
|
<li class="public ">
|
267
394
|
<span class="summary_signature">
|
268
395
|
|
269
|
-
<a href="#
|
396
|
+
<a href="#merge_hash%21-instance_method" title="#merge_hash! (instance method)">- (Object) <strong>merge_hash!</strong> </a>
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
</span>
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
411
|
+
|
412
|
+
</li>
|
413
|
+
|
414
|
+
|
415
|
+
<li class="public ">
|
416
|
+
<span class="summary_signature">
|
417
|
+
|
418
|
+
<a href="#to_css-instance_method" title="#to_css (instance method)">- (Object) <strong>to_css</strong> </a>
|
270
419
|
|
271
420
|
|
272
421
|
|
@@ -282,7 +431,7 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
282
431
|
|
283
432
|
<span class="summary_desc"><div class='inline'>
|
284
433
|
<p>Returns a string that can be used as inline cell styling (e.g. `<td
|
285
|
-
style
|
434
|
+
style="<%=cell.format.to_css%>"><%=cell%></td>`).</p>
|
286
435
|
</div></span>
|
287
436
|
|
288
437
|
</li>
|
@@ -309,7 +458,7 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`).</p>
|
|
309
458
|
<div class="method_details first">
|
310
459
|
<h3 class="signature first" id="initialize-instance_method">
|
311
460
|
|
312
|
-
- (<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Format</a></span></tt>) <strong>initialize</strong>(options = {})
|
461
|
+
- (<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Format</a></span></tt>) <strong>initialize</strong>(options = {}, name = nil)
|
313
462
|
|
314
463
|
|
315
464
|
|
@@ -354,13 +503,18 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`).</p>
|
|
354
503
|
<pre class="lines">
|
355
504
|
|
356
505
|
|
357
|
-
|
506
|
+
15
|
507
|
+
16
|
508
|
+
17
|
509
|
+
18</pre>
|
358
510
|
</td>
|
359
511
|
<td>
|
360
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
512
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 15</span>
|
361
513
|
|
362
|
-
<span class='
|
363
|
-
</
|
514
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='op'>=</span><span class='kw'>nil</span>
|
515
|
+
<span class='id identifier rubyid_options'>options</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_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span><span class='op'>=</span><span class='id identifier rubyid_v'>v</span><span class='rbrace'>}</span>
|
516
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
|
517
|
+
<span class='kw'>end</span></pre>
|
364
518
|
</td>
|
365
519
|
</tr>
|
366
520
|
</table>
|
@@ -399,17 +553,59 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`).</p>
|
|
399
553
|
<pre class="lines">
|
400
554
|
|
401
555
|
|
402
|
-
|
403
|
-
|
404
|
-
|
556
|
+
11
|
557
|
+
12
|
558
|
+
13</pre>
|
405
559
|
</td>
|
406
560
|
<td>
|
407
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
561
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 11</span>
|
408
562
|
|
409
|
-
<span class='
|
410
|
-
<span class='
|
411
|
-
<span class='
|
412
|
-
</
|
563
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
564
|
+
<span class='ivar'>@name</span>
|
565
|
+
<span class='kw'>end</span></pre>
|
566
|
+
</td>
|
567
|
+
</tr>
|
568
|
+
</table>
|
569
|
+
</div>
|
570
|
+
|
571
|
+
|
572
|
+
<span id="parent=-instance_method"></span>
|
573
|
+
<div class="method_details ">
|
574
|
+
<h3 class="signature " id="parent-instance_method">
|
575
|
+
|
576
|
+
- (<tt>Object</tt>) <strong>parent</strong>
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
</h3><div class="docstring">
|
583
|
+
<div class="discussion">
|
584
|
+
|
585
|
+
<p>Returns the value of attribute parent</p>
|
586
|
+
|
587
|
+
|
588
|
+
</div>
|
589
|
+
</div>
|
590
|
+
<div class="tags">
|
591
|
+
|
592
|
+
|
593
|
+
</div><table class="source_code">
|
594
|
+
<tr>
|
595
|
+
<td>
|
596
|
+
<pre class="lines">
|
597
|
+
|
598
|
+
|
599
|
+
11
|
600
|
+
12
|
601
|
+
13</pre>
|
602
|
+
</td>
|
603
|
+
<td>
|
604
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 11</span>
|
605
|
+
|
606
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
|
607
|
+
<span class='ivar'>@parent</span>
|
608
|
+
<span class='kw'>end</span></pre>
|
413
609
|
</td>
|
414
610
|
</tr>
|
415
611
|
</table>
|
@@ -423,7 +619,206 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`).</p>
|
|
423
619
|
|
424
620
|
|
425
621
|
<div class="method_details first">
|
426
|
-
<h3 class="signature first" id="
|
622
|
+
<h3 class="signature first" id="all_names-instance_method">
|
623
|
+
|
624
|
+
- (<tt>Array<String></tt>) <strong>all_names</strong>
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
</h3><div class="docstring">
|
631
|
+
<div class="discussion">
|
632
|
+
|
633
|
+
<p>returns an array of all format-names this style is inheriting from (and
|
634
|
+
this style)</p>
|
635
|
+
|
636
|
+
|
637
|
+
</div>
|
638
|
+
</div>
|
639
|
+
<div class="tags">
|
640
|
+
|
641
|
+
<p class="tag_title">Returns:</p>
|
642
|
+
<ul class="return">
|
643
|
+
|
644
|
+
<li>
|
645
|
+
|
646
|
+
|
647
|
+
<span class='type'>(<tt>Array<String></tt>)</span>
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
—
|
652
|
+
<div class='inline'>
|
653
|
+
<p>an array of Workbook::Formats</p>
|
654
|
+
</div>
|
655
|
+
|
656
|
+
</li>
|
657
|
+
|
658
|
+
</ul>
|
659
|
+
|
660
|
+
</div><table class="source_code">
|
661
|
+
<tr>
|
662
|
+
<td>
|
663
|
+
<pre class="lines">
|
664
|
+
|
665
|
+
|
666
|
+
70
|
667
|
+
71
|
668
|
+
72</pre>
|
669
|
+
</td>
|
670
|
+
<td>
|
671
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 70</span>
|
672
|
+
|
673
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_all_names'>all_names</span>
|
674
|
+
<span class='id identifier rubyid_formats'>formats</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</span>
|
675
|
+
<span class='kw'>end</span></pre>
|
676
|
+
</td>
|
677
|
+
</tr>
|
678
|
+
</table>
|
679
|
+
</div>
|
680
|
+
|
681
|
+
<div class="method_details ">
|
682
|
+
<h3 class="signature " id="flattened-instance_method">
|
683
|
+
|
684
|
+
- (<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>flattened</strong>
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
</h3><div class="docstring">
|
691
|
+
<div class="discussion">
|
692
|
+
|
693
|
+
<p>Applies the formatting options of self with its parents until no parent can
|
694
|
+
be found</p>
|
695
|
+
|
696
|
+
|
697
|
+
</div>
|
698
|
+
</div>
|
699
|
+
<div class="tags">
|
700
|
+
|
701
|
+
<p class="tag_title">Returns:</p>
|
702
|
+
<ul class="return">
|
703
|
+
|
704
|
+
<li>
|
705
|
+
|
706
|
+
|
707
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
708
|
+
|
709
|
+
|
710
|
+
|
711
|
+
—
|
712
|
+
<div class='inline'>
|
713
|
+
<p>new Workbook::Format that is the result of merging current style with all
|
714
|
+
its parent’s styles.</p>
|
715
|
+
</div>
|
716
|
+
|
717
|
+
</li>
|
718
|
+
|
719
|
+
</ul>
|
720
|
+
|
721
|
+
</div><table class="source_code">
|
722
|
+
<tr>
|
723
|
+
<td>
|
724
|
+
<pre class="lines">
|
725
|
+
|
726
|
+
|
727
|
+
76
|
728
|
+
77
|
729
|
+
78
|
730
|
+
79
|
731
|
+
80</pre>
|
732
|
+
</td>
|
733
|
+
<td>
|
734
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 76</span>
|
735
|
+
|
736
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_flattened'>flattened</span>
|
737
|
+
<span class='id identifier rubyid_ff'>ff</span><span class='op'>=</span><span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Format</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
738
|
+
<span class='id identifier rubyid_formats'>formats</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_a'>a</span><span class='op'>|</span> <span class='id identifier rubyid_ff'>ff</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
739
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_ff'>ff</span>
|
740
|
+
<span class='kw'>end</span></pre>
|
741
|
+
</td>
|
742
|
+
</tr>
|
743
|
+
</table>
|
744
|
+
</div>
|
745
|
+
|
746
|
+
<div class="method_details ">
|
747
|
+
<h3 class="signature " id="formats-instance_method">
|
748
|
+
|
749
|
+
- (<tt>Array<<span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span>></tt>) <strong>formats</strong>
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
</h3><div class="docstring">
|
756
|
+
<div class="discussion">
|
757
|
+
|
758
|
+
<p>returns an array of all formats this style is inheriting from (including
|
759
|
+
itself)</p>
|
760
|
+
|
761
|
+
|
762
|
+
</div>
|
763
|
+
</div>
|
764
|
+
<div class="tags">
|
765
|
+
|
766
|
+
<p class="tag_title">Returns:</p>
|
767
|
+
<ul class="return">
|
768
|
+
|
769
|
+
<li>
|
770
|
+
|
771
|
+
|
772
|
+
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span>></tt>)</span>
|
773
|
+
|
774
|
+
|
775
|
+
|
776
|
+
—
|
777
|
+
<div class='inline'>
|
778
|
+
<p>an array of Workbook::Formats</p>
|
779
|
+
</div>
|
780
|
+
|
781
|
+
</li>
|
782
|
+
|
783
|
+
</ul>
|
784
|
+
|
785
|
+
</div><table class="source_code">
|
786
|
+
<tr>
|
787
|
+
<td>
|
788
|
+
<pre class="lines">
|
789
|
+
|
790
|
+
|
791
|
+
57
|
792
|
+
58
|
793
|
+
59
|
794
|
+
60
|
795
|
+
61
|
796
|
+
62
|
797
|
+
63
|
798
|
+
64
|
799
|
+
65
|
800
|
+
66</pre>
|
801
|
+
</td>
|
802
|
+
<td>
|
803
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 57</span>
|
804
|
+
|
805
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_formats'>formats</span>
|
806
|
+
<span class='id identifier rubyid_formats'>formats</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span>
|
807
|
+
<span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='kw'>self</span>
|
808
|
+
<span class='id identifier rubyid_formats'>formats</span> <span class='op'><<</span> <span class='id identifier rubyid_f'>f</span>
|
809
|
+
<span class='kw'>while</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
|
810
|
+
<span class='id identifier rubyid_formats'>formats</span> <span class='op'><<</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
|
811
|
+
<span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span>
|
812
|
+
<span class='kw'>end</span>
|
813
|
+
<span class='id identifier rubyid_formats'>formats</span><span class='period'>.</span><span class='id identifier rubyid_reverse'>reverse</span>
|
814
|
+
<span class='kw'>end</span></pre>
|
815
|
+
</td>
|
816
|
+
</tr>
|
817
|
+
</table>
|
818
|
+
</div>
|
819
|
+
|
820
|
+
<div class="method_details ">
|
821
|
+
<h3 class="signature " id="has_background_color?-instance_method">
|
427
822
|
|
428
823
|
- (<tt>Boolean</tt>) <strong>has_background_color?</strong>(color = :any)
|
429
824
|
|
@@ -434,8 +829,8 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`).</p>
|
|
434
829
|
</h3><div class="docstring">
|
435
830
|
<div class="discussion">
|
436
831
|
|
437
|
-
<p>Does the current format feature a background <
|
438
|
-
|
832
|
+
<p>Does the current format feature a background <b>color</b>? (not black or
|
833
|
+
white or transparant).</p>
|
439
834
|
|
440
835
|
|
441
836
|
</div>
|
@@ -462,25 +857,24 @@ black or white or transparant).</p>
|
|
462
857
|
<pre class="lines">
|
463
858
|
|
464
859
|
|
465
|
-
18
|
466
|
-
19
|
467
|
-
20
|
468
860
|
21
|
469
861
|
22
|
470
862
|
23
|
471
|
-
24
|
863
|
+
24
|
864
|
+
25
|
865
|
+
26
|
866
|
+
27</pre>
|
472
867
|
</td>
|
473
868
|
<td>
|
474
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
475
|
-
|
476
|
-
<span class='
|
477
|
-
<span class='
|
478
|
-
<span class='
|
479
|
-
<span class='
|
480
|
-
<span class='
|
481
|
-
<span class='
|
482
|
-
<span class='
|
483
|
-
</pre>
|
869
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 21</span>
|
870
|
+
|
871
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_has_background_color?'>has_background_color?</span> <span class='id identifier rubyid_color'>color</span><span class='op'>=</span><span class='symbol'>:any</span>
|
872
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span>
|
873
|
+
<span class='kw'>return</span> <span class='lparen'>(</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='op'>==</span><span class='id identifier rubyid_color'>color</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='kw'>or</span> <span class='lparen'>(</span><span class='op'>!</span><span class='lparen'>(</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='op'>==</span><span class='kw'>nil</span> <span class='kw'>or</span> <span class='lparen'>(</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='op'>==</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>#ffffff</span><span class='tstring_end'>'</span></span> <span class='kw'>or</span> <span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='op'>==</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>#000000</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='id identifier rubyid_color'>color</span><span class='op'>==</span><span class='symbol'>:any</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
874
|
+
<span class='kw'>else</span>
|
875
|
+
<span class='kw'>return</span> <span class='kw'>false</span>
|
876
|
+
<span class='kw'>end</span>
|
877
|
+
<span class='kw'>end</span></pre>
|
484
878
|
</td>
|
485
879
|
</tr>
|
486
880
|
</table>
|
@@ -489,7 +883,7 @@ black or white or transparant).</p>
|
|
489
883
|
<div class="method_details ">
|
490
884
|
<h3 class="signature " id="merge-instance_method">
|
491
885
|
|
492
|
-
- (<tt>
|
886
|
+
- (<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>merge</strong>(other_format)
|
493
887
|
|
494
888
|
|
495
889
|
|
@@ -499,7 +893,7 @@ black or white or transparant).</p>
|
|
499
893
|
<div class="discussion">
|
500
894
|
|
501
895
|
<p>Combines the formatting options of one with another, removes as a
|
502
|
-
consequence the reference to the raw object
|
896
|
+
consequence the reference to the raw object's equivalent.</p>
|
503
897
|
|
504
898
|
|
505
899
|
</div>
|
@@ -521,6 +915,24 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
521
915
|
|
522
916
|
</ul>
|
523
917
|
|
918
|
+
<p class="tag_title">Returns:</p>
|
919
|
+
<ul class="return">
|
920
|
+
|
921
|
+
<li>
|
922
|
+
|
923
|
+
|
924
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
925
|
+
|
926
|
+
|
927
|
+
|
928
|
+
—
|
929
|
+
<div class='inline'>
|
930
|
+
<p>a new resulting Workbook::Format</p>
|
931
|
+
</div>
|
932
|
+
|
933
|
+
</li>
|
934
|
+
|
935
|
+
</ul>
|
524
936
|
|
525
937
|
</div><table class="source_code">
|
526
938
|
<tr>
|
@@ -528,19 +940,95 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
528
940
|
<pre class="lines">
|
529
941
|
|
530
942
|
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
943
|
+
42
|
944
|
+
43
|
945
|
+
44
|
946
|
+
45</pre>
|
535
947
|
</td>
|
536
948
|
<td>
|
537
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
949
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 42</span>
|
538
950
|
|
539
|
-
<span class='
|
540
|
-
<span class='
|
541
|
-
<span class='
|
542
|
-
<span class='
|
543
|
-
</
|
951
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_other_format'>other_format</span><span class='rparen'>)</span>
|
952
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_remove_all_raws!'>remove_all_raws!</span>
|
953
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge_hash'>merge_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_other_format'>other_format</span><span class='rparen'>)</span>
|
954
|
+
<span class='kw'>end</span></pre>
|
955
|
+
</td>
|
956
|
+
</tr>
|
957
|
+
</table>
|
958
|
+
</div>
|
959
|
+
|
960
|
+
<div class="method_details ">
|
961
|
+
<h3 class="signature " id="merge!-instance_method">
|
962
|
+
|
963
|
+
- (<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>merge!</strong>(other_format)
|
964
|
+
|
965
|
+
|
966
|
+
|
967
|
+
|
968
|
+
|
969
|
+
</h3><div class="docstring">
|
970
|
+
<div class="discussion">
|
971
|
+
|
972
|
+
<p>Applies the formatting options of self with another, removes as a
|
973
|
+
consequence the reference to the raw object's equivalent.</p>
|
974
|
+
|
975
|
+
|
976
|
+
</div>
|
977
|
+
</div>
|
978
|
+
<div class="tags">
|
979
|
+
<p class="tag_title">Parameters:</p>
|
980
|
+
<ul class="param">
|
981
|
+
|
982
|
+
<li>
|
983
|
+
|
984
|
+
<span class='name'>other_format</span>
|
985
|
+
|
986
|
+
|
987
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
</li>
|
992
|
+
|
993
|
+
</ul>
|
994
|
+
|
995
|
+
<p class="tag_title">Returns:</p>
|
996
|
+
<ul class="return">
|
997
|
+
|
998
|
+
<li>
|
999
|
+
|
1000
|
+
|
1001
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
|
1002
|
+
|
1003
|
+
|
1004
|
+
|
1005
|
+
—
|
1006
|
+
<div class='inline'>
|
1007
|
+
<p>self</p>
|
1008
|
+
</div>
|
1009
|
+
|
1010
|
+
</li>
|
1011
|
+
|
1012
|
+
</ul>
|
1013
|
+
|
1014
|
+
</div><table class="source_code">
|
1015
|
+
<tr>
|
1016
|
+
<td>
|
1017
|
+
<pre class="lines">
|
1018
|
+
|
1019
|
+
|
1020
|
+
50
|
1021
|
+
51
|
1022
|
+
52
|
1023
|
+
53</pre>
|
1024
|
+
</td>
|
1025
|
+
<td>
|
1026
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 50</span>
|
1027
|
+
|
1028
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_other_format'>other_format</span><span class='rparen'>)</span>
|
1029
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_remove_all_raws!'>remove_all_raws!</span>
|
1030
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge_hash!'>merge_hash!</span><span class='lparen'>(</span><span class='id identifier rubyid_other_format'>other_format</span><span class='rparen'>)</span>
|
1031
|
+
<span class='kw'>end</span></pre>
|
544
1032
|
</td>
|
545
1033
|
</tr>
|
546
1034
|
</table>
|
@@ -561,13 +1049,38 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
561
1049
|
<pre class="lines">
|
562
1050
|
|
563
1051
|
|
564
|
-
|
1052
|
+
8</pre>
|
565
1053
|
</td>
|
566
1054
|
<td>
|
567
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
1055
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 8</span>
|
568
1056
|
|
569
|
-
<span class='
|
570
|
-
</
|
1057
|
+
<span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:merge_hash</span><span class='comma'>,</span> <span class='symbol'>:merge</span></pre>
|
1058
|
+
</td>
|
1059
|
+
</tr>
|
1060
|
+
</table>
|
1061
|
+
</div>
|
1062
|
+
|
1063
|
+
<div class="method_details ">
|
1064
|
+
<h3 class="signature " id="merge_hash!-instance_method">
|
1065
|
+
|
1066
|
+
- (<tt>Object</tt>) <strong>merge_hash!</strong>
|
1067
|
+
|
1068
|
+
|
1069
|
+
|
1070
|
+
|
1071
|
+
|
1072
|
+
</h3><table class="source_code">
|
1073
|
+
<tr>
|
1074
|
+
<td>
|
1075
|
+
<pre class="lines">
|
1076
|
+
|
1077
|
+
|
1078
|
+
9</pre>
|
1079
|
+
</td>
|
1080
|
+
<td>
|
1081
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 9</span>
|
1082
|
+
|
1083
|
+
<span class='id identifier rubyid_alias_method'>alias_method</span> <span class='symbol'>:merge_hash!</span><span class='comma'>,</span> <span class='symbol'>:merge!</span></pre>
|
571
1084
|
</td>
|
572
1085
|
</tr>
|
573
1086
|
</table>
|
@@ -576,7 +1089,7 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
576
1089
|
<div class="method_details ">
|
577
1090
|
<h3 class="signature " id="to_css-instance_method">
|
578
1091
|
|
579
|
-
- (<tt>
|
1092
|
+
- (<tt>Object</tt>) <strong>to_css</strong>
|
580
1093
|
|
581
1094
|
|
582
1095
|
|
@@ -586,7 +1099,7 @@ consequence the reference to the raw object’s equivalent.</p>
|
|
586
1099
|
<div class="discussion">
|
587
1100
|
|
588
1101
|
<p>Returns a string that can be used as inline cell styling (e.g. `<td
|
589
|
-
style
|
1102
|
+
style="<%=cell.format.to_css%>"><%=cell%></td>`)</p>
|
590
1103
|
|
591
1104
|
|
592
1105
|
</div>
|
@@ -599,13 +1112,13 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`)</p>
|
|
599
1112
|
<li>
|
600
1113
|
|
601
1114
|
|
602
|
-
<span class='type'
|
1115
|
+
<span class='type'></span>
|
603
1116
|
|
604
1117
|
|
605
1118
|
|
606
|
-
|
1119
|
+
|
607
1120
|
<div class='inline'>
|
608
|
-
<p>very basic CSS styling string</p>
|
1121
|
+
<p>String very basic CSS styling string</p>
|
609
1122
|
</div>
|
610
1123
|
|
611
1124
|
</li>
|
@@ -618,23 +1131,24 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`)</p>
|
|
618
1131
|
<pre class="lines">
|
619
1132
|
|
620
1133
|
|
621
|
-
28
|
622
|
-
29
|
623
|
-
30
|
624
1134
|
31
|
625
1135
|
32
|
626
|
-
33
|
1136
|
+
33
|
1137
|
+
34
|
1138
|
+
35
|
1139
|
+
36
|
1140
|
+
37</pre>
|
627
1141
|
</td>
|
628
1142
|
<td>
|
629
|
-
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line
|
630
|
-
|
631
|
-
<span class='
|
632
|
-
<span class='
|
633
|
-
<span class='
|
634
|
-
<span class='
|
635
|
-
<span class='
|
636
|
-
<span class='
|
637
|
-
</pre>
|
1143
|
+
<pre class="code"><span class="info file"># File 'lib/workbook/format.rb', line 31</span>
|
1144
|
+
|
1145
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_css'>to_css</span>
|
1146
|
+
<span class='id identifier rubyid_css_parts'>css_parts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
1147
|
+
<span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background_color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:background</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span>
|
1148
|
+
<span class='id identifier rubyid_css_parts'>css_parts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>background: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_background'>background</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_background'>background</span> <span class='kw'>and</span> <span class='id identifier rubyid_background'>background</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
1149
|
+
<span class='id identifier rubyid_css_parts'>css_parts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>color: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_flattened'>flattened</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span>
|
1150
|
+
<span class='id identifier rubyid_css_parts'>css_parts</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>; </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1151
|
+
<span class='kw'>end</span></pre>
|
638
1152
|
</td>
|
639
1153
|
</tr>
|
640
1154
|
</table>
|
@@ -645,9 +1159,9 @@ style=“<%=cell.format.to_css%>”><%=cell%></td>`)</p>
|
|
645
1159
|
</div>
|
646
1160
|
|
647
1161
|
<div id="footer">
|
648
|
-
Generated on
|
1162
|
+
Generated on Sun May 5 14:58:08 2013 by
|
649
1163
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
650
|
-
0.8.
|
1164
|
+
0.8.5.2 (ruby-1.9.3).
|
651
1165
|
</div>
|
652
1166
|
|
653
1167
|
</body>
|