1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_02) on Thu May 29 21:39:20 BST 2008 -->
<TITLE>
Workbook
</TITLE>
<META NAME="keywords" CONTENT="jxl.Workbook class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Workbook";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../jxl/SheetSettings.html" title="class in jxl"><B>PREV CLASS</B></A>
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="Workbook.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
jxl</FONT>
<BR>
Class Workbook</H2>
<PRE>
java.lang.Object
<IMG SRC="../resources/inherit.gif" ALT="extended by"><B>jxl.Workbook</B>
</PRE>
<HR>
<DL>
<DT>public abstract class <B>Workbook</B><DT>extends java.lang.Object</DL>
<P>
Represents a Workbook. Contains the various factory methods and provides
a variety of accessors which provide access to the work sheets.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#close()">close</A></B>()</CODE>
<BR>
Closes this workbook, and frees makes any memory allocated available
for garbage collection</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.File)">createWorkbook</A></B>(java.io.File file)</CODE>
<BR>
Creates a writable workbook with the given file name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.File, jxl.Workbook)">createWorkbook</A></B>(java.io.File file,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in)</CODE>
<BR>
Creates a writable workbook with the given filename as a copy of
the workbook passed in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.File, jxl.WorkbookSettings)">createWorkbook</A></B>(java.io.File file,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
Creates a writable workbook with the given file name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.File, jxl.Workbook, jxl.WorkbookSettings)">createWorkbook</A></B>(java.io.File file,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
Creates a writable workbook with the given filename as a copy of
the workbook passed in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.OutputStream)">createWorkbook</A></B>(java.io.OutputStream os)</CODE>
<BR>
Creates a writable workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.OutputStream, jxl.Workbook)">createWorkbook</A></B>(java.io.OutputStream os,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in)</CODE>
<BR>
Creates a writable workbook as a copy of
the workbook passed in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.OutputStream, jxl.WorkbookSettings)">createWorkbook</A></B>(java.io.OutputStream os,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
Creates a writable workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#createWorkbook(java.io.OutputStream, jxl.Workbook, jxl.WorkbookSettings)">createWorkbook</A></B>(java.io.OutputStream os,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
Creates a writable workbook as a copy of
the workbook passed in.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Range.html" title="interface in jxl">Range</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#findByName(java.lang.String)">findByName</A></B>(java.lang.String name)</CODE>
<BR>
Gets the named range from this workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Cell.html" title="interface in jxl">Cell</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#findCellByName(java.lang.String)">findCellByName</A></B>(java.lang.String name)</CODE>
<BR>
Gets the named cell from this workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Cell.html" title="interface in jxl">Cell</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getCell(java.lang.String)">getCell</A></B>(java.lang.String loc)</CODE>
<BR>
Returns the cell for the specified location eg.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getNumberOfSheets()">getNumberOfSheets</A></B>()</CODE>
<BR>
Returns the number of sheets in this workbook</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getRangeNames()">getRangeNames</A></B>()</CODE>
<BR>
Gets the named ranges</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getSheet(int)">getSheet</A></B>(int index)</CODE>
<BR>
Gets the specified sheet within this workbook
As described in the accompanying technical notes, each call
to getSheet forces a reread of the sheet (for memory reasons).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getSheet(java.lang.String)">getSheet</A></B>(java.lang.String name)</CODE>
<BR>
Gets the sheet with the specified name from within this workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getSheetNames()">getSheetNames</A></B>()</CODE>
<BR>
Gets the sheet names</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getSheets()">getSheets</A></B>()</CODE>
<BR>
Gets the sheets within this workbook.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getVersion()">getVersion</A></B>()</CODE>
<BR>
Accessor for the software version</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getWorkbook(java.io.File)">getWorkbook</A></B>(java.io.File file)</CODE>
<BR>
A factory method which takes in an excel file and reads in the contents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getWorkbook(java.io.File, jxl.WorkbookSettings)">getWorkbook</A></B>(java.io.File file,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
A factory method which takes in an excel file and reads in the contents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getWorkbook(java.io.InputStream)">getWorkbook</A></B>(java.io.InputStream is)</CODE>
<BR>
A factory method which takes in an excel file and reads in the contents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#getWorkbook(java.io.InputStream, jxl.WorkbookSettings)">getWorkbook</A></B>(java.io.InputStream is,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)</CODE>
<BR>
A factory method which takes in an excel file and reads in the contents.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../jxl/Workbook.html#isProtected()">isProtected</A></B>()</CODE>
<BR>
Determines whether the sheet is protected</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getSheets()"><!-- --></A><H3>
getSheets</H3>
<PRE>
public abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A>[] <B>getSheets</B>()</PRE>
<DL>
<DD>Gets the sheets within this workbook. Use of this method for
large worksheets can cause performance problems.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array of the individual sheets</DL>
</DD>
</DL>
<HR>
<A NAME="getSheetNames()"><!-- --></A><H3>
getSheetNames</H3>
<PRE>
public abstract java.lang.String[] <B>getSheetNames</B>()</PRE>
<DL>
<DD>Gets the sheet names
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an array of strings containing the sheet names</DL>
</DD>
</DL>
<HR>
<A NAME="getSheet(int)"><!-- --></A><H3>
getSheet</H3>
<PRE>
public abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A> <B>getSheet</B>(int index)
throws java.lang.IndexOutOfBoundsException</PRE>
<DL>
<DD>Gets the specified sheet within this workbook
As described in the accompanying technical notes, each call
to getSheet forces a reread of the sheet (for memory reasons).
Therefore, do not make unnecessary calls to this method. Furthermore,
do not hold unnecessary references to Sheets in client code, as
this will prevent the garbage collector from freeing the memory
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the zero based index of the reQuired sheet
<DT><B>Returns:</B><DD>The sheet specified by the index
<DT><B>Throws:</B>
<DD><CODE>IndexOutOfBoundException</CODE> - when index refers to a non-existent
sheet
<DD><CODE>java.lang.IndexOutOfBoundsException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getSheet(java.lang.String)"><!-- --></A><H3>
getSheet</H3>
<PRE>
public abstract <A HREF="../jxl/Sheet.html" title="interface in jxl">Sheet</A> <B>getSheet</B>(java.lang.String name)</PRE>
<DL>
<DD>Gets the sheet with the specified name from within this workbook.
As described in the accompanying technical notes, each call
to getSheet forces a reread of the sheet (for memory reasons).
Therefore, do not make unnecessary calls to this method. Furthermore,
do not hold unnecessary references to Sheets in client code, as
this will prevent the garbage collector from freeing the memory
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the sheet name
<DT><B>Returns:</B><DD>The sheet with the specified name, or null if it is not found</DL>
</DD>
</DL>
<HR>
<A NAME="getVersion()"><!-- --></A><H3>
getVersion</H3>
<PRE>
public static java.lang.String <B>getVersion</B>()</PRE>
<DL>
<DD>Accessor for the software version
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the version</DL>
</DD>
</DL>
<HR>
<A NAME="getNumberOfSheets()"><!-- --></A><H3>
getNumberOfSheets</H3>
<PRE>
public abstract int <B>getNumberOfSheets</B>()</PRE>
<DL>
<DD>Returns the number of sheets in this workbook
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the number of sheets in this workbook</DL>
</DD>
</DL>
<HR>
<A NAME="findCellByName(java.lang.String)"><!-- --></A><H3>
findCellByName</H3>
<PRE>
public abstract <A HREF="../jxl/Cell.html" title="interface in jxl">Cell</A> <B>findCellByName</B>(java.lang.String name)</PRE>
<DL>
<DD>Gets the named cell from this workbook. If the name refers to a
range of cells, then the cell on the top left is returned. If
the name cannot be found, null is returned.
This is a convenience function to quickly access the contents
of a single cell. If you need further information (such as the
sheet or adjacent cells in the range) use the functionally
richer method, findByName which returns a list of ranges
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cell/range to search for
<DT><B>Returns:</B><DD>the cell in the top left of the range if found, NULL
otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="getCell(java.lang.String)"><!-- --></A><H3>
getCell</H3>
<PRE>
public abstract <A HREF="../jxl/Cell.html" title="interface in jxl">Cell</A> <B>getCell</B>(java.lang.String loc)</PRE>
<DL>
<DD>Returns the cell for the specified location eg. "Sheet1!A4".
This is identical to using the CellReferenceHelper with its
associated performance overheads, consequently it should
be use sparingly
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>loc</CODE> - the cell to retrieve
<DT><B>Returns:</B><DD>the cell at the specified location</DL>
</DD>
</DL>
<HR>
<A NAME="findByName(java.lang.String)"><!-- --></A><H3>
findByName</H3>
<PRE>
public abstract <A HREF="../jxl/Range.html" title="interface in jxl">Range</A>[] <B>findByName</B>(java.lang.String name)</PRE>
<DL>
<DD>Gets the named range from this workbook. The Range object returns
contains all the cells from the top left to the bottom right
of the range.
If the named range comprises an adjacent range,
the Range[] will contain one object; for non-adjacent
ranges, it is necessary to return an array of length greater than
one.
If the named range contains a single cell, the top left and
bottom right cell will be the same cell
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the cell/range to search for
<DT><B>Returns:</B><DD>the range of cells, or NULL if the range does not exist</DL>
</DD>
</DL>
<HR>
<A NAME="getRangeNames()"><!-- --></A><H3>
getRangeNames</H3>
<PRE>
public abstract java.lang.String[] <B>getRangeNames</B>()</PRE>
<DL>
<DD>Gets the named ranges
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the list of named cells within the workbook</DL>
</DD>
</DL>
<HR>
<A NAME="isProtected()"><!-- --></A><H3>
isProtected</H3>
<PRE>
public abstract boolean <B>isProtected</B>()</PRE>
<DL>
<DD>Determines whether the sheet is protected
<P>
<DD><DL>
<DT><B>Returns:</B><DD>TRUE if the workbook is protected, FALSE otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public abstract void <B>close</B>()</PRE>
<DL>
<DD>Closes this workbook, and frees makes any memory allocated available
for garbage collection
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWorkbook(java.io.File)"><!-- --></A><H3>
getWorkbook</H3>
<PRE>
public static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> <B>getWorkbook</B>(java.io.File file)
throws java.io.IOException,
jxl.read.biff.BiffException</PRE>
<DL>
<DD>A factory method which takes in an excel file and reads in the contents.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the excel 97 spreadsheet to parse
<DT><B>Returns:</B><DD>a workbook instance
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>jxl.read.biff.BiffException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getWorkbook(java.io.File, jxl.WorkbookSettings)"><!-- --></A><H3>
getWorkbook</H3>
<PRE>
public static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> <B>getWorkbook</B>(java.io.File file,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException,
jxl.read.biff.BiffException</PRE>
<DL>
<DD>A factory method which takes in an excel file and reads in the contents.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the excel 97 spreadsheet to parse<DD><CODE>ws</CODE> - the settings for the workbook
<DT><B>Returns:</B><DD>a workbook instance
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>jxl.read.biff.BiffException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getWorkbook(java.io.InputStream)"><!-- --></A><H3>
getWorkbook</H3>
<PRE>
public static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> <B>getWorkbook</B>(java.io.InputStream is)
throws java.io.IOException,
jxl.read.biff.BiffException</PRE>
<DL>
<DD>A factory method which takes in an excel file and reads in the contents.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - an open stream which is the the excel 97 spreadsheet to parse
<DT><B>Returns:</B><DD>a workbook instance
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>jxl.read.biff.BiffException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getWorkbook(java.io.InputStream, jxl.WorkbookSettings)"><!-- --></A><H3>
getWorkbook</H3>
<PRE>
public static <A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> <B>getWorkbook</B>(java.io.InputStream is,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException,
jxl.read.biff.BiffException</PRE>
<DL>
<DD>A factory method which takes in an excel file and reads in the contents.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>is</CODE> - an open stream which is the the excel 97 spreadsheet to parse<DD><CODE>ws</CODE> - the settings for the workbook
<DT><B>Returns:</B><DD>a workbook instance
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE>
<DD><CODE>jxl.read.biff.BiffException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.File)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.File file)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook with the given file name
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the workbook to copy
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.File, jxl.WorkbookSettings)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.File file,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook with the given file name
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to copy from<DD><CODE>ws</CODE> - the global workbook settings
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.File, jxl.Workbook)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.File file,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook with the given filename as a copy of
the workbook passed in. Once created, the contents of the writable
workbook may be modified
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the output file for the copy<DD><CODE>in</CODE> - the workbook to copy
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.File, jxl.Workbook, jxl.WorkbookSettings)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.File file,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook with the given filename as a copy of
the workbook passed in. Once created, the contents of the writable
workbook may be modified
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the output file for the copy<DD><CODE>in</CODE> - the workbook to copy<DD><CODE>ws</CODE> - the configuration for this workbook
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.OutputStream, jxl.Workbook)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.OutputStream os,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook as a copy of
the workbook passed in. Once created, the contents of the writable
workbook may be modified
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>os</CODE> - the stream to write to<DD><CODE>in</CODE> - the workbook to copy
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.OutputStream, jxl.Workbook, jxl.WorkbookSettings)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.OutputStream os,
<A HREF="../jxl/Workbook.html" title="class in jxl">Workbook</A> in,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook as a copy of
the workbook passed in. Once created, the contents of the writable
workbook may be modified
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>os</CODE> - the output stream to write to<DD><CODE>in</CODE> - the workbook to copy<DD><CODE>ws</CODE> - the configuration for this workbook
<DT><B>Returns:</B><DD>a writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.OutputStream)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.OutputStream os)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook. When the workbook is closed,
it will be streamed directly to the output stream. In this
manner, a generated excel spreadsheet can be passed from
a servlet to the browser over HTTP
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>os</CODE> - the output stream
<DT><B>Returns:</B><DD>the writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createWorkbook(java.io.OutputStream, jxl.WorkbookSettings)"><!-- --></A><H3>
createWorkbook</H3>
<PRE>
public static <A HREF="../jxl/write/WritableWorkbook.html" title="class in jxl.write">WritableWorkbook</A> <B>createWorkbook</B>(java.io.OutputStream os,
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl">WorkbookSettings</A> ws)
throws java.io.IOException</PRE>
<DL>
<DD>Creates a writable workbook. When the workbook is closed,
it will be streamed directly to the output stream. In this
manner, a generated excel spreadsheet can be passed from
a servlet to the browser over HTTP
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>os</CODE> - the output stream<DD><CODE>ws</CODE> - the configuration for this workbook
<DT><B>Returns:</B><DD>the writable workbook
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../jxl/SheetSettings.html" title="class in jxl"><B>PREV CLASS</B></A>
<A HREF="../jxl/WorkbookSettings.html" title="class in jxl"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="Workbook.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
