jruby_excelcom 0.0.1-java
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.
- checksums.yaml +7 -0
- data/.//jruby_excelcom.gemspec +13 -0
- data/LICENSE +201 -0
- data/doc/ExcelColor.html +95 -0
- data/doc/ExcelConnection.html +709 -0
- data/doc/JavaExcelcom.html +95 -0
- data/doc/LICENSE.html +283 -0
- data/doc/MiniTest.html +95 -0
- data/doc/Object.html +153 -0
- data/doc/Time.html +95 -0
- data/doc/Workbook.html +520 -0
- data/doc/Worksheet.html +1111 -0
- data/doc/created.rid +12 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +590 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +103 -0
- data/doc/jruby_excelcom_gemspec.html +98 -0
- data/doc/js/darkfish.js +161 -0
- data/doc/js/jquery.js +4 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +109 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +228 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +337 -0
- data/lib/jars/excelcom-0.0.5.jar +0 -0
- data/lib/jars/jna-4.4.0.jar +0 -0
- data/lib/jars/jna-platform-4.4.0.jar +0 -0
- data/lib/jruby_excelcom/excel_connection.rb +81 -0
- data/lib/jruby_excelcom/workbook.rb +46 -0
- data/lib/jruby_excelcom/worksheet.rb +136 -0
- data/lib/jruby_excelcom.rb +22 -0
- data/test/resources/test.xlsx +0 -0
- data/test/resources/test2.xlsx +0 -0
- data/test/test_helper.rb +4 -0
- data/test/unit/excel_connection_spec.rb +38 -0
- data/test/unit/workbook_spec.rb +41 -0
- data/test/unit/worksheet_spec.rb +100 -0
- metadata +114 -0
|
@@ -0,0 +1,709 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class ExcelConnection - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "./";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="./js/jquery.js"></script>
|
|
14
|
+
<script src="./js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="./index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link">Object
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<div id="method-list-section" class="nav-section">
|
|
69
|
+
<h3>Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list" role="directory">
|
|
72
|
+
|
|
73
|
+
<li ><a href="#method-c-connect">::connect</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-c-initialize_com">::initialize_com</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-c-new">::new</a>
|
|
78
|
+
|
|
79
|
+
<li ><a href="#method-c-uninitialize_com">::uninitialize_com</a>
|
|
80
|
+
|
|
81
|
+
<li ><a href="#method-i-active_workbook">#active_workbook</a>
|
|
82
|
+
|
|
83
|
+
<li ><a href="#method-i-display_alerts-3D">#display_alerts=</a>
|
|
84
|
+
|
|
85
|
+
<li ><a href="#method-i-getActiveWorkbook">#getActiveWorkbook</a>
|
|
86
|
+
|
|
87
|
+
<li ><a href="#method-i-getVersion">#getVersion</a>
|
|
88
|
+
|
|
89
|
+
<li ><a href="#method-i-openWorkbook">#openWorkbook</a>
|
|
90
|
+
|
|
91
|
+
<li ><a href="#method-i-open_workbook">#open_workbook</a>
|
|
92
|
+
|
|
93
|
+
<li ><a href="#method-i-quit">#quit</a>
|
|
94
|
+
|
|
95
|
+
<li ><a href="#method-i-setDisplayAlerts">#setDisplayAlerts</a>
|
|
96
|
+
|
|
97
|
+
<li ><a href="#method-i-setVisible">#setVisible</a>
|
|
98
|
+
|
|
99
|
+
<li ><a href="#method-i-version">#version</a>
|
|
100
|
+
|
|
101
|
+
<li ><a href="#method-i-visible-3D">#visible=</a>
|
|
102
|
+
|
|
103
|
+
<li ><a href="#method-i-workbook">#workbook</a>
|
|
104
|
+
|
|
105
|
+
</ul>
|
|
106
|
+
</div>
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</nav>
|
|
110
|
+
|
|
111
|
+
<main role="main" aria-labelledby="class-ExcelConnection">
|
|
112
|
+
<h1 id="class-ExcelConnection" class="class">
|
|
113
|
+
class ExcelConnection
|
|
114
|
+
</h1>
|
|
115
|
+
|
|
116
|
+
<section class="description">
|
|
117
|
+
|
|
118
|
+
</section>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
134
|
+
<header>
|
|
135
|
+
<h3>Public Class Methods</h3>
|
|
136
|
+
</header>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<div id="method-c-connect" class="method-detail ">
|
|
140
|
+
|
|
141
|
+
<div class="method-heading">
|
|
142
|
+
<span class="method-name">connect</span><span
|
|
143
|
+
class="method-args">(use_active_instance = false) { |con| ... }</span>
|
|
144
|
+
|
|
145
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<div class="method-description">
|
|
151
|
+
|
|
152
|
+
<p>see <code>new</code></p>
|
|
153
|
+
|
|
154
|
+
<p>optional block possible, where <code>ExcelConnection#quit</code> gets
|
|
155
|
+
called on blocks end e.g. <code>ExcelConnection::connect{|con| con.workbook
|
|
156
|
+
... }</code></p>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
<div class="method-source-code" id="connect-source">
|
|
162
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 12</span>
|
|
163
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-identifier">use_active_instance</span> = <span class="ruby-keyword">false</span>)
|
|
164
|
+
<span class="ruby-identifier">con</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">use_active_instance</span>)
|
|
165
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
166
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">con</span>)
|
|
167
|
+
<span class="ruby-identifier">con</span>.<span class="ruby-identifier">quit</span>
|
|
168
|
+
<span class="ruby-keyword">else</span>
|
|
169
|
+
<span class="ruby-identifier">con</span>
|
|
170
|
+
<span class="ruby-keyword">end</span>
|
|
171
|
+
<span class="ruby-keyword">end</span></pre>
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<div id="method-c-initialize_com" class="method-detail ">
|
|
183
|
+
|
|
184
|
+
<div class="method-heading">
|
|
185
|
+
<span class="method-name">initialize_com</span><span
|
|
186
|
+
class="method-args">()</span>
|
|
187
|
+
|
|
188
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<div class="method-description">
|
|
194
|
+
|
|
195
|
+
<p>initializes com manually, not recommended! happens automatically when an
|
|
196
|
+
instance is created</p>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<div class="method-source-code" id="initialize_com-source">
|
|
202
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 23</span>
|
|
203
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">initialize_com</span>
|
|
204
|
+
<span class="ruby-constant">JavaExcelcom</span><span class="ruby-operator">::</span><span class="ruby-constant">ExcelConnection</span><span class="ruby-operator">::</span><span class="ruby-identifier">initialize_com</span>
|
|
205
|
+
<span class="ruby-keyword">end</span></pre>
|
|
206
|
+
</div>
|
|
207
|
+
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
</div>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<div id="method-c-new" class="method-detail ">
|
|
217
|
+
|
|
218
|
+
<div class="method-heading">
|
|
219
|
+
<span class="method-name">new</span><span
|
|
220
|
+
class="method-args">(use_active_instance = false)</span>
|
|
221
|
+
|
|
222
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
223
|
+
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<div class="method-description">
|
|
228
|
+
|
|
229
|
+
<p>initializes com and connects to an excel instance</p>
|
|
230
|
+
<dl class="rdoc-list note-list"><dt><code>use_active_instance</code>
|
|
231
|
+
<dd>
|
|
232
|
+
<p>whether an existing excel instance should be used or a new isntance should
|
|
233
|
+
be created. Default value is <code>false</code></p>
|
|
234
|
+
</dd></dl>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<div class="method-source-code" id="new-source">
|
|
240
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 5</span>
|
|
241
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">use_active_instance</span> = <span class="ruby-keyword">false</span>)
|
|
242
|
+
<span class="ruby-ivar">@con</span> = <span class="ruby-constant">JavaExcelcom</span><span class="ruby-operator">::</span><span class="ruby-constant">ExcelConnection</span><span class="ruby-operator">::</span><span class="ruby-identifier">connect</span>(<span class="ruby-identifier">use_active_instance</span>)
|
|
243
|
+
<span class="ruby-keyword">end</span></pre>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</div>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<div id="method-c-uninitialize_com" class="method-detail ">
|
|
255
|
+
|
|
256
|
+
<div class="method-heading">
|
|
257
|
+
<span class="method-name">uninitialize_com</span><span
|
|
258
|
+
class="method-args">()</span>
|
|
259
|
+
|
|
260
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
261
|
+
|
|
262
|
+
</div>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<div class="method-description">
|
|
266
|
+
|
|
267
|
+
<p>uninitializes com manually, not recommended! should happen automatically
|
|
268
|
+
when <code>ExcelConnection#quit</code> is called.</p>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<div class="method-source-code" id="uninitialize_com-source">
|
|
274
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 28</span>
|
|
275
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">uninitialize_com</span>
|
|
276
|
+
<span class="ruby-constant">JavaExcelcom</span><span class="ruby-operator">::</span><span class="ruby-constant">ExcelConnection</span><span class="ruby-operator">::</span><span class="ruby-identifier">uninitialize_com</span>
|
|
277
|
+
<span class="ruby-keyword">end</span></pre>
|
|
278
|
+
</div>
|
|
279
|
+
|
|
280
|
+
</div>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
</section>
|
|
289
|
+
|
|
290
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
291
|
+
<header>
|
|
292
|
+
<h3>Public Instance Methods</h3>
|
|
293
|
+
</header>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<div id="method-i-active_workbook" class="method-detail ">
|
|
297
|
+
|
|
298
|
+
<div class="method-heading">
|
|
299
|
+
<span class="method-name">active_workbook</span><span
|
|
300
|
+
class="method-args">()</span>
|
|
301
|
+
|
|
302
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
303
|
+
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<div class="method-description">
|
|
308
|
+
|
|
309
|
+
<p>gets the active workbook</p>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<div class="method-source-code" id="active_workbook-source">
|
|
315
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 56</span>
|
|
316
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">active_workbook</span>
|
|
317
|
+
<span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">getActiveWorkbook</span>)
|
|
318
|
+
<span class="ruby-keyword">end</span></pre>
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<div class="aliases">
|
|
325
|
+
Also aliased as: <a href="ExcelConnection.html#method-i-getActiveWorkbook">getActiveWorkbook</a>
|
|
326
|
+
</div>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<div id="method-i-display_alerts-3D" class="method-detail ">
|
|
334
|
+
|
|
335
|
+
<div class="method-heading">
|
|
336
|
+
<span class="method-name">display_alerts=</span><span
|
|
337
|
+
class="method-args">(da)</span>
|
|
338
|
+
|
|
339
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
340
|
+
|
|
341
|
+
</div>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<div class="method-description">
|
|
345
|
+
|
|
346
|
+
<p>whether dialog boxes should show up or not (e.g. when saving and
|
|
347
|
+
overwriting a file)</p>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<div class="method-source-code" id="display_alerts-3D-source">
|
|
353
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 39</span>
|
|
354
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">display_alerts=</span>(<span class="ruby-identifier">da</span>)
|
|
355
|
+
<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">setDisplayAlerts</span>(<span class="ruby-identifier">da</span>)
|
|
356
|
+
<span class="ruby-keyword">end</span></pre>
|
|
357
|
+
</div>
|
|
358
|
+
|
|
359
|
+
</div>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
<div class="aliases">
|
|
363
|
+
Also aliased as: <a href="ExcelConnection.html#method-i-setDisplayAlerts">setDisplayAlerts</a>
|
|
364
|
+
</div>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</div>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
<div id="method-i-getActiveWorkbook" class="method-detail method-alias">
|
|
372
|
+
|
|
373
|
+
<div class="method-heading">
|
|
374
|
+
<span class="method-name">getActiveWorkbook</span><span
|
|
375
|
+
class="method-args">()</span>
|
|
376
|
+
|
|
377
|
+
</div>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<div class="method-description">
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
</div>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<div class="aliases">
|
|
393
|
+
Alias for: <a href="ExcelConnection.html#method-i-active_workbook">active_workbook</a>
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<div id="method-i-getVersion" class="method-detail method-alias">
|
|
400
|
+
|
|
401
|
+
<div class="method-heading">
|
|
402
|
+
<span class="method-name">getVersion</span><span
|
|
403
|
+
class="method-args">()</span>
|
|
404
|
+
|
|
405
|
+
</div>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<div class="method-description">
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
</div>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<div class="aliases">
|
|
421
|
+
Alias for: <a href="ExcelConnection.html#method-i-version">version</a>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
<div id="method-i-openWorkbook" class="method-detail method-alias">
|
|
428
|
+
|
|
429
|
+
<div class="method-heading">
|
|
430
|
+
<span class="method-name">openWorkbook</span><span
|
|
431
|
+
class="method-args">(file)</span>
|
|
432
|
+
|
|
433
|
+
</div>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<div class="method-description">
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
</div>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<div class="aliases">
|
|
449
|
+
Alias for: <a href="ExcelConnection.html#method-i-workbook">workbook</a>
|
|
450
|
+
</div>
|
|
451
|
+
|
|
452
|
+
</div>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
<div id="method-i-open_workbook" class="method-detail method-alias">
|
|
456
|
+
|
|
457
|
+
<div class="method-heading">
|
|
458
|
+
<span class="method-name">open_workbook</span><span
|
|
459
|
+
class="method-args">(file)</span>
|
|
460
|
+
|
|
461
|
+
</div>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<div class="method-description">
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<div class="aliases">
|
|
477
|
+
Alias for: <a href="ExcelConnection.html#method-i-workbook">workbook</a>
|
|
478
|
+
</div>
|
|
479
|
+
|
|
480
|
+
</div>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<div id="method-i-quit" class="method-detail ">
|
|
484
|
+
|
|
485
|
+
<div class="method-heading">
|
|
486
|
+
<span class="method-name">quit</span><span
|
|
487
|
+
class="method-args">()</span>
|
|
488
|
+
|
|
489
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
490
|
+
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<div class="method-description">
|
|
495
|
+
|
|
496
|
+
<p>quits the excel instance and uninitializes com</p>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
<div class="method-source-code" id="quit-source">
|
|
502
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 51</span>
|
|
503
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">quit</span>
|
|
504
|
+
<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">quit</span>
|
|
505
|
+
<span class="ruby-keyword">end</span></pre>
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
</div>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
</div>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<div id="method-i-setDisplayAlerts" class="method-detail method-alias">
|
|
517
|
+
|
|
518
|
+
<div class="method-heading">
|
|
519
|
+
<span class="method-name">setDisplayAlerts</span><span
|
|
520
|
+
class="method-args">(da)</span>
|
|
521
|
+
|
|
522
|
+
</div>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div class="method-description">
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
</div>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<div class="aliases">
|
|
538
|
+
Alias for: <a href="ExcelConnection.html#method-i-display_alerts-3D">display_alerts=</a>
|
|
539
|
+
</div>
|
|
540
|
+
|
|
541
|
+
</div>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<div id="method-i-setVisible" class="method-detail method-alias">
|
|
545
|
+
|
|
546
|
+
<div class="method-heading">
|
|
547
|
+
<span class="method-name">setVisible</span><span
|
|
548
|
+
class="method-args">(v)</span>
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<div class="method-description">
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
<div class="aliases">
|
|
566
|
+
Alias for: <a href="ExcelConnection.html#method-i-visible-3D">visible=</a>
|
|
567
|
+
</div>
|
|
568
|
+
|
|
569
|
+
</div>
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
<div id="method-i-version" class="method-detail ">
|
|
573
|
+
|
|
574
|
+
<div class="method-heading">
|
|
575
|
+
<span class="method-name">version</span><span
|
|
576
|
+
class="method-args">()</span>
|
|
577
|
+
|
|
578
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
579
|
+
|
|
580
|
+
</div>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
<div class="method-description">
|
|
584
|
+
|
|
585
|
+
<p>gets excel version</p>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
<div class="method-source-code" id="version-source">
|
|
591
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 45</span>
|
|
592
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">version</span>
|
|
593
|
+
<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">getVersion</span>
|
|
594
|
+
<span class="ruby-keyword">end</span></pre>
|
|
595
|
+
</div>
|
|
596
|
+
|
|
597
|
+
</div>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<div class="aliases">
|
|
601
|
+
Also aliased as: <a href="ExcelConnection.html#method-i-getVersion">getVersion</a>
|
|
602
|
+
</div>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</div>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
<div id="method-i-visible-3D" class="method-detail ">
|
|
610
|
+
|
|
611
|
+
<div class="method-heading">
|
|
612
|
+
<span class="method-name">visible=</span><span
|
|
613
|
+
class="method-args">(v)</span>
|
|
614
|
+
|
|
615
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
616
|
+
|
|
617
|
+
</div>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<div class="method-description">
|
|
621
|
+
|
|
622
|
+
<p>whether the excel instance should be visible or not</p>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<div class="method-source-code" id="visible-3D-source">
|
|
628
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 33</span>
|
|
629
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">visible=</span>(<span class="ruby-identifier">v</span>)
|
|
630
|
+
<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">setVisible</span> <span class="ruby-identifier">v</span>
|
|
631
|
+
<span class="ruby-keyword">end</span></pre>
|
|
632
|
+
</div>
|
|
633
|
+
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<div class="aliases">
|
|
638
|
+
Also aliased as: <a href="ExcelConnection.html#method-i-setVisible">setVisible</a>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
<div id="method-i-workbook" class="method-detail ">
|
|
647
|
+
|
|
648
|
+
<div class="method-heading">
|
|
649
|
+
<span class="method-name">workbook</span><span
|
|
650
|
+
class="method-args">(file) { |wb| ... }</span>
|
|
651
|
+
|
|
652
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
653
|
+
|
|
654
|
+
</div>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<div class="method-description">
|
|
658
|
+
|
|
659
|
+
<p>opens a workbook. Optional block possible where workbook gets closed on
|
|
660
|
+
blocks end, e.g. <code>con.workbook{|wb| puts wb.name }</code></p>
|
|
661
|
+
<dl class="rdoc-list note-list"><dt><code>file</code>
|
|
662
|
+
<dd>
|
|
663
|
+
<p>workbook to be opened. Can be a string or a file object</p>
|
|
664
|
+
</dd></dl>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
<div class="method-source-code" id="workbook-source">
|
|
670
|
+
<pre><span class="ruby-comment"># File lib/jruby_excelcom/excel_connection.rb, line 64</span>
|
|
671
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">workbook</span>(<span class="ruby-identifier">file</span>)
|
|
672
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
|
|
673
|
+
<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">openWorkbook</span>(<span class="ruby-identifier">java</span>.<span class="ruby-identifier">io</span>.<span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">file</span>)))
|
|
674
|
+
<span class="ruby-keyword">else</span>
|
|
675
|
+
<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@con</span>.<span class="ruby-identifier">openWorkbook</span>(<span class="ruby-identifier">java</span>.<span class="ruby-identifier">io</span>.<span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">file</span>.<span class="ruby-identifier">path</span>)))
|
|
676
|
+
<span class="ruby-keyword">end</span>
|
|
677
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
|
678
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">wb</span>)
|
|
679
|
+
<span class="ruby-identifier">wb</span>.<span class="ruby-identifier">close</span>
|
|
680
|
+
<span class="ruby-keyword">else</span>
|
|
681
|
+
<span class="ruby-identifier">wb</span>
|
|
682
|
+
<span class="ruby-keyword">end</span>
|
|
683
|
+
<span class="ruby-keyword">end</span></pre>
|
|
684
|
+
</div>
|
|
685
|
+
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
<div class="aliases">
|
|
690
|
+
Also aliased as: <a href="ExcelConnection.html#method-i-openWorkbook">openWorkbook</a>, <a href="ExcelConnection.html#method-i-open_workbook">open_workbook</a>
|
|
691
|
+
</div>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
</div>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
</section>
|
|
699
|
+
|
|
700
|
+
</section>
|
|
701
|
+
</main>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<footer id="validator-badges" role="contentinfo">
|
|
705
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
706
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
707
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
708
|
+
</footer>
|
|
709
|
+
|