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
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.hssf.usermodel;
import java.util.List;
import org.apache.poi.hssf.model.InternalWorkbook;
import org.apache.poi.hssf.record.ExtendedFormatRecord;
import org.apache.poi.hssf.record.FontRecord;
import org.apache.poi.hssf.record.FormatRecord;
import org.apache.poi.hssf.record.StyleRecord;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.hssf.util.HSSFColor.HSSFColorPredefined;
import org.apache.poi.ss.usermodel.BorderStyle;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.FillPatternType;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.VerticalAlignment;
/**
* High level representation of the style of a cell in a sheet of a workbook.
*
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createCellStyle()
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getCellStyleAt(int)
* @see org.apache.poi.hssf.usermodel.HSSFCell#setCellStyle(HSSFCellStyle)
*/
public final class HSSFCellStyle implements CellStyle {
private final ExtendedFormatRecord _format;
private final short _index;
private final InternalWorkbook _workbook;
/** Creates new HSSFCellStyle why would you want to do this?? */
protected HSSFCellStyle(short index, ExtendedFormatRecord rec, HSSFWorkbook workbook)
{
this(index, rec, workbook.getWorkbook());
}
protected HSSFCellStyle(short index, ExtendedFormatRecord rec, InternalWorkbook workbook)
{
_workbook = workbook;
_index = index;
_format = rec;
}
/**
* get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
* @return unique index number of the underlying record this style represents (probably you don't care
* unless you're comparing which one is which)
*/
@Override
public short getIndex() {
return _index;
}
/**
* Return the parent style for this cell style.
* In most cases this will be null, but in a few
* cases there'll be a fully defined parent.
*/
public HSSFCellStyle getParentStyle() {
short parentIndex = _format.getParentIndex();
// parentIndex equal 0xFFF indicates no inheritance from a cell style XF (See 2.4.353 XF)
if(parentIndex == 0 || parentIndex == 0xFFF) {
return null;
}
return new HSSFCellStyle(
parentIndex,
_workbook.getExFormatAt(parentIndex),
_workbook
);
}
/**
* set the data format (must be a valid format)
* @see org.apache.poi.hssf.usermodel.HSSFDataFormat
*/
@Override
public void setDataFormat(short fmt)
{
_format.setFormatIndex(fmt);
}
/**
* get the index of the format
* @see org.apache.poi.hssf.usermodel.HSSFDataFormat
*/
@Override
public short getDataFormat()
{
return _format.getFormatIndex();
}
// we keep the cached data in ThreadLocal members in order to
// avoid multi-threading issues when different workbooks are accessed in
// multiple threads at the same time
private static final ThreadLocal<Short> lastDateFormat = new ThreadLocal<Short>() {
@Override
protected Short initialValue() {
return Short.MIN_VALUE;
}
};
private static final ThreadLocal<List<FormatRecord>> lastFormats = new ThreadLocal<>();
private static final ThreadLocal<String> getDataFormatStringCache = new ThreadLocal<>();
/**
* Get the contents of the format string, by looking up
* the DataFormat against the bound workbook
* @see org.apache.poi.hssf.usermodel.HSSFDataFormat
* @return the format string or "General" if not found
*/
@Override
public String getDataFormatString() {
if (getDataFormatStringCache.get() != null) {
if (lastDateFormat.get() == getDataFormat() && _workbook.getFormats().equals(lastFormats.get())) {
return getDataFormatStringCache.get();
}
}
lastFormats.set(_workbook.getFormats());
lastDateFormat.set(getDataFormat());
getDataFormatStringCache.set(getDataFormatString(_workbook));
return getDataFormatStringCache.get();
}
/**
* Get the contents of the format string, by looking up
* the DataFormat against the supplied workbook
* @see org.apache.poi.hssf.usermodel.HSSFDataFormat
*
* @return the format string or "General" if not found
*/
public String getDataFormatString(org.apache.poi.ss.usermodel.Workbook workbook) {
HSSFDataFormat format = new HSSFDataFormat( ((HSSFWorkbook)workbook).getWorkbook() );
int idx = getDataFormat();
return idx == -1 ? "General" : format.getFormat(getDataFormat());
}
/**
* Get the contents of the format string, by looking up
* the DataFormat against the supplied low level workbook
* @see org.apache.poi.hssf.usermodel.HSSFDataFormat
*/
public String getDataFormatString(org.apache.poi.hssf.model.InternalWorkbook workbook) {
HSSFDataFormat format = new HSSFDataFormat( workbook );
return format.getFormat(getDataFormat());
}
/**
* set the font for this style
* @param font a font object created or retrieved from the HSSFWorkbook object
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createFont()
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(int)
*/
@Override
public void setFont(Font font) {
setFont((HSSFFont)font);
}
public void setFont(HSSFFont font) {
_format.setIndentNotParentFont(true);
short fontindex = font.getIndex();
_format.setFontIndex(fontindex);
}
/**
* gets the index of the font for this style
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(short)
*/
@Override
@Deprecated
public short getFontIndex()
{
return _format.getFontIndex();
}
/**
* gets the index of the font for this style
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(int)
* @since 4.0.0
*/
@Override
public int getFontIndexAsInt()
{
return _format.getFontIndex();
}
/**
* gets the font for this style
* @param parentWorkbook The HSSFWorkbook that this style belongs to
* @see org.apache.poi.hssf.usermodel.HSSFCellStyle#getFontIndexAsInt()
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(int)
*/
public HSSFFont getFont(org.apache.poi.ss.usermodel.Workbook parentWorkbook) {
return ((HSSFWorkbook) parentWorkbook).getFontAt(getFontIndexAsInt());
}
/**
* set the cell's using this style to be hidden
* @param hidden - whether the cell using this style should be hidden
*/
@Override
public void setHidden(boolean hidden)
{
_format.setIndentNotParentCellOptions(true);
_format.setHidden(hidden);
}
/**
* get whether the cell's using this style are to be hidden
* @return hidden - whether the cell using this style should be hidden
*/
@Override
public boolean getHidden()
{
return _format.isHidden();
}
/**
* set the cell's using this style to be locked
* @param locked - whether the cell using this style should be locked
*/
@Override
public void setLocked(boolean locked)
{
_format.setIndentNotParentCellOptions(true);
_format.setLocked(locked);
}
/**
* get whether the cell's using this style are to be locked
* @return hidden - whether the cell using this style should be locked
*/
@Override
public boolean getLocked()
{
return _format.isLocked();
}
/**
* Turn on or off "Quote Prefix" or "123 Prefix" for the style,
* which is used to tell Excel that the thing which looks like
* a number or a formula shouldn't be treated as on.
*/
@Override
public void setQuotePrefixed(boolean quotePrefix) {
_format.set123Prefix(quotePrefix);
}
/**
* Is "Quote Prefix" or "123 Prefix" enabled for the cell?
*/
@Override
public boolean getQuotePrefixed() {
return _format.get123Prefix();
}
/**
* set the type of horizontal alignment for the cell
* @param align - the type of alignment
*/
@Override
public void setAlignment(HorizontalAlignment align)
{
_format.setIndentNotParentAlignment(true);
_format.setAlignment(align.getCode());
}
@Override
public HorizontalAlignment getAlignment()
{
return HorizontalAlignment.forInt(_format.getAlignment());
}
@Override
public HorizontalAlignment getAlignmentEnum()
{
return getAlignment();
}
/**
* set whether the text should be wrapped
* @param wrapped wrap text or not
*/
@Override
public void setWrapText(boolean wrapped)
{
_format.setIndentNotParentAlignment(true);
_format.setWrapText(wrapped);
}
/**
* get whether the text should be wrapped
* @return wrap text or not
*/
@Override
public boolean getWrapText()
{
return _format.getWrapText();
}
/**
* set the type of vertical alignment for the cell
* @param align the type of alignment
*/
@Override
public void setVerticalAlignment(VerticalAlignment align)
{
_format.setVerticalAlignment(align.getCode());
}
@Override
public VerticalAlignment getVerticalAlignment() {
return VerticalAlignment.forInt(_format.getVerticalAlignment());
}
@Override
public VerticalAlignment getVerticalAlignmentEnum() {
return getVerticalAlignment();
}
/**
* set the degree of rotation for the text in the cell
*
* Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
* uses values from 0 to 180 degrees. The implementations of this method will map between these two value-ranges
* accordingly, however the corresponding getter is returning values in the range mandated by the current type
* of Excel file-format that this CellStyle is applied to.
*
* @param rotation degrees (between -90 and 90 degrees, of 0xff for vertical)
*/
@Override
public void setRotation(short rotation)
{
if (rotation == 0xff) {
// Special cases for vertically aligned text
}
else if ((rotation < 0)&&(rotation >= -90)) {
//Take care of the funny 4th quadrant issue
//The 4th quadrant (-1 to -90) is stored as (91 to 180)
rotation = (short)(90 - rotation);
}
else if (rotation > 90 && rotation <= 180) {
// stay compatible with the range used by XSSF, map from ]90..180] to ]0..-90]
// we actually don't need to do anything here as the internal value is stored in [0-180] anyway!
}
else if ((rotation < -90) || (rotation > 90)) {
//Do not allow an incorrect rotation to be set
throw new IllegalArgumentException("The rotation must be between -90 and 90 degrees, or 0xff");
}
_format.setRotation(rotation);
}
/**
* get the degree of rotation for the text in the cell
* @return rotation degrees (between -90 and 90 degrees, or 0xff for vertical)
*/
@Override
public short getRotation()
{
short rotation = _format.getRotation();
if (rotation == 0xff) {
// Vertical aligned special case
return rotation;
}
if (rotation > 90) {
//This is actually the 4th quadrant
rotation = (short)(90-rotation);
}
return rotation;
}
/**
* set the number of spaces to indent the text in the cell
* @param indent - number of spaces
*/
@Override
public void setIndention(short indent)
{
_format.setIndent(indent);
}
/**
* get the number of spaces to indent the text in the cell
* @return indent - number of spaces
*/
@Override
public short getIndention()
{
return _format.getIndent();
}
/**
* set the type of border to use for the left border of the cell
* @param border type
* @since POI 3.15
*/
@Override
public void setBorderLeft(BorderStyle border)
{
_format.setIndentNotParentBorder(true);
_format.setBorderLeft(border.getCode());
}
@Override
public BorderStyle getBorderLeft()
{
return BorderStyle.valueOf(_format.getBorderLeft());
}
@Override
public BorderStyle getBorderLeftEnum() { return getBorderLeft(); }
/**
* set the type of border to use for the right border of the cell
* @param border type
* @since POI 3.15
*/
@Override
public void setBorderRight(BorderStyle border)
{
_format.setIndentNotParentBorder(true);
_format.setBorderRight(border.getCode());
}
@Override
public BorderStyle getBorderRight()
{
return BorderStyle.valueOf(_format.getBorderRight());
}
@Override
public BorderStyle getBorderRightEnum() { return getBorderRight(); }
/**
* set the type of border to use for the top border of the cell
* @param border type
* @since POI 3.15
*/
@Override
public void setBorderTop(BorderStyle border)
{
_format.setIndentNotParentBorder(true);
_format.setBorderTop(border.getCode());
}
@Override
public BorderStyle getBorderTop()
{
return BorderStyle.valueOf(_format.getBorderTop());
}
@Override
public BorderStyle getBorderTopEnum() { return getBorderTop(); }
/**
* set the type of border to use for the bottom border of the cell
* @param border type
* @since 3.15 beta 2
*/
@Override
public void setBorderBottom(BorderStyle border)
{
_format.setIndentNotParentBorder(true);
_format.setBorderBottom(border.getCode());
}
@Override
public BorderStyle getBorderBottom()
{
return BorderStyle.valueOf(_format.getBorderBottom());
}
@Override
public BorderStyle getBorderBottomEnum() { return getBorderBottom(); }
/**
* set the color to use for the left border
* @param color The index of the color definition
*/
@Override
public void setLeftBorderColor(short color)
{
_format.setLeftBorderPaletteIdx(color);
}
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return The index of the color definition
*/
@Override
public short getLeftBorderColor()
{
return _format.getLeftBorderPaletteIdx();
}
/**
* set the color to use for the right border
* @param color The index of the color definition
*/
@Override
public void setRightBorderColor(short color)
{
_format.setRightBorderPaletteIdx(color);
}
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return The index of the color definition
*/
@Override
public short getRightBorderColor()
{
return _format.getRightBorderPaletteIdx();
}
/**
* set the color to use for the top border
* @param color The index of the color definition
*/
@Override
public void setTopBorderColor(short color)
{
_format.setTopBorderPaletteIdx(color);
}
/**
* get the color to use for the top border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return The index of the color definition
*/
@Override
public short getTopBorderColor()
{
return _format.getTopBorderPaletteIdx();
}
/**
* set the color to use for the bottom border
* @param color The index of the color definition
*/
@Override
public void setBottomBorderColor(short color)
{
_format.setBottomBorderPaletteIdx(color);
}
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return The index of the color definition
*/
@Override
public short getBottomBorderColor()
{
return _format.getBottomBorderPaletteIdx();
}
/**
* setting to one fills the cell with the foreground color... No idea about
* other values
*
* @param fp fill pattern (set to {@link FillPatternType#SOLID_FOREGROUND} to fill w/foreground color)
*/
@Override
public void setFillPattern(FillPatternType fp)
{
_format.setAdtlFillPattern(fp.getCode());
}
@Override
public FillPatternType getFillPattern()
{
return FillPatternType.forInt(_format.getAdtlFillPattern());
}
@Override
public FillPatternType getFillPatternEnum() { return getFillPattern(); }
/**
* Checks if the background and foreground fills are set correctly when one
* or the other is set to the default color.
* <p>Works like the logic table below:</p>
* <p>BACKGROUND FOREGROUND</p>
* <p>NONE AUTOMATIC</p>
* <p>0x41 0x40</p>
* <p>NONE RED/ANYTHING</p>
* <p>0x40 0xSOMETHING</p>
*/
private void checkDefaultBackgroundFills() {
final short autoIdx = HSSFColorPredefined.AUTOMATIC.getIndex();
if (_format.getFillForeground() == autoIdx) {
//JMH: Why +1, hell why not. I guess it made some sense to someone at the time. Doesnt
//to me now.... But experience has shown that when the fore is set to AUTOMATIC then the
//background needs to be incremented......
if (_format.getFillBackground() != autoIdx+1) {
setFillBackgroundColor((short)(autoIdx+1));
}
} else if (_format.getFillBackground() == autoIdx+1) {
//Now if the forground changes to a non-AUTOMATIC color the background resets itself!!!
if (_format.getFillForeground() != autoIdx) {
setFillBackgroundColor(autoIdx);
}
}
}
/**
* set the background fill color.
* <p>
* For example:
* <pre>
* cs.setFillPattern(HSSFCellStyle.FINE_DOTS );
* cs.setFillBackgroundColor(new HSSFColor.RED().getIndex());
* </pre>
* optionally a Foreground and background fill can be applied:
* <i>Note: Ensure Foreground color is set prior to background</i>
* <pre>
* cs.setFillPattern(HSSFCellStyle.FINE_DOTS );
* cs.setFillForegroundColor(new HSSFColor.BLUE().getIndex());
* cs.setFillBackgroundColor(new HSSFColor.RED().getIndex());
* </pre>
* or, for the special case of SOLID_FILL:
* <pre>
* cs.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
* cs.setFillForegroundColor(new HSSFColor.RED().getIndex());
* </pre>
* It is necessary to set the fill style in order
* for the color to be shown in the cell.
*
* @param bg color
*/
@Override
public void setFillBackgroundColor(short bg)
{
_format.setFillBackground(bg);
checkDefaultBackgroundFills();
}
/**
* Get the background fill color.
* Note - many cells are actually filled with a foreground
* fill, not a background fill - see {@link #getFillForegroundColor()}
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return fill color
*/
@Override
public short getFillBackgroundColor() {
final short autoIndex = HSSFColorPredefined.AUTOMATIC.getIndex();
short result = _format.getFillBackground();
//JMH: Do this ridiculous conversion, and let HSSFCellStyle
//internally migrate back and forth
if (result == autoIndex+1) {
return autoIndex;
}
return result;
}
@Override
public HSSFColor getFillBackgroundColorColor() {
HSSFPalette pallette = new HSSFPalette(
_workbook.getCustomPalette()
);
return pallette.getColor(
getFillBackgroundColor()
);
}
/**
* set the foreground fill color
* <i>Note: Ensure Foreground color is set prior to background color.</i>
* @param bg color
*/
@Override
public void setFillForegroundColor(short bg)
{
_format.setFillForeground(bg);
checkDefaultBackgroundFills();
}
/**
* Get the foreground fill color.
* Many cells are filled with this, instead of a
* background color ({@link #getFillBackgroundColor()})
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
* @return fill color
*/
@Override
public short getFillForegroundColor()
{
return _format.getFillForeground();
}
@Override
public HSSFColor getFillForegroundColorColor() {
HSSFPalette pallette = new HSSFPalette(
_workbook.getCustomPalette()
);
return pallette.getColor(
getFillForegroundColor()
);
}
/**
* Gets the name of the user defined style.
* Returns null for built in styles, and
* styles where no name has been defined
*/
public String getUserStyleName() {
StyleRecord sr = _workbook.getStyleRecord(_index);
if(sr == null) {
return null;
}
if(sr.isBuiltin()) {
return null;
}
return sr.getName();
}
/**
* Sets the name of the user defined style.
* Will complain if you try this on a built in style.
*/
public void setUserStyleName(String styleName) {
StyleRecord sr = _workbook.getStyleRecord(_index);
if(sr == null) {
sr = _workbook.createStyleRecord(_index);
}
// All Style records start as "builtin", but generally
// only 20 and below really need to be
if(sr.isBuiltin() && _index <= 20) {
throw new IllegalArgumentException("Unable to set user specified style names for built in styles!");
}
sr.setName(styleName);
}
/**
* Controls if the Cell should be auto-sized
* to shrink to fit if the text is too long
*/
@Override
public void setShrinkToFit(boolean shrinkToFit) {
_format.setShrinkToFit(shrinkToFit);
}
/**
* Should the Cell be auto-sized by Excel to shrink
* it to fit if this text is too long?
*/
@Override
public boolean getShrinkToFit() {
return _format.getShrinkToFit();
}
/**
* Get the reading order, for RTL/LTR ordering of
* the text.
* <p>0 means Context (Default), 1 means Left To Right,
* and 2 means Right to Left</p>
*
* @return order - the reading order (0,1,2)
*/
public short getReadingOrder() {
return _format.getReadingOrder();
}
/**
* Sets the reading order, for RTL/LTR ordering of
* the text.
* <p>0 means Context (Default), 1 means Left To Right,
* and 2 means Right to Left</p>
*
* @param order - the reading order (0,1,2)
*/
public void setReadingOrder(short order) {
_format.setReadingOrder(order);
}
/**
* Verifies that this style belongs to the supplied Workbook.
* Will throw an exception if it belongs to a different one.
* This is normally called when trying to assign a style to a
* cell, to ensure the cell and the style are from the same
* workbook (if they're not, it won't work)
* @throws IllegalArgumentException if there's a workbook mis-match
*/
public void verifyBelongsToWorkbook(HSSFWorkbook wb) {
if(wb.getWorkbook() != _workbook) {
throw new IllegalArgumentException("This Style does not belong to the supplied Workbook. Are you trying to assign a style from one workbook to the cell of a differnt workbook?");
}
}
/**
* Clones all the style information from another
* HSSFCellStyle, onto this one. This
* HSSFCellStyle will then have all the same
* properties as the source, but the two may
* be edited independently.
* Any stylings on this HSSFCellStyle will be lost!
*
* The source HSSFCellStyle could be from another
* HSSFWorkbook if you like. This allows you to
* copy styles from one HSSFWorkbook to another.
*/
@Override
public void cloneStyleFrom(CellStyle source) {
if(source instanceof HSSFCellStyle) {
this.cloneStyleFrom((HSSFCellStyle)source);
} else {
throw new IllegalArgumentException("Can only clone from one HSSFCellStyle to another, not between HSSFCellStyle and XSSFCellStyle");
}
}
public void cloneStyleFrom(HSSFCellStyle source) {
// First we need to clone the extended format
// record
_format.cloneStyleFrom(source._format);
// Handle matching things if we cross workbooks
if(_workbook != source._workbook) {
lastDateFormat.set(Short.MIN_VALUE);
lastFormats.remove();
getDataFormatStringCache.remove();
// Then we need to clone the format string,
// and update the format record for this
short fmt = (short)_workbook.createFormat(source.getDataFormatString() );
setDataFormat(fmt);
// Finally we need to clone the font,
// and update the format record for this
FontRecord fr = _workbook.createNewFont();
fr.cloneStyleFrom(
source._workbook.getFontRecordAt(
source.getFontIndexAsInt()
)
);
HSSFFont font = new HSSFFont(
(short)_workbook.getFontIndex(fr), fr
);
setFont(font);
}
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((_format == null) ? 0 : _format.hashCode());
result = prime * result + _index;
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (obj instanceof HSSFCellStyle) {
final HSSFCellStyle other = (HSSFCellStyle) obj;
if (_format == null) {
if (other._format != null) {
return false;
}
} else if (!_format.equals(other._format)) {
return false;
}
if (_index != other._index) {
return false;
}
return true;
}
return false;
}
}
|