From a9f18bad9d466ddc25bb5fb9bd962e33a0ee6f68 Mon Sep 17 00:00:00 2001 From: Yegor Kozlov Date: Sun, 5 Oct 2008 13:56:28 +0000 Subject: [PATCH] applied patch #45492 submitted by Gisella Bronzetti,also performed major cleanup of StylesTable and its components, the goal was to ensure that StylesTable works as a cache of styling components, not just a regular store of fill patterns and cell styles. git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@701797 13f79535-47bb-0310-9956-ffa450edef68 --- .../xssf/usermodel/examples/CreateCell.java | 5 + .../usermodel/examples/WorkingWithFonts.java | 78 +- .../apache/poi/ss/usermodel/CellStyle.java | 8 - .../org/apache/poi/ss/usermodel/Font.java | 13 +- .../apache/poi/xssf/model/StylesTable.java | 111 +- .../poi/xssf/usermodel/BorderStyle.java | 113 ++ .../poi/xssf/usermodel/FillPatternType.java | 85 ++ .../poi/xssf/usermodel/XSSFCellStyle.java | 1288 +++++++++++++---- .../apache/poi/xssf/usermodel/XSSFFont.java | 164 ++- .../poi/xssf/usermodel/XSSFWorkbook.java | 27 +- .../usermodel/extensions/XSSFCellBorder.java | 158 +- .../usermodel/extensions/XSSFCellFill.java | 103 +- .../xssf/usermodel/extensions/XSSFColor.java | 21 +- .../poi/xssf/usermodel/TestXSSFCellStyle.java | 581 +++++--- .../poi/xssf/usermodel/TestXSSFFont.java | 96 +- .../poi/xssf/usermodel/TestXSSFWorkbook.java | 2 +- .../usermodel/extensions/TestXSSFBorder.java | 20 +- .../extensions/TestXSSFCellFill.java | 125 +- 18 files changed, 2226 insertions(+), 772 deletions(-) create mode 100755 src/ooxml/java/org/apache/poi/xssf/usermodel/BorderStyle.java create mode 100755 src/ooxml/java/org/apache/poi/xssf/usermodel/FillPatternType.java diff --git a/src/examples/src/org/apache/poi/xssf/usermodel/examples/CreateCell.java b/src/examples/src/org/apache/poi/xssf/usermodel/examples/CreateCell.java index 3e49aa2f05..8cf56c675d 100755 --- a/src/examples/src/org/apache/poi/xssf/usermodel/examples/CreateCell.java +++ b/src/examples/src/org/apache/poi/xssf/usermodel/examples/CreateCell.java @@ -68,6 +68,11 @@ public class CreateCell { cell.setCellValue(new Date()); cell.setCellStyle(style); + //hyperlink + row.createCell(7).setCellFormula("SUM(A1:B1)"); + cell.setCellFormula("HYPERLINK(\"http://google.com\",\"Google\")"); + + // Write the output to a file FileOutputStream fileOut = new FileOutputStream("ooxml-cell.xlsx"); wb.write(fileOut); diff --git a/src/examples/src/org/apache/poi/xssf/usermodel/examples/WorkingWithFonts.java b/src/examples/src/org/apache/poi/xssf/usermodel/examples/WorkingWithFonts.java index c2276ca855..30991e13f7 100755 --- a/src/examples/src/org/apache/poi/xssf/usermodel/examples/WorkingWithFonts.java +++ b/src/examples/src/org/apache/poi/xssf/usermodel/examples/WorkingWithFonts.java @@ -32,34 +32,72 @@ import java.io.FileOutputStream; public class WorkingWithFonts { public static void main(String[] args) throws Exception { Workbook wb = new XSSFWorkbook(); - Sheet sheet = wb.createSheet("new sheet"); + Sheet sheet = wb.createSheet("Fonts"); - // Create a row and put some cells in it. Rows are 0 based. - Row row = sheet.createRow((short) 1); + Font font0 = wb.createFont(); + font0.setColor(IndexedColors.BROWN.getIndex()); + CellStyle style0 = wb.createCellStyle(); + style0.setFont(font0); - // Create a new font and alter it. - Font font = wb.createFont(); - font.setFontHeightInPoints((short)24); - font.setFontName("Courier New"); + Font font1 = wb.createFont(); + font1.setFontHeightInPoints((short)14); + font1.setFontName("Courier New"); + font1.setColor(IndexedColors.RED.getIndex()); + CellStyle style1 = wb.createCellStyle(); + style1.setFont(font1); - font.setColor(IndexedColors.RED.getIndex()); + Font font2 = wb.createFont(); + font2.setFontHeightInPoints((short)16); + font2.setFontName("Arial"); + font2.setColor(IndexedColors.GREEN.getIndex()); + CellStyle style2 = wb.createCellStyle(); + style2.setFont(font2); - font.setItalic(true); - font.setStrikeout(true); + Font font3 = wb.createFont(); + font3.setFontHeightInPoints((short)18); + font3.setFontName("Times New Roman"); + font3.setColor(IndexedColors.LAVENDER.getIndex()); + CellStyle style3 = wb.createCellStyle(); + style3.setFont(font3); - // Fonts are set into a style so create a new one to use. - CellStyle style = wb.createCellStyle(); - style.setFont(font); + Font font4 = wb.createFont(); + font4.setFontHeightInPoints((short)18); + font4.setFontName("Wingdings"); + font4.setColor(IndexedColors.GOLD.getIndex()); + CellStyle style4 = wb.createCellStyle(); + style4.setFont(font4); - // Create a cell and put a value in it. - Cell cell = row.createCell((short) 1); - cell.setCellValue(1974); - //cell.setCellValue(new XSSFRichTextString("This is a test of fonts")); - cell.setCellStyle(style); + Font font5 = wb.createFont(); + font5.setFontName("Symbol"); + CellStyle style5 = wb.createCellStyle(); + style5.setFont(font5); - // Write the output to a file + Cell cell0 = sheet.createRow(0).createCell(1); + cell0.setCellValue("Default"); + cell0.setCellStyle(style0); + + Cell cell1 = sheet.createRow(1).createCell(1); + cell1.setCellValue("Courier"); + cell1.setCellStyle(style1); + + Cell cell2 = sheet.createRow(2).createCell(1); + cell2.setCellValue("Arial"); + cell2.setCellStyle(style2); + + Cell cell3 = sheet.createRow(3).createCell(1); + cell3.setCellValue("Times New Roman"); + cell3.setCellStyle(style3); - FileOutputStream fileOut = new FileOutputStream("fonts.xlsx"); + Cell cell4 = sheet.createRow(4).createCell(1); + cell4.setCellValue("Wingdings"); + cell4.setCellStyle(style4); + + Cell cell5 = sheet.createRow(5).createCell(1); + cell5.setCellValue("Symbol"); + cell5.setCellStyle(style5); + + // Write the output to a file + FileOutputStream fileOut = new FileOutputStream("xssf-fonts.xlsx"); wb.write(fileOut); fileOut.close(); } diff --git a/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/CellStyle.java b/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/CellStyle.java index 9149c103b0..a87ba53338 100644 --- a/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/CellStyle.java +++ b/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/CellStyle.java @@ -276,14 +276,6 @@ public interface CellStyle { */ short getFontIndex(); - /** - * gets the font for this style - * @param parentWorkbook The HSSFWorkbook that this style belongs to - * @see org.apache.poi.hssf.usermodel.HSSFCellStyle#getFontIndex() - * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(short) - */ - Font getFont(Workbook parentWorkbook); - /** * set the cell's using this style to be hidden * @param hidden - whether the cell using this style should be hidden diff --git a/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/Font.java b/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/Font.java index a737b26a41..1af438f7ca 100644 --- a/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/Font.java +++ b/src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/Font.java @@ -270,6 +270,17 @@ public interface Font { */ void setCharSet(byte charset); - String toString(); + /** + * get the index within the XSSFWorkbook (sequence within the collection of Font objects) + * + * @return unique index number of the underlying record this Font represents (probably you don't care + * unless you're comparing which one is which) + */ + public short getIndex(); + + public void setBoldweight(short boldweight); + + public short getBoldweight(); + } \ No newline at end of file diff --git a/src/ooxml/java/org/apache/poi/xssf/model/StylesTable.java b/src/ooxml/java/org/apache/poi/xssf/model/StylesTable.java index 4f4c92e177..c3dd808392 100644 --- a/src/ooxml/java/org/apache/poi/xssf/model/StylesTable.java +++ b/src/ooxml/java/org/apache/poi/xssf/model/StylesTable.java @@ -66,9 +66,9 @@ import org.openxml4j.opc.PackageRelationship; */ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSSFModel { private final Hashtable numberFormats = new Hashtable(); - private final List fonts = new ArrayList(); - private final List fills = new LinkedList(); - private final List borders = new LinkedList(); + private final List fonts = new ArrayList(); + private final List fills = new ArrayList(); + private final List borders = new ArrayList(); private final List styleXfs = new LinkedList(); private final List xfs = new LinkedList(); @@ -122,17 +122,21 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS for (CTNumFmt nfmt : doc.getStyleSheet().getNumFmts().getNumFmtArray()) { numberFormats.put(nfmt.getNumFmtId(), nfmt.getFormatCode()); } - if(doc.getStyleSheet().getFonts() != null) - for (CTFont font : doc.getStyleSheet().getFonts().getFontArray()) { - fonts.add(font); - } + if(doc.getStyleSheet().getFonts() != null){ + int idx = 0; + for (CTFont font : doc.getStyleSheet().getFonts().getFontArray()) { + XSSFFont f = new XSSFFont(font, idx); + fonts.add(f); + idx++; + } + } if(doc.getStyleSheet().getFills() != null) for (CTFill fill : doc.getStyleSheet().getFills().getFillArray()) { - fills.add(fill); + fills.add(new XSSFCellFill(fill)); } if(doc.getStyleSheet().getBorders() != null) for (CTBorder border : doc.getStyleSheet().getBorders().getBorderArray()) { - borders.add(border); + borders.add(new XSSFCellBorder(border)); } if(doc.getStyleSheet().getCellXfs() != null) for (CTXf xf : doc.getStyleSheet().getCellXfs().getXfArray()) { @@ -181,12 +185,17 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS return newKey; } - public Font getFontAt(long idx) { - return new XSSFFont(fonts.get((int) idx)); + public XSSFFont getFontAt(long idx) { + return fonts.get((int)idx); } - public synchronized long putFont(Font font) { - return putFont((XSSFFont)font, fonts); + public long putFont(Font font) { + int idx = fonts.indexOf(font); + if (idx != -1) { + return idx; + } + fonts.add((XSSFFont)font); + return fonts.size() - 1; } public XSSFCellStyle getStyleAt(long idx) { @@ -209,24 +218,44 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS return xfs.indexOf(mainXF); } - public XSSFCellBorder getBorderAt(long idx) { - return new XSSFCellBorder(borders.get((int)idx)); + public XSSFCellBorder getBorderAt(int idx) { + return borders.get(idx); } - public long putBorder(XSSFCellBorder border) { - return putBorder(border, borders); + + public int putBorder(XSSFCellBorder border) { + int idx = borders.indexOf(border); + if (idx != -1) { + return idx; + } + borders.add(border); + return borders.size() - 1; } - public XSSFCellFill getFillAt(long idx) { - return new XSSFCellFill(fills.get((int) idx)); + public List getBorders(){ + return borders; + } + + public XSSFCellFill getFillAt(int idx) { + return fills.get(idx); } - public long putFill(XSSFCellFill fill) { - return fill.putFill(fills); + + public List getFills(){ + return fills; + } + + public int putFill(XSSFCellFill fill) { + int idx = fills.indexOf(fill); + if (idx != -1) { + return idx; + } + fills.add(fill); + return fills.size() - 1; } public CTXf getCellXfAt(long idx) { return xfs.get((int) idx); } - public long putCellXf(CTXf cellXf) { + public int putCellXf(CTXf cellXf) { xfs.add(cellXf); return xfs.size(); } @@ -234,7 +263,7 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS public CTXf getCellStyleXfAt(long idx) { return styleXfs.get((int) idx); } - public long putCellStyleXf(CTXf cellStyleXf) { + public int putCellStyleXf(CTXf cellStyleXf) { styleXfs.add(cellStyleXf); return styleXfs.size(); } @@ -323,24 +352,32 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS } doc.getStyleSheet().setNumFmts(formats); + int idx = 0; // Fonts CTFonts ctFonts = CTFonts.Factory.newInstance(); ctFonts.setCount(fonts.size()); - ctFonts.setFontArray( - fonts.toArray(new CTFont[fonts.size()]) - ); + CTFont[] ctfnt = new CTFont[fonts.size()]; + idx = 0; + for(XSSFFont f : fonts) ctfnt[idx++] = f.getCTFont(); + ctFonts.setFontArray(ctfnt); doc.getStyleSheet().setFonts(ctFonts); // Fills CTFills ctFills = CTFills.Factory.newInstance(); ctFills.setCount(fills.size()); - ctFills.setFillArray(fills.toArray(new CTFill[fills.size()])); + CTFill[] ctf = new CTFill[fills.size()]; + idx = 0; + for(XSSFCellFill f : fills) ctf[idx++] = f.getCTFill(); + ctFills.setFillArray(ctf); doc.getStyleSheet().setFills(ctFills); // Borders CTBorders ctBorders = CTBorders.Factory.newInstance(); ctBorders.setCount(borders.size()); - ctBorders.setBorderArray(borders.toArray(new CTBorder[borders.size()])); + CTBorder[] ctb = new CTBorder[borders.size()]; + idx = 0; + for(XSSFCellBorder b : borders) ctb[idx++] = b.getCTBorder(); + ctBorders.setBorderArray(ctb); doc.getStyleSheet().setBorders(ctBorders); // Xfs @@ -384,25 +421,17 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS out.close(); } - private long putBorder(XSSFCellBorder border, List borders) { - return border.putBorder((LinkedList) borders); // TODO - use List instead of LinkedList - } - - private long putFont(XSSFFont font, List fonts) { - return font.putFont((ArrayList) fonts); // TODO - use List instead of ArrayList - } - private void initialize() { //CTFont ctFont = createDefaultFont(); XSSFFont xssfFont = createDefaultFont(); - fonts.add(xssfFont.getCTFont()); + fonts.add(xssfFont); CTFill[] ctFill = createDefaultFills(); - fills.add(ctFill[0]); - fills.add(ctFill[1]); + fills.add(new XSSFCellFill(ctFill[0])); + fills.add(new XSSFCellFill(ctFill[1])); CTBorder ctBorder = createDefaultBorder(); - borders.add(ctBorder); + borders.add(new XSSFCellBorder(ctBorder)); CTXf styleXf = createDefaultXf(); styleXfs.add(styleXf); @@ -439,7 +468,7 @@ public class StylesTable extends POIXMLDocumentPart implements StylesSource, XSS private XSSFFont createDefaultFont() { CTFont ctFont = CTFont.Factory.newInstance(); - XSSFFont xssfFont=new XSSFFont(ctFont); + XSSFFont xssfFont=new XSSFFont(ctFont, 0); xssfFont.setFontHeightInPoints(XSSFFont.DEFAULT_FONT_SIZE); xssfFont.setColor(XSSFFont.DEFAULT_FONT_COLOR);//setTheme xssfFont.setFontName(XSSFFont.DEFAULT_FONT_NAME); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/BorderStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/BorderStyle.java new file mode 100755 index 0000000000..11f29233b4 --- /dev/null +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/BorderStyle.java @@ -0,0 +1,113 @@ +/* ==================================================================== + 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.xssf.usermodel; + +/** + * The enumeration value indicating the line style of a border in a cell, + * i.e., whether it is borded dash dot, dash dot dot, dashed, dotted, double, hair, medium, + * medium dash dot, medium dash dot dot, medium dashed, none, slant dash dot, thick or thin. + */ + + +public enum BorderStyle { + + /** + * No border + */ + + NONE, + + /** + * Thin border + */ + + THIN, + + /** + * Medium border + */ + + MEDIUM, + + /** + * dash border + */ + + DASHED, + + /** + * dot border + */ + + HAIR, + + /** + * Thick border + */ + + THICK, + + /** + * double-line border + */ + + DOUBLE, + + /** + * hair-line border + */ + + DOTTED, + + /** + * Medium dashed border + */ + + MEDIUM_DASHED, + + /** + * dash-dot border + */ + + DASH_DOT, + + /** + * medium dash-dot border + */ + + MEDIUM_DASH_DOT, + + /** + * dash-dot-dot border + */ + + DASH_DOT_DOT, + + /** + * medium dash-dot-dot border + */ + + MEDIUM_DASH_DOT_DOTC, + + /** + * slanted dash-dot border + */ + + SLANTED_DASH_DOT; + +} diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/FillPatternType.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/FillPatternType.java new file mode 100755 index 0000000000..98ec5eee00 --- /dev/null +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/FillPatternType.java @@ -0,0 +1,85 @@ +/* ==================================================================== + 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.xssf.usermodel; + +/** + * The enumeration value indicating the style of fill pattern being used for a cell format. + * + */ + + +public enum FillPatternType { + + /** No background */ + NO_FILL, + + /** Solidly filled */ + SOLID_FOREGROUND, + + /** Small fine dots */ + FINE_DOTS, + + /** Wide dots */ + ALT_BARS, + + /** Sparse dots */ + SPARSE_DOTS, + + /** Thick horizontal bands */ + THICK_HORZ_BANDS, + + /** Thick vertical bands */ + THICK_VERT_BANDS, + + /** Thick backward facing diagonals */ + THICK_BACKWARD_DIAG, + + /** Thick forward facing diagonals */ + THICK_FORWARD_DIAG, + + /** Large spots */ + BIG_SPOTS, + + /** Brick-like layout */ + BRICKS, + + /** Thin horizontal bands */ + THIN_HORZ_BANDS, + + /** Thin vertical bands */ + THIN_VERT_BANDS, + + /** Thin backward diagonal */ + THIN_BACKWARD_DIAG, + + /** Thin forward diagonal */ + THIN_FORWARD_DIAG, + + /** Squares */ + SQUARES, + + /** Diamonds */ + DIAMONDS, + + /** Less Dots */ + LESS_DOTS, + + /** Least Dots */ + LEAST_DOTS; + +} diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java index 3283f58914..6bdb8a0e1c 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java @@ -20,44 +20,44 @@ package org.apache.poi.xssf.usermodel; import org.apache.poi.ss.usermodel.CellStyle; import org.apache.poi.ss.usermodel.Font; import org.apache.poi.ss.usermodel.StylesSource; -import org.apache.poi.ss.usermodel.Workbook; import org.apache.poi.xssf.model.StylesTable; import org.apache.poi.xssf.usermodel.extensions.XSSFCellAlignment; import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder; import org.apache.poi.xssf.usermodel.extensions.XSSFCellFill; import org.apache.poi.xssf.usermodel.extensions.XSSFColor; import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellAlignment; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCellProtection; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTXf; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.STBorderStyle; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.*; -public class XSSFCellStyle implements CellStyle { +/** + * + * High level representation of the the possible formatting information for the contents of the cells on a sheet in a + * SpreadsheetML document. + * + * @see org.apache.poi.xssf.usermodel.XSSFWorkbook#createCellStyle() + * @see org.apache.poi.xssf.usermodel.XSSFWorkbook#getCellStyleAt(short) + * @see org.apache.poi.xssf.usermodel.XSSFCell#setCellStyle(org.apache.poi.ss.usermodel.CellStyle) + */ +public class XSSFCellStyle implements CellStyle, Cloneable { private int cellXfId; - private int cellStyleXfId; - private StylesSource stylesSource; + private StylesTable stylesSource; private CTXf cellXf; private CTXf cellStyleXf; - private XSSFCellBorder cellBorder; - private XSSFCellFill cellFill; private XSSFFont font; private XSSFCellAlignment cellAlignment; /** * Creates a Cell Style from the supplied parts - * @param cellXf The main XF for the cell - * @param cellStyleXf Optional, style xf + * @param cellXfId The main XF for the cell + * @param cellStyleXfId Optional, style xf * @param stylesSource Styles Source to work off */ public XSSFCellStyle(int cellXfId, int cellStyleXfId, StylesTable stylesSource) { this.cellXfId = cellXfId; - this.cellStyleXfId = cellStyleXfId; this.stylesSource = stylesSource; this.cellXf = stylesSource.getCellXfAt(this.cellXfId); - this.cellStyleXf = stylesSource.getCellStyleXfAt(this.cellStyleXfId); + this.cellStyleXf = stylesSource.getCellStyleXfAt(cellStyleXfId); } /** @@ -66,6 +66,7 @@ public class XSSFCellStyle implements CellStyle { public CTXf getCoreXf() { return cellXf; } + /** * Used so that StylesSource can figure out our location */ @@ -77,13 +78,13 @@ public class XSSFCellStyle implements CellStyle { * Creates an empty Cell Style */ public XSSFCellStyle(StylesSource stylesSource) { - this.stylesSource = stylesSource; + this.stylesSource = (StylesTable)stylesSource; // We need a new CTXf for the main styles // TODO decide on a style ctxf cellXf = CTXf.Factory.newInstance(); cellStyleXf = null; } - + /** * Verifies that this style belongs to the supplied Workbook * Styles Source. @@ -117,426 +118,1168 @@ public class XSSFCellStyle implements CellStyle { } throw new IllegalArgumentException("Can only clone from one XSSFCellStyle to another, not between HSSFCellStyle and XSSFCellStyle"); } + public void cloneStyleFrom(XSSFCellStyle source) { throw new IllegalStateException("TODO"); } + /** + * Get the type of horizontal alignment for the cell + * + * @return short - the type of alignment + * @see #ALIGN_GENERAL + * @see #ALIGN_LEFT + * @see #ALIGN_CENTER + * @see #ALIGN_RIGHT + * @see #ALIGN_FILL + * @see #ALIGN_JUSTIFY + * @see #ALIGN_CENTER_SELECTION + */ public short getAlignment() { return (short)(getAlignmentEnum().ordinal()); } + /** + * Get the type of horizontal alignment for the cell + * + * @return HorizontalAlignment - the type of alignment + */ public HorizontalAlignment getAlignmentEnum() { return getCellAlignment().getHorizontal(); } + /** + * Get the type of border to use for the bottom border of the cell + * + * @return short - border type + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public short getBorderBottom() { - return getBorderStyleAsShort(BorderSide.BOTTOM); + if(!cellXf.getApplyBorder()) return BORDER_NONE; + + int idx = (int)cellXf.getBorderId(); + CTBorder ct = stylesSource.getBorderAt(idx).getCTBorder(); + STBorderStyle.Enum ptrn = ct.isSetBottom() ? ct.getBottom().getStyle() : null; + return ptrn == null ? BORDER_NONE : (short)(ptrn.intValue() - 1); } - public String getBorderBottomAsString() { - return getBorderStyleAsString(BorderSide.BOTTOM); + /** + * Get the type of border to use for the bottom border of the cell + * + * @return border type as Java enum + * @see BorderStyle + */ + public BorderStyle getBorderBottomEnum() { + int style = getBorderBottom(); + return BorderStyle.values()[style]; } + /** + * Get the type of border to use for the left border of the cell + * + * @return short - border type, default value is {@link #BORDER_NONE} + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public short getBorderLeft() { - return getBorderStyleAsShort(BorderSide.LEFT); + if(!cellXf.getApplyBorder()) return BORDER_NONE; + + int idx = (int)cellXf.getBorderId(); + CTBorder ct = stylesSource.getBorderAt(idx).getCTBorder(); + STBorderStyle.Enum ptrn = ct.isSetLeft() ? ct.getLeft().getStyle() : null; + return ptrn == null ? BORDER_NONE : (short)(ptrn.intValue() - 1); } - public String getBorderLeftAsString() { - return getBorderStyleAsString(BorderSide.LEFT); + /** + * Get the type of border to use for the left border of the cell + * + * @return border type, default value is {@link BorderStyle.NONE} + */ + public BorderStyle getBorderLeftEnum() { + int style = getBorderLeft(); + return BorderStyle.values()[style]; } + /** + * Get the type of border to use for the right border of the cell + * + * @return short - border type, default value is {@link #BORDER_NONE} + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public short getBorderRight() { - return getBorderStyleAsShort(BorderSide.RIGHT); + if(!cellXf.getApplyBorder()) return BORDER_NONE; + + int idx = (int)cellXf.getBorderId(); + CTBorder ct = stylesSource.getBorderAt(idx).getCTBorder(); + STBorderStyle.Enum ptrn = ct.isSetRight() ? ct.getRight().getStyle() : null; + return ptrn == null ? BORDER_NONE : (short)(ptrn.intValue() - 1); } - public String getBorderRightAsString() { - return getBorderStyleAsString(BorderSide.RIGHT); + /** + * Get the type of border to use for the right border of the cell + * + * @return border type, default value is {@link BorderStyle.NONE} + */ + public BorderStyle getBorderRightEnum() { + int style = getBorderRight(); + return BorderStyle.values()[style]; } + /** + * Get the type of border to use for the top border of the cell + * + * @return short - border type, default value is {@link #BORDER_NONE} + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public short getBorderTop() { - return getBorderStyleAsShort(BorderSide.TOP); + if(!cellXf.getApplyBorder()) return BORDER_NONE; + + int idx = (int)cellXf.getBorderId(); + CTBorder ct = stylesSource.getBorderAt(idx).getCTBorder(); + STBorderStyle.Enum ptrn = ct.isSetTop() ? ct.getTop().getStyle() : null; + return ptrn == null ? BORDER_NONE : (short)(ptrn.intValue() - 1); } - public String getBorderTopAsString() { - return getBorderStyleAsString(BorderSide.TOP); + /** + * Get the type of border to use for the top border of the cell + * + * @return border type, default value is {@link BorderStyle.NONE} + */ + public BorderStyle getBorderTopEnum() { + int style = getBorderTop(); + return BorderStyle.values()[style]; } + /** + * Get the color to use for the bottom border + *
+ * Color is optional. When missing, IndexedColors.AUTOMATIC is implied. + * @return the index of the color definition, default value is {@link IndexedColors.AUTOMATIC} + * @see IndexedColors + */ public short getBottomBorderColor() { - return getBorderColorIndexed(BorderSide.BOTTOM); + XSSFColor clr = getBottomBorderRgbColor(); + return clr == null ? IndexedColors.BLACK.getIndex() : (short)clr.getIndexed(); } + /** + * Get the color to use for the bottom border as a {@link XSSFColor} + * + * @return the used color or null if not set + */ + public XSSFColor getBottomBorderRgbColor() { + if(!cellXf.getApplyBorder()) return null; + + int idx = (int)cellXf.getBorderId(); + XSSFCellBorder border = stylesSource.getBorderAt(idx); + + return border.getBorderColor(BorderSide.BOTTOM); + } + + /** + * Get the index of the number format (numFmt) record used by this cell format. + * + * @return the index of the number format + */ public short getDataFormat() { return (short)cellXf.getNumFmtId(); } + + /** + * Get the contents of the format string, by looking up + * the StylesSource + * + * @return the number format string + */ public String getDataFormatString() { return stylesSource.getNumberFormatAt(getDataFormat()); } + /** + * Get the background fill color. + *

+ * Note - many cells are actually filled with a foreground + * fill, not a background fill - see {@link #getFillForegroundColor()} + *

+ * @return fill color, default value is {@link IndexedColors.AUTOMATIC} + * @see IndexedColors + */ public short getFillBackgroundColor() { - return (short) getCellFill().getFillBackgroundColor().getIndexed(); + XSSFColor clr = getFillBackgroundRgbColor(); + return clr == null ? IndexedColors.AUTOMATIC.getIndex() : (short)clr.getIndexed(); } + /** + * 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.xssf.usermodel.extensions.XSSFColor#getRgb() + * @return XSSFColor - fill color or null if not set + */ public XSSFColor getFillBackgroundRgbColor() { - return getCellFill().getFillBackgroundColor(); + if(!cellXf.getApplyFill()) return null; + + int fillIndex = (int)cellXf.getFillId(); + XSSFCellFill fg = stylesSource.getFillAt(fillIndex); + + return fg.getFillBackgroundColor(); } + /** + * Get the foreground fill color. + *

+ * Many cells are filled with this, instead of a + * background color ({@link #getFillBackgroundColor()}) + *

+ * @see IndexedColors + * @return fill color, default value is {@link IndexedColors.AUTOMATIC} + */ public short getFillForegroundColor() { - return (short) getCellFill().getFillForegroundColor().getIndexed(); + XSSFColor clr = getFillForegroundRgbColor(); + return clr == null ? IndexedColors.AUTOMATIC.getIndex() : (short)clr.getIndexed(); } + /** + * Get the foreground fill color. + * + * @return XSSFColor - fill color or null if not set + */ public XSSFColor getFillForegroundRgbColor() { - return getCellFill().getFillForegroundColor(); + if(!cellXf.getApplyFill()) return null; + + int fillIndex = (int)cellXf.getFillId(); + XSSFCellFill fg = stylesSource.getFillAt(fillIndex); + + return fg.getFillForegroundColor(); } + /** + * Get the fill pattern + * @return fill pattern, default value is {@link #NO_FILL} + * + * @see #NO_FILL + * @see #SOLID_FOREGROUND + * @see #FINE_DOTS + * @see #ALT_BARS + * @see #SPARSE_DOTS + * @see #THICK_HORZ_BANDS + * @see #THICK_VERT_BANDS + * @see #THICK_BACKWARD_DIAG + * @see #THICK_FORWARD_DIAG + * @see #BIG_SPOTS + * @see #BRICKS + * @see #THIN_HORZ_BANDS + * @see #THIN_VERT_BANDS + * @see #THIN_BACKWARD_DIAG + * @see #THIN_FORWARD_DIAG + * @see #SQUARES + * @see #DIAMONDS + */ public short getFillPattern() { - int fp= getCellFill().getPatternType().intValue(); - switch (fp) { - case STPatternType.INT_NONE: - return CellStyle.NO_FILL; - case STPatternType.INT_SOLID: - return CellStyle.SOLID_FOREGROUND; - case STPatternType.INT_LIGHT_GRAY: - return CellStyle.FINE_DOTS; - case STPatternType.INT_DARK_GRID: - return CellStyle.ALT_BARS; - case STPatternType.INT_DARK_GRAY: - return CellStyle.SPARSE_DOTS; - case STPatternType.INT_DARK_HORIZONTAL: - return CellStyle.THICK_HORZ_BANDS; - case STPatternType.INT_DARK_VERTICAL: - return CellStyle.THICK_VERT_BANDS; - case STPatternType.INT_DARK_UP: - return CellStyle.THICK_BACKWARD_DIAG; - case STPatternType.INT_DARK_DOWN: - return CellStyle.THICK_FORWARD_DIAG; - case STPatternType.INT_GRAY_0625: - return CellStyle.BIG_SPOTS; - case STPatternType.INT_DARK_TRELLIS: - return CellStyle.BRICKS; - case STPatternType.INT_LIGHT_HORIZONTAL: - return CellStyle.THIN_HORZ_BANDS; - case STPatternType.INT_LIGHT_VERTICAL: - return CellStyle.THIN_VERT_BANDS; - case STPatternType.INT_LIGHT_UP: - return CellStyle.THIN_BACKWARD_DIAG; - case STPatternType.INT_LIGHT_DOWN: - return CellStyle.THIN_FORWARD_DIAG; - case STPatternType.INT_LIGHT_GRID: - return CellStyle.SQUARES; - case STPatternType.INT_LIGHT_TRELLIS: - return CellStyle.DIAMONDS; - case STPatternType.INT_GRAY_125: - return CellStyle.LESS_DOTS; -/* - case STPatternType.INT_GRAY_0625: - return CellStyle.LEAST_DOTS; -*/ - default: - return CellStyle.NO_FILL; - } - // return (short) getCellFill().getPatternType().intValue(); - } - - public Font getFont(Workbook parentWorkbook) { - return getFont(); - } - - public Font getFont() { + if(!cellXf.getApplyFill()) return 0; + + int fillIndex = (int)cellXf.getFillId(); + XSSFCellFill fill = stylesSource.getFillAt(fillIndex); + + STPatternType.Enum ptrn = fill.getPatternType(); + if(ptrn == null) return CellStyle.NO_FILL; + return (short)(ptrn.intValue() - 1); + } + + /** + * Get the fill pattern + * + * @return the fill pattern, default value is {@link FillPatternType.NO_FILL} + */ + public FillPatternType getFillPatternEnum() { + int style = getFillPattern(); + return FillPatternType.values()[style]; + } + + /** + * Gets the font for this style + * @return Font - font + */ + public XSSFFont getFont() { if (font == null) { - font = (XSSFFont) ((StylesTable)stylesSource).getFontAt(getFontId()); + font = stylesSource.getFontAt(getFontId()); } return font; } + /** + * Gets the index of the font for this style + * + * @return short - font index + * @see org.apache.poi.xssf.usermodel.XSSFWorkbook#getFontAt(short) + */ public short getFontIndex() { return (short) getFontId(); } + /** + * Get whether the cell's using this style are to be hidden + * + * @return boolean - whether the cell using this style is hidden + */ public boolean getHidden() { return getCellProtection().getHidden(); } + /** + * Get the number of spaces to indent the text in the cell + * + * @return indent - number of spaces + */ public short getIndention() { return (short) getCellAlignment().getIndent(); } + /** + * Get the index within the StylesTable (sequence within the collection of CTXf elements) + * + * @return unique index number of the underlying record this style represents + */ public short getIndex() { - return (short) this.cellXfId; + return (short)this.cellXfId; } + /** + * Get the color to use for the left border + * + * @return the index of the color definition, default value is {@link IndexedColors.BLACK} + * @see IndexedColors + */ public short getLeftBorderColor() { - return getBorderColorIndexed(BorderSide.LEFT); + XSSFColor clr = getLeftBorderRgbColor(); + return clr == null ? IndexedColors.BLACK.getIndex() : (short)clr.getIndexed(); } + /** + * Get the color to use for the left border + * + * @return the index of the color definition or null if not set + * @see IndexedColors + */ + public XSSFColor getLeftBorderRgbColor() { + if(!cellXf.getApplyBorder()) return null; + + int idx = (int)cellXf.getBorderId(); + XSSFCellBorder border = stylesSource.getBorderAt(idx); + + return border.getBorderColor(BorderSide.LEFT); + } + + /** + * Get whether the cell's using this style are locked + * + * @return whether the cell using this style are locked + */ public boolean getLocked() { return getCellProtection().getLocked(); } + /** + * Get the color to use for the right border + * + * @return the index of the color definition, default value is {@link IndexedColors.BLACK} + * @see IndexedColors + */ public short getRightBorderColor() { - return getBorderColorIndexed(BorderSide.RIGHT); + XSSFColor clr = getRightBorderRgbColor(); + return clr == null ? IndexedColors.BLACK.getIndex() : (short)clr.getIndexed(); + } + /** + * Get the color to use for the right border + * + * @return the used color or null if not set + */ + public XSSFColor getRightBorderRgbColor() { + if(!cellXf.getApplyBorder()) return null; + + int idx = (int)cellXf.getBorderId(); + XSSFCellBorder border = stylesSource.getBorderAt(idx); + + return border.getBorderColor(BorderSide.RIGHT); } + /** + * Get the degree of rotation for the text in the cell + *

+ * Expressed in degrees. Values range from 0 to 180. The first letter of + * the text is considered the center-point of the arc. + *
+ * For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the + * horizon is calculated as: + *
+ * [degrees below horizon] = 90 - textRotation. + *

+ * + * @return rotation degrees (between 0 and 180 degrees) + */ public short getRotation() { return (short) getCellAlignment().getTextRotation(); } + /** + * Get the color to use for the top border + * + * @return the index of the color definition, default value is {@link IndexedColors.BLACK} + * @see IndexedColors + */ public short getTopBorderColor() { - return getBorderColorIndexed(BorderSide.TOP); + XSSFColor clr = getTopBorderRgbColor(); + return clr == null ? IndexedColors.BLACK.getIndex() : (short)clr.getIndexed(); + } + + /** + * Get the color to use for the top border + * + * @return the used color or null if not set + */ + public XSSFColor getTopBorderRgbColor() { + if(!cellXf.getApplyBorder()) return null; + + int idx = (int)cellXf.getBorderId(); + XSSFCellBorder border = stylesSource.getBorderAt(idx); + + return border.getBorderColor(BorderSide.TOP); } + /** + * Get the type of vertical alignment for the cell + * + * @return align the type of alignment, default value is {@link #VERTICAL_BOTTOM} + * @see #VERTICAL_TOP + * @see #VERTICAL_CENTER + * @see #VERTICAL_BOTTOM + * @see #VERTICAL_JUSTIFY + */ public short getVerticalAlignment() { return (short) (getVerticalAlignmentEnum().ordinal()); } + /** + * Get the type of vertical alignment for the cell + * + * @return the type of alignment, default value is {@link VerticalAlignment.BOTTOM} + * @see VerticalAlignment + */ public VerticalAlignment getVerticalAlignmentEnum() { return getCellAlignment().getVertical(); } + /** + * Whether the text should be wrapped + * + * @return a boolean value indicating if the text in a cell should be line-wrapped within the cell. + */ public boolean getWrapText() { return getCellAlignment().getWrapText(); } + /** + * Set the type of horizontal alignment for the cell + * + * @param align - the type of alignment + * @see #ALIGN_GENERAL + * @see #ALIGN_LEFT + * @see #ALIGN_CENTER + * @see #ALIGN_RIGHT + * @see #ALIGN_FILL + * @see #ALIGN_JUSTIFY + * @see #ALIGN_CENTER_SELECTION + */ public void setAlignment(short align) { getCellAlignment().setHorizontal(HorizontalAlignment.values()[align]); } + /** + * Set the type of horizontal alignment for the cell + * + * @param align - the type of alignment + * @see HorizontalAlignment + */ public void setAlignment(HorizontalAlignment align) { setAlignment((short)align.ordinal()); } + /** + * Set the type of border to use for the bottom border of the cell + * + * @param border the type of border to use + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public void setBorderBottom(short border) { - setBorderBottomEnum(STBorderStyle.Enum.forInt(border)); + CTBorder ct = getCTBorder(); + CTBorderPr pr = ct.isSetBottom() ? ct.getBottom() : ct.addNewBottom(); + if(border == BORDER_NONE) ct.unsetBottom(); + else pr.setStyle(STBorderStyle.Enum.forInt(border + 1)); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); } - public void setBorderBottomEnum(STBorderStyle.Enum style) { - getCellBorder().setBorderStyle(BorderSide.BOTTOM, style); + /** + * Set the type of border to use for the bottom border of the cell + * + * @param border - type of border to use + * @see BorderStyle + */ + public void setBorderBottom(BorderStyle border) { + setBorderBottom((short)border.ordinal()); } + /** + * Set the type of border to use for the left border of the cell + * @param border the type of border to use + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ public void setBorderLeft(short border) { - setBorderLeftEnum(STBorderStyle.Enum.forInt(border)); + CTBorder ct = getCTBorder(); + CTBorderPr pr = ct.isSetLeft() ? ct.getLeft() : ct.addNewLeft(); + if(border == BORDER_NONE) ct.unsetLeft(); + else pr.setStyle(STBorderStyle.Enum.forInt(border + 1)); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); } - public void setBorderLeftEnum(STBorderStyle.Enum style) { - getCellBorder().setBorderStyle(BorderSide.LEFT, style); + /** + * Set the type of border to use for the left border of the cell + * + * @param border the type of border to use + */ + public void setBorderLeft(BorderStyle border) { + setBorderLeft((short)border.ordinal()); } - public void setBorderRight(short border) { - setBorderRightEnum(STBorderStyle.Enum.forInt(border)); + /** + * Set the type of border to use for the right border of the cell + * + * @param border the type of border to use + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ + public void setBorderRight(short border) { + CTBorder ct = getCTBorder(); + CTBorderPr pr = ct.isSetRight() ? ct.getRight() : ct.addNewRight(); + if(border == BORDER_NONE) ct.unsetRight(); + else pr.setStyle(STBorderStyle.Enum.forInt(border + 1)); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); } - public void setBorderRightEnum(STBorderStyle.Enum style) { - getCellBorder().setBorderStyle(BorderSide.RIGHT, style); + /** + * Set the type of border to use for the right border of the cell + * + * @param border the type of border to use + */ + public void setBorderRight(BorderStyle border) { + setBorderRight((short)border.ordinal()); } - public void setBorderTop(short border) { - setBorderTopEnum(STBorderStyle.Enum.forInt(border)); + /** + * Set the type of border to use for the top border of the cell + * + * @param border the type of border to use + * @see #BORDER_NONE + * @see #BORDER_THIN + * @see #BORDER_MEDIUM + * @see #BORDER_DASHED + * @see #BORDER_DOTTED + * @see #BORDER_THICK + * @see #BORDER_DOUBLE + * @see #BORDER_HAIR + * @see #BORDER_MEDIUM_DASHED + * @see #BORDER_DASH_DOT + * @see #BORDER_MEDIUM_DASH_DOT + * @see #BORDER_DASH_DOT_DOT + * @see #BORDER_MEDIUM_DASH_DOT_DOT + * @see #BORDER_SLANTED_DASH_DOT + */ + public void setBorderTop(short border) { + CTBorder ct = getCTBorder(); + CTBorderPr pr = ct.isSetTop() ? ct.getTop() : ct.addNewTop(); + if(border == BORDER_NONE) ct.unsetTop(); + else pr.setStyle(STBorderStyle.Enum.forInt(border + 1)); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); } - public void setBorderTopEnum(STBorderStyle.Enum style) { - getCellBorder().setBorderStyle(BorderSide.TOP, style); + /** + * Set the type of border to use for the top border of the cell + * + * @param border the type of border to use + */ + public void setBorderTopEnum(BorderStyle border) { + setBorderTop((short)border.ordinal()); } + /** + * Set the color to use for the bottom border + * @param color the index of the color definition + * @see IndexedColors + */ public void setBottomBorderColor(short color) { - setBorderColorIndexed(BorderSide.BOTTOM, color); + XSSFColor clr = new XSSFColor(); + clr.setIndexed(color); + setBottomBorderColor(clr); } + /** + * Set the color to use for the bottom border + * + * @param color the color to use, null means no color + */ + public void setBottomBorderColor(XSSFColor color) { + CTBorder ct = getCTBorder(); + if(color == null && !ct.isSetBottom()) return; + + CTBorderPr pr = ct.isSetBottom() ? ct.getBottom() : ct.addNewBottom(); + if(color != null) pr.setColor(color.getCTColor()); + else pr.unsetColor(); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); + } + + /** + * Set the index of a data format + * + * @param fmt the index of a data format + */ public void setDataFormat(short fmt) { cellXf.setNumFmtId((long)fmt); } - public void setFillBackgroundRgbColor(XSSFColor color) { - cellFill=getCellFill(); - cellFill.setFillBackgroundRgbColor(color); + /** + * Set the background fill color represented as a {@link XSSFColor} value. + *

+ * For example: + * 

+     * cs.setFillPattern(XSSFCellStyle.FINE_DOTS );
+     * cs.setFillBackgroundRgbColor(new XSSFColor(java.awt.Color.RED));
+     *
+ * optionally a Foreground and background fill can be applied: + * Note: Ensure Foreground color is set prior to background + * 
+     * cs.setFillPattern(XSSFCellStyle.FINE_DOTS );
+     * cs.setFillForegroundColor(new XSSFColor(java.awt.Color.BLUE));
+     * cs.setFillBackgroundColor(new XSSFColor(java.awt.Color.GREEN));
+     *
+ * or, for the special case of SOLID_FILL: + * 
+     * cs.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND );
+     * cs.setFillForegroundColor(new XSSFColor(java.awt.Color.GREEN));
+     *
+ * It is necessary to set the fill style in order + * for the color to be shown in the cell. + * + * @param color - the color to use + */ + public void setFillBackgroundColor(XSSFColor color) { + CTFill ct = getCTFill(); + CTPatternFill ptrn = ct.getPatternFill(); + if(color == null) { + if(ptrn != null) ptrn.unsetBgColor(); + } else { + if(ptrn == null) ptrn = ct.addNewPatternFill(); + ptrn.setBgColor(color.getCTColor()); + } + + int idx = stylesSource.putFill(new XSSFCellFill(ct)); + + cellXf.setFillId(idx); + cellXf.setApplyFill(true); } + /** + * Set the background fill color represented as a indexed color value. + *

+ * For example: + * 

+     * cs.setFillPattern(XSSFCellStyle.FINE_DOTS );
+     * cs.setFillBackgroundRgbColor(IndexedColors.RED.getIndex());
+     *
+ * optionally a Foreground and background fill can be applied: + * Note: Ensure Foreground color is set prior to background + * 
+     * cs.setFillPattern(XSSFCellStyle.FINE_DOTS );
+     * cs.setFillForegroundColor(IndexedColors.BLUE.getIndex());
+     * cs.setFillBackgroundColor(IndexedColors.RED.getIndex());
+     *
+ * or, for the special case of SOLID_FILL: + * 
+     * cs.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND );
+     * cs.setFillForegroundColor(IndexedColors.RED.getIndex());
+     *
+ * It is necessary to set the fill style in order + * for the color to be shown in the cell. + * + * @param bg - the color to use + * @see IndexedColors + */ public void setFillBackgroundColor(short bg) { - getCellFill().setFillBackgroundColor(bg); - } - - public void setFillForegroundRgbColor(XSSFColor color) { - getCellFill().setFillForegroundRgbColor(color); - } - - public void setFillForegroundColor(short bg) { - getCellFill().setFillForegroundColor(bg); - } - - public void setFillPattern(short fp) { - cellFill=getCellFill(); - switch (fp) { - case CellStyle.NO_FILL: - cellFill.setPatternType(STPatternType.NONE); - break; - case CellStyle.SOLID_FOREGROUND: - cellFill.setPatternType(STPatternType.SOLID); - break; - case CellStyle.FINE_DOTS: - cellFill.setPatternType(STPatternType.LIGHT_GRAY); - break; - case CellStyle.ALT_BARS: - cellFill.setPatternType(STPatternType.DARK_GRID); - break; - case CellStyle.SPARSE_DOTS: - cellFill.setPatternType(STPatternType.DARK_GRAY); - break; - case CellStyle.THICK_HORZ_BANDS: - cellFill.setPatternType(STPatternType.DARK_HORIZONTAL); - break; - case CellStyle.THICK_VERT_BANDS: - cellFill.setPatternType(STPatternType.DARK_VERTICAL); - break; - case CellStyle.THICK_BACKWARD_DIAG: - cellFill.setPatternType(STPatternType.DARK_UP); - break; - case CellStyle.THICK_FORWARD_DIAG: - cellFill.setPatternType(STPatternType.DARK_DOWN); - break; - case CellStyle.BIG_SPOTS: - cellFill.setPatternType(STPatternType.GRAY_0625); - break; - case CellStyle.BRICKS: - cellFill.setPatternType(STPatternType.DARK_TRELLIS); - break; - case CellStyle.THIN_HORZ_BANDS: - cellFill.setPatternType(STPatternType.LIGHT_HORIZONTAL); - break; - case CellStyle.THIN_VERT_BANDS: - cellFill.setPatternType(STPatternType.LIGHT_VERTICAL); - break; - case CellStyle.THIN_BACKWARD_DIAG: - cellFill.setPatternType(STPatternType.LIGHT_UP); - break; - case CellStyle.THIN_FORWARD_DIAG: - cellFill.setPatternType(STPatternType.LIGHT_DOWN); - break; - case CellStyle.SQUARES: - cellFill.setPatternType(STPatternType.LIGHT_GRID); - break; - case CellStyle.DIAMONDS: - cellFill.setPatternType(STPatternType.LIGHT_TRELLIS); - break; - case CellStyle.LESS_DOTS: - cellFill.setPatternType(STPatternType.GRAY_125); - break; - case CellStyle.LEAST_DOTS: - cellFill.setPatternType(STPatternType.GRAY_0625); - break; - default: throw new RuntimeException("Fill type ["+fp+"] not accepted"); - } + XSSFColor clr = new XSSFColor(); + clr.setIndexed(bg); + setFillBackgroundColor(clr); } + /** + * Set the foreground fill color represented as a {@link XSSFColor} value. + *
+ * Note: Ensure Foreground color is set prior to background color. + * @param color the color to use + * @see #setFillBackgroundColor(org.apache.poi.xssf.usermodel.extensions.XSSFColor) ) + */ + public void setFillForegroundColor(XSSFColor color) { + CTFill ct = getCTFill(); + + CTPatternFill ptrn = ct.getPatternFill(); + if(color == null) { + if(ptrn != null) ptrn.unsetFgColor(); + } else { + if(ptrn == null) ptrn = ct.addNewPatternFill(); + ptrn.setFgColor(color.getCTColor()); + } + + int idx = stylesSource.putFill(new XSSFCellFill(ct)); + + cellXf.setFillId(idx); + cellXf.setApplyFill(true); + } + + /** + * Set the foreground fill color as a indexed color value + *
+ * Note: Ensure Foreground color is set prior to background color. + * @param fg the color to use + * @see IndexedColors + */ + public void setFillForegroundColor(short fg) { + XSSFColor clr = new XSSFColor(); + clr.setIndexed(fg); + setFillForegroundColor(clr); + } + + /** + * Get a copy of the currently used CTFill, if none is used, return a new instance. + */ + private CTFill getCTFill(){ + CTFill ct; + if(cellXf.getApplyFill()) { + int fillIndex = (int)cellXf.getFillId(); + XSSFCellFill cf = stylesSource.getFillAt(fillIndex); + + ct = (CTFill)cf.getCTFill().copy(); + } else { + ct = CTFill.Factory.newInstance(); + } + return ct; + } + + /** + * Get a copy of the currently used CTBorder, if none is used, return a new instance. + */ + private CTBorder getCTBorder(){ + CTBorder ct; + if(cellXf.getApplyBorder()) { + int idx = (int)cellXf.getBorderId(); + XSSFCellBorder cf = stylesSource.getBorderAt(idx); + + ct = (CTBorder)cf.getCTBorder().copy(); + } else { + ct = CTBorder.Factory.newInstance(); + } + return ct; + } + + /** + * This element is used to specify cell fill information for pattern and solid color cell fills. + * For solid cell fills (no pattern), foregorund color is used. + * For cell fills with patterns specified, then the cell fill color is specified by the background color. + * + * @see #NO_FILL + * @see #SOLID_FOREGROUND + * @see #FINE_DOTS + * @see #ALT_BARS + * @see #SPARSE_DOTS + * @see #THICK_HORZ_BANDS + * @see #THICK_VERT_BANDS + * @see #THICK_BACKWARD_DIAG + * @see #THICK_FORWARD_DIAG + * @see #BIG_SPOTS + * @see #BRICKS + * @see #THIN_HORZ_BANDS + * @see #THIN_VERT_BANDS + * @see #THIN_BACKWARD_DIAG + * @see #THIN_FORWARD_DIAG + * @see #SQUARES + * @see #DIAMONDS + * @see #setFillBackgroundColor(short) + * @see #setFillForegroundColor(short) + * @param fp fill pattern (set to {@link #SOLID_FOREGROUND} to fill w/foreground color) + */ + public void setFillPattern(short fp) { + CTFill ct = getCTFill(); + CTPatternFill ptrn = ct.isSetPatternFill() ? ct.getPatternFill() : ct.addNewPatternFill(); + if(fp == NO_FILL && ptrn.isSetPatternType()) ptrn.unsetPatternType(); + else ptrn.setPatternType(STPatternType.Enum.forInt(fp + 1)); + + int idx = stylesSource.putFill(new XSSFCellFill(ct)); + + cellXf.setFillId(idx); + cellXf.setApplyFill(true); + } + + /** + * This element is used to specify cell fill information for pattern and solid color cell fills. For solid cell fills (no pattern), + * foreground color is used is used. For cell fills with patterns specified, then the cell fill color is specified by the background color element. + * + * @param ptrn the fill pattern to use + * @see #setFillBackgroundColor(short) + * @see #setFillForegroundColor(short) + * @see FillPatternType + */ + public void setFillPattern(FillPatternType ptrn) { + setFillPattern((short)ptrn.ordinal()); + } + + /** + * Set the font for this style + * + * @param font a font object created or retreived from the XSSFWorkbook object + * @see org.apache.poi.xssf.usermodel.XSSFWorkbook#createFont() + * @see org.apache.poi.xssf.usermodel.XSSFWorkbook#getFontAt(short) + */ public void setFont(Font font) { - if(font!=null){ - long index=this.stylesSource.putFont(font); + if(font != null){ + long index = font.getIndex(); this.cellXf.setFontId(index); + this.cellXf.setApplyFont(true); + } else { + this.cellXf.setApplyFont(false); } - this.cellXf.setApplyFont(true); } + /** + * Set the cell's using this style to be hidden + * + * @param hidden - whether the cell using this style should be hidden + */ public void setHidden(boolean hidden) { getCellProtection().setHidden(hidden); } + /** + * Set the number of spaces to indent the text in the cell + * + * @param indent - number of spaces + */ public void setIndention(short indent) { getCellAlignment().setIndent(indent); } + /** + * Set the color to use for the left border as a indexed color value + * + * @param color the index of the color definition + * @see IndexedColors + */ public void setLeftBorderColor(short color) { - setBorderColorIndexed(BorderSide.LEFT, color); + XSSFColor clr = new XSSFColor(); + clr.setIndexed(color); + setLeftBorderColor(clr); } - - private void setBorderColorIndexed(BorderSide side, XSSFColor color) { - this.cellBorder.setBorderColor(side, color); - } + /** + * Set the color to use for the left border as a {@link XSSFColor} value + * + * @param color the color to use + */ + public void setLeftBorderColor(XSSFColor color) { + CTBorder ct = getCTBorder(); + if(color == null && !ct.isSetLeft()) return; + + CTBorderPr pr = ct.isSetLeft() ? ct.getLeft() : ct.addNewLeft(); + if(color != null) pr.setColor(color.getCTColor()); + else pr.unsetColor(); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); + } + /** + * Set the cell's using this style to be locked + * + * @param locked - whether the cell using this style should be locked + */ public void setLocked(boolean locked) { getCellProtection().setLocked(locked); } - + /** + * Set the color to use for the right border + * + * @param color the index of the color definition + * @see IndexedColors + */ public void setRightBorderColor(short color) { - setBorderColorIndexed(BorderSide.RIGHT, color); + XSSFColor clr = new XSSFColor(); + clr.setIndexed(color); + setRightBorderColor(clr); } + /** + * Set the color to use for the right border as a {@link XSSFColor} value + * + * @param color the color to use + */ + public void setRightBorderColor(XSSFColor color) { + CTBorder ct = getCTBorder(); + if(color == null && !ct.isSetRight()) return; + + CTBorderPr pr = ct.isSetRight() ? ct.getRight() : ct.addNewRight(); + if(color != null) pr.setColor(color.getCTColor()); + else pr.unsetColor(); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); + } + + /** + * Set the degree of rotation for the text in the cell + *

+ * Expressed in degrees. Values range from 0 to 180. The first letter of + * the text is considered the center-point of the arc. + *
+ * For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the + * horizon is calculated as: + *
+ * [degrees below horizon] = 90 - textRotation. + *

+ * + * @param rotation - the rotation degrees (between 0 and 180 degrees) + */ public void setRotation(short rotation) { getCellAlignment().setTextRotation(rotation); } + + /** + * Set the color to use for the top border + * + * @param color the index of the color definition + * @see IndexedColors + */ public void setTopBorderColor(short color) { - setBorderColorIndexed(BorderSide.TOP, color); + XSSFColor clr = new XSSFColor(); + clr.setIndexed(color); + setTopBorderColor(clr); } + /** + * Set the color to use for the top border as a {@link XSSFColor} value + * + * @param color the color to use + */ + public void setTopBorderColor(XSSFColor color) { + CTBorder ct = getCTBorder(); + if(color == null && !ct.isSetTop()) return; + + CTBorderPr pr = ct.isSetTop() ? ct.getTop() : ct.addNewTop(); + if(color != null) pr.setColor(color.getCTColor()); + else pr.unsetColor(); + + int idx = stylesSource.putBorder(new XSSFCellBorder(ct)); + + cellXf.setBorderId(idx); + cellXf.setApplyBorder(true); + } + + /** + * Set the type of vertical alignment for the cell + * + * @param align - align the type of alignment + * @see #VERTICAL_TOP + * @see #VERTICAL_CENTER + * @see #VERTICAL_BOTTOM + * @see #VERTICAL_JUSTIFY + * @see VerticalAlignment + */ public void setVerticalAlignment(short align) { getCellAlignment().setVertical(VerticalAlignment.values()[align]); } + /** + * Set the type of vertical alignment for the cell + * + * @param align - the type of alignment + */ public void setVerticalAlignment(VerticalAlignment align) { getCellAlignment().setVertical(align); } + /** + * Set whether the text should be wrapped + * + * @param wrapped a boolean value indicating if the text in a cell should be line-wrapped within the cell. + */ public void setWrapText(boolean wrapped) { getCellAlignment().setWrapText(wrapped); } + /** + * Gets border color + * + * @param side the border side + * @return the used color + */ public XSSFColor getBorderColor(BorderSide side) { - return getCellBorder().getBorderColor(side); - } - - public void setBorderColor(BorderSide side, XSSFColor color) { - getCellBorder().setBorderColor(side, color); - } - - private XSSFCellBorder getCellBorder() { - if (cellBorder == null) { - // TODO make a common Cell Border object - int borderId=getBorderId(); - if(borderId==-1){ - cellBorder=new XSSFCellBorder(); - long index=((StylesTable)stylesSource).putBorder(cellBorder); - this.cellXf.setBorderId(index); - this.cellXf.setApplyBorder(true); - } - else{ - cellBorder = ((StylesTable)stylesSource).getBorderAt(borderId); - } + switch(side){ + case BOTTOM: + return getBottomBorderRgbColor(); + case RIGHT: + return getRightBorderRgbColor(); + case TOP: + return getTopBorderRgbColor(); + case LEFT: + return getLeftBorderRgbColor(); + default: + throw new IllegalArgumentException("Unknown border: " + side); } - return cellBorder; } - private int getBorderId() { - if (cellXf.isSetBorderId() && cellXf.getBorderId()>0) { - return (int) cellXf.getBorderId(); - } - return -1; - // return (int) cellStyleXf.getBorderId(); - } - - private XSSFCellFill getCellFill() { - if (cellFill == null) { - int fillId=getFillId(); - if(fillId == -1) { - cellFill=new XSSFCellFill(); - long index=((StylesTable)stylesSource).putFill(cellFill); - this.cellXf.setFillId(index); - this.cellXf.setApplyFill(true); - } - else{ - cellFill=((StylesTable)stylesSource).getFillAt(fillId); - } - } - return cellFill; - } - - private int getFillId() { - if (cellXf.isSetFillId() && cellXf.getFillId()>0) { - return (int) cellXf.getFillId(); + /** + * Set the color to use for the selected border + * + * @param side - where to apply the color definition + * @param color - the color to use + */ + public void setBorderColor(BorderSide side, XSSFColor color) { + switch(side){ + case BOTTOM: + setBottomBorderColor(color); + break; + case RIGHT: + setRightBorderColor(color); + break; + case TOP: + setTopBorderColor(color); + break; + case LEFT: + setLeftBorderColor(color); + break; } - //return (int) cellStyleXf.getFillId(); - return -1; } - private int getFontId() { if (cellXf.isSetFontId()) { return (int) cellXf.getFontId(); @@ -544,6 +1287,10 @@ public class XSSFCellStyle implements CellStyle { return (int) cellStyleXf.getFontId(); } + /** + * get a cellProtection from the supplied XML definition + * @return CTCellProtection + */ private CTCellProtection getCellProtection() { if (cellXf.getProtection() == null) { cellXf.addNewProtection(); @@ -551,13 +1298,22 @@ public class XSSFCellStyle implements CellStyle { return cellXf.getProtection(); } - public XSSFCellAlignment getCellAlignment() { + /** + * get the cellAlignment object to use for manage alignment + * @return XSSFCellAlignment - cell alignment + */ + protected XSSFCellAlignment getCellAlignment() { if (this.cellAlignment == null) { this.cellAlignment = new XSSFCellAlignment(getCTCellAlignment()); } return this.cellAlignment; } + /** + * Return the CTCellAlignment instance for alignment + * + * @return CTCellAlignment + */ private CTCellAlignment getCTCellAlignment() { if (cellXf.getAlignment() == null) { cellXf.setAlignment(CTCellAlignment.Factory.newInstance()); @@ -565,24 +1321,40 @@ public class XSSFCellStyle implements CellStyle { return cellXf.getAlignment(); } - private short getBorderColorIndexed(BorderSide side) { - return (short) getBorderColor(side).getIndexed(); + /** + * Returns a hash code value for the object. The hash is derived from the underlying CTXf bean. + * + * @return the hash code value for this style + */ + public int hashCode(){ + return cellXf.toString().hashCode(); } - private void setBorderColorIndexed(BorderSide side, int color) { - getBorderColor(side).setIndexed(color); - } + /** + * Checks is the supplied style is equal to this style + * + * @param o the style to check + * @return true if the supplied style is equal to this style + */ + public boolean equals(Object o){ + if(o == null || !(o instanceof XSSFCellStyle)) return false; - private short getBorderStyleAsShort(BorderSide side) { - return (short) (getBorderStyle(side).intValue() - 1); + XSSFCellStyle cf = (XSSFCellStyle)o; + return cellXf.toString().equals(cf.getCoreXf().toString()); } - private String getBorderStyleAsString(BorderSide side) { - return getBorderStyle(side).toString(); - } + /** + * Make a copy of this style. The underlying CTXf bean is cloned, + * the references to fills and borders remain. + * + * @return a copy of this style + */ + public Object clone(){ + CTXf xf = (CTXf)cellXf.copy(); - private STBorderStyle.Enum getBorderStyle(BorderSide side) { - return getCellBorder().getBorderStyle(side); + int xfSize = stylesSource._getStyleXfsSize(); + int indexXf = stylesSource.putCellXf(xf); + return new XSSFCellStyle(indexXf-1, xfSize-1, stylesSource); } } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java index cd66a65efd..0fe4861d69 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java @@ -20,6 +20,7 @@ import java.util.ArrayList; import org.apache.poi.ss.usermodel.Font; import org.apache.poi.xssf.usermodel.extensions.XSSFColor; +import org.apache.poi.xssf.model.StylesTable; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBooleanProperty; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFont; @@ -54,6 +55,7 @@ public class XSSFFont implements Font { public static final short DEFAULT_FONT_COLOR = IndexedColors.BLACK.getIndex(); private CTFont ctFont; + private short index; /** * Create a new XSSFFont @@ -62,6 +64,12 @@ public class XSSFFont implements Font { */ public XSSFFont(CTFont font) { this.ctFont = font; + this.index = 0; + } + + public XSSFFont(CTFont font, int index) { + this.ctFont = font; + this.index = (short)index; } /** @@ -69,6 +77,8 @@ public class XSSFFont implements Font { */ protected XSSFFont() { this.ctFont = CTFont.Factory.newInstance(); + setFontName(DEFAULT_FONT_NAME); + setFontHeight(DEFAULT_FONT_SIZE); } /** @@ -130,8 +140,7 @@ public class XSSFFont implements Font { */ public XSSFColor getRgbColor() { CTColor ctColor = ctFont.sizeOfColorArray() == 0 ? null : ctFont.getColorArray(0); - XSSFColor color = new XSSFColor(ctColor); - return color; + return ctColor == null ? null : new XSSFColor(ctColor); } @@ -180,7 +189,7 @@ public class XSSFFont implements Font { */ public String getFontName() { CTFontName name = ctFont.sizeOfNameArray() == 0 ? null : ctFont.getNameArray(0); - return name == null ? null : name.getVal(); + return name == null ? DEFAULT_FONT_NAME : name.getVal(); } /** @@ -265,8 +274,29 @@ public class XSSFFont implements Font { * @param bold - boldness to use */ public void setBold(boolean bold) { - CTBooleanProperty ctBold = ctFont.sizeOfBArray() == 0 ? ctFont.addNewB() : ctFont.getBArray(0); - ctBold.setVal(true); + if(bold){ + CTBooleanProperty ctBold = ctFont.sizeOfBArray() == 0 ? ctFont.addNewB() : ctFont.getBArray(0); + ctBold.setVal(bold); + } else { + ctFont.setBArray(null); + } + } + + public void setBoldweight(short boldweight) + { + setBold(boldweight == BOLDWEIGHT_BOLD); + } + + /** + * get the boldness to use + * @return boldweight + * @see #BOLDWEIGHT_NORMAL + * @see #BOLDWEIGHT_BOLD + */ + + public short getBoldweight() + { + return getBold() ? BOLDWEIGHT_BOLD : BOLDWEIGHT_NORMAL; } /** @@ -323,6 +353,10 @@ public class XSSFFont implements Font { ctColor.setIndexed(color); } } + public void setColor(XSSFColor color) { + if(color == null) ctFont.setColorArray(null); + else ctFont.setColorArray(new CTColor[]{color.getCTColor()}); + } /** * set the font height in points. @@ -385,7 +419,7 @@ public class XSSFFont implements Font { */ public void setFontName(String name) { CTFontName fontName = ctFont.sizeOfNameArray() == 0 ? ctFont.addNewName() : ctFont.getNameArray(0); - fontName.setVal(name); + fontName.setVal(name == null ? DEFAULT_FONT_NAME : name); } @@ -396,8 +430,12 @@ public class XSSFFont implements Font { * @param italic - value for italics or not */ public void setItalic(boolean italic) { - CTBooleanProperty bool = ctFont.sizeOfIArray() == 0 ? ctFont.addNewI() : ctFont.getIArray(0); - bool.setVal(italic); + if(italic){ + CTBooleanProperty bool = ctFont.sizeOfIArray() == 0 ? ctFont.addNewI() : ctFont.getIArray(0); + bool.setVal(italic); + } else { + ctFont.setIArray(null); + } } @@ -408,8 +446,11 @@ public class XSSFFont implements Font { * @param strikeout - value for strikeout or not */ public void setStrikeout(boolean strikeout) { - CTBooleanProperty strike = ctFont.sizeOfStrikeArray() == 0 ? ctFont.addNewStrike() : ctFont.getStrikeArray(0); - strike.setVal(strikeout); + if(!strikeout) ctFont.setStrikeArray(null); + else { + CTBooleanProperty strike = ctFont.sizeOfStrikeArray() == 0 ? ctFont.addNewStrike() : ctFont.getStrikeArray(0); + strike.setVal(strikeout); + } } /** @@ -423,17 +464,21 @@ public class XSSFFont implements Font { * @see #SS_SUB */ public void setTypeOffset(short offset) { - CTVerticalAlignFontProperty offsetProperty = ctFont.sizeOfVertAlignArray() == 0 ? ctFont.addNewVertAlign() : ctFont.getVertAlignArray(0); - switch (offset) { - case Font.SS_NONE: - offsetProperty.setVal(STVerticalAlignRun.BASELINE); - break; - case Font.SS_SUB: - offsetProperty.setVal(STVerticalAlignRun.SUBSCRIPT); - break; - case Font.SS_SUPER: - offsetProperty.setVal(STVerticalAlignRun.SUPERSCRIPT); - break; + if(offset == Font.SS_NONE){ + ctFont.setVertAlignArray(null); + } else { + CTVerticalAlignFontProperty offsetProperty = ctFont.sizeOfVertAlignArray() == 0 ? ctFont.addNewVertAlign() : ctFont.getVertAlignArray(0); + switch (offset) { + case Font.SS_NONE: + offsetProperty.setVal(STVerticalAlignRun.BASELINE); + break; + case Font.SS_SUB: + offsetProperty.setVal(STVerticalAlignRun.SUBSCRIPT); + break; + case Font.SS_SUPER: + offsetProperty.setVal(STVerticalAlignRun.SUPERSCRIPT); + break; + } } } @@ -445,24 +490,25 @@ public class XSSFFont implements Font { * @see FontUnderline */ public void setUnderline(byte underline) { - CTUnderlineProperty ctUnderline = ctFont.sizeOfUArray() == 0 ? ctFont.addNewU() : ctFont.getUArray(0); - switch (underline) { - case Font.U_DOUBLE: - ctUnderline.setVal(FontUnderline.DOUBLE.getValue()); - break; - case Font.U_DOUBLE_ACCOUNTING: - ctUnderline.setVal(FontUnderline.DOUBLE_ACCOUNTING.getValue()); - break; - case Font.U_SINGLE_ACCOUNTING: - ctUnderline.setVal(FontUnderline.SINGLE_ACCOUNTING.getValue()); - break; - case Font.U_NONE: - ctUnderline.setVal(FontUnderline.NONE.getValue()); - break; - case Font.U_SINGLE: - default: - ctUnderline.setVal(FontUnderline.SINGLE.getValue()); - break; + if(underline == Font.U_NONE) { + ctFont.setUArray(null); + } else { + CTUnderlineProperty ctUnderline = ctFont.sizeOfUArray() == 0 ? ctFont.addNewU() : ctFont.getUArray(0); + switch (underline) { + case Font.U_DOUBLE: + ctUnderline.setVal(FontUnderline.DOUBLE.getValue()); + break; + case Font.U_DOUBLE_ACCOUNTING: + ctUnderline.setVal(FontUnderline.DOUBLE_ACCOUNTING.getValue()); + break; + case Font.U_SINGLE_ACCOUNTING: + ctUnderline.setVal(FontUnderline.SINGLE_ACCOUNTING.getValue()); + break; + case Font.U_SINGLE: + default: + ctUnderline.setVal(FontUnderline.NONE.getValue()); + break; + } } } @@ -486,18 +532,13 @@ public class XSSFFont implements Font { } - public long putFont(ArrayList fonts) { - //TODO - /* - * we need to implement a method equals to check that 2 instances of CTFont - * are different by comparison of all font attributes. - * NB: take a look to findFont method in XSSFWorkbook - */ - if (fonts.contains(ctFont)) { - return fonts.indexOf(ctFont); - } - fonts.add(ctFont); - return fonts.size() - 1; + /** + * Register ourselfs in the style table + */ + public long putFont(StylesTable styles) { + short idx = (short)styles.putFont(this); + this.index = idx; + return idx; } /** @@ -558,5 +599,26 @@ public class XSSFFont implements Font { setFamily(family.getValue()); } + /** + * get the index within the XSSFWorkbook (sequence within the collection of Font objects) + * @return unique index number of the underlying record this Font represents (probably you don't care + * unless you're comparing which one is which) + */ + + public short getIndex() + { + return index; + } + + public int hashCode(){ + return ctFont.toString().hashCode(); + } + + public boolean equals(Object o){ + if(!(o instanceof XSSFFont)) return false; + + XSSFFont cf = (XSSFFont)o; + return ctFont.toString().equals(cf.getCTFont().toString()); + } } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java index 002e63d4c0..674a422440 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java @@ -30,7 +30,6 @@ import org.apache.poi.ss.usermodel.Palette; import org.apache.poi.ss.usermodel.PictureData; import org.apache.poi.ss.usermodel.Row; import org.apache.poi.ss.usermodel.Sheet; -import org.apache.poi.ss.usermodel.StylesSource; import org.apache.poi.ss.usermodel.Workbook; import org.apache.poi.ss.usermodel.Row.MissingCellPolicy; import org.apache.poi.util.POILogFactory; @@ -77,7 +76,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable shIdMap = new HashMap(); for(POIXMLDocumentPart p : getRelations()){ if(p instanceof SharedStringsTable) sharedStringSource = (SharedStringsTable)p; - else if(p instanceof StylesSource) stylesSource = (StylesSource)p; + else if(p instanceof StylesTable) stylesSource = (StylesTable)p; else if (p instanceof XSSFSheet) { shIdMap.put(p.getPackageRelationship().getId(), (XSSFSheet)p); } @@ -300,9 +299,9 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable borders) { - if(borders.contains(border)) { - return borders.indexOf(border); - } - borders.add(border); - return borders.size() - 1; - } - - public STBorderStyle.Enum getBorderStyle(BorderSide side) { - return getBorder(side).getStyle(); - } - - public void setBorderStyle(BorderSide side, STBorderStyle.Enum style) { - getBorder(side).setStyle(style); - } - - public XSSFColor getBorderColor(BorderSide side) { - CTBorderPr borderPr = getBorder(side); - if (!borderPr.isSetColor()) { - borderPr.addNewColor(); - } - return new XSSFColor(getBorder(side).getColor()); - } - - public void setBorderColor(BorderSide side, XSSFColor color) { - getBorder(side).setColor(color.getCTColor()); - } - - private CTBorderPr getBorder(BorderSide side) { - switch (side) { - case TOP: { - CTBorderPr borderPr = border.isSetTop() ? border.getTop() : border.addNewTop(); - return borderPr; - } - case RIGHT: { - CTBorderPr borderPr = border.isSetRight() ? border.getRight() : border.addNewRight(); - return borderPr; - } - case BOTTOM:{ - CTBorderPr borderPr = border.isSetBottom() ? border.getBottom() : border.addNewBottom(); - return borderPr; - } - case LEFT:{ - CTBorderPr borderPr = border.isSetLeft() ? border.getLeft() : border.addNewLeft(); - return borderPr; - } - default: throw new IllegalArgumentException("No suitable side specified for the border"); - } - } + + private CTBorder border; + + /** + * Creates a Cell Border from the supplied XML definition + */ + public XSSFCellBorder(CTBorder border) { + this.border = border; + } + /** + * Creates a new, empty Cell Border, on the + * given Styles Table + */ + public XSSFCellBorder() { + border = CTBorder.Factory.newInstance(); + } + + public static enum BorderSide { + TOP, RIGHT, BOTTOM, LEFT + } + + public CTBorder getCTBorder() { + return border; + } + + public BorderStyle getBorderStyle(BorderSide side) { + CTBorderPr ctBorder = getBorder(side); + STBorderStyle.Enum border = ctBorder == null ? STBorderStyle.NONE : ctBorder.getStyle(); + return BorderStyle.values()[border.intValue() - 1]; + } + + public void setBorderStyle(BorderSide side, BorderStyle style) { + getBorder(side, true).setStyle(STBorderStyle.Enum.forInt(style.ordinal() + 1)); + } + + public XSSFColor getBorderColor(BorderSide side) { + CTBorderPr borderPr = getBorder(side); + return borderPr != null && borderPr.isSetColor() ? + new XSSFColor(borderPr.getColor()) : null; + } + + public void setBorderColor(BorderSide side, XSSFColor color) { + CTBorderPr borderPr = getBorder(side, true); + if(color == null) borderPr.unsetColor(); + else borderPr.setColor(color.getCTColor()); + } + + private CTBorderPr getBorder(BorderSide side) { + return getBorder(side, false); + } + + private CTBorderPr getBorder(BorderSide side, boolean ensure) { + CTBorderPr borderPr; + switch (side) { + case TOP: + borderPr = border.getTop(); + if(ensure && borderPr == null) borderPr = border.addNewTop(); + break; + case RIGHT: + borderPr = border.getRight(); + if(ensure && borderPr == null) borderPr = border.addNewRight(); + break; + case BOTTOM: + borderPr = border.getBottom(); + if(ensure && borderPr == null) borderPr = border.addNewBottom(); + break; + case LEFT: + borderPr = border.getLeft(); + if(ensure && borderPr == null) borderPr = border.addNewLeft(); + break; + default: + throw new IllegalArgumentException("No suitable side specified for the border"); + } + return borderPr; + } + + + public int hashCode(){ + return border.toString().hashCode(); + } + + public boolean equals(Object o){ + if(!(o instanceof XSSFCellBorder)) return false; + + XSSFCellBorder cf = (XSSFCellBorder)o; + return border.toString().equals(cf.getCTBorder().toString()); + } + } \ No newline at end of file diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java index 53bb41f0f6..29a9d08654 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellFill.java @@ -22,6 +22,7 @@ import org.apache.poi.xssf.usermodel.IndexedColors; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPatternFill; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType; import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType.Enum; public final class XSSFCellFill { @@ -37,41 +38,54 @@ public final class XSSFCellFill { } public XSSFColor getFillBackgroundColor() { - CTColor ctColor = getPatternFill().getBgColor(); - if (ctColor == null) { - XSSFColor result = new XSSFColor(); - result.setIndexed(IndexedColors.AUTOMATIC.getIndex()); - return result; - } - return new XSSFColor(ctColor); - } + CTPatternFill ptrn = _fill.getPatternFill(); + if(ptrn == null) return null; - public XSSFColor getFillForegroundColor() { - CTColor ctColor = getPatternFill().getFgColor(); - if (ctColor == null) { - XSSFColor result = new XSSFColor(); - result.setIndexed(IndexedColors.AUTOMATIC.getIndex()); - return result; - } - return new XSSFColor(ctColor); + CTColor ctColor = ptrn.getBgColor(); + return ctColor == null ? null : new XSSFColor(ctColor); } - public Enum getPatternType() { - return getPatternFill().getPatternType(); - } - - /** - * @return the index of the just added fill - */ - public int putFill(List fills) { - if (fills.contains(_fill)) { - return fills.indexOf(_fill); - } - fills.add(_fill); - return fills.size() - 1; + public void setFillBackgroundColor(int index) { + CTPatternFill ptrn = ensureCTPatternFill(); + CTColor ctColor = ptrn.isSetBgColor() ? ptrn.getBgColor() : ptrn.addNewBgColor(); + ctColor.setIndexed(index); + } + + public void setFillBackgroundColor(XSSFColor color) { + CTPatternFill ptrn = ensureCTPatternFill(); + ptrn.setBgColor(color.getCTColor()); + } + + public XSSFColor getFillForegroundColor() { + CTPatternFill ptrn = _fill.getPatternFill(); + if(ptrn == null) return null; + + CTColor ctColor = ptrn.getFgColor(); + return ctColor == null ? null : new XSSFColor(ctColor); + } + + public void setFillForegroundColor(int index) { + CTPatternFill ptrn = ensureCTPatternFill(); + CTColor ctColor = ptrn.isSetFgColor() ? ptrn.getFgColor() : ptrn.addNewFgColor(); + ctColor.setIndexed(index); + } + + public void setFillForegroundColor(XSSFColor color) { + CTPatternFill ptrn = ensureCTPatternFill(); + ptrn.setFgColor(color.getCTColor()); + } + + public STPatternType.Enum getPatternType() { + CTPatternFill ptrn = _fill.getPatternFill(); + return ptrn == null ? null : ptrn.getPatternType(); } - private CTPatternFill getPatternFill() { + public void setPatternType(STPatternType.Enum patternType) { + CTPatternFill ptrn = ensureCTPatternFill(); + ptrn.setPatternType(patternType); + } + + private CTPatternFill ensureCTPatternFill() { CTPatternFill patternFill = _fill.getPatternFill(); if (patternFill == null) { patternFill = _fill.addNewPatternFill(); @@ -83,27 +97,14 @@ public final class XSSFCellFill { return _fill; } - public void setFillBackgroundColor(long index) { - CTColor ctColor=getPatternFill().addNewBgColor(); - ctColor.setIndexed(index); - _fill.getPatternFill().setBgColor(ctColor); - } + public int hashCode(){ + return _fill.toString().hashCode(); + } - public void setFillForegroundColor(long index) { - CTColor ctColor=getPatternFill().addNewFgColor(); - ctColor.setIndexed(index); - _fill.getPatternFill().setFgColor(ctColor); - } - - public void setFillBackgroundRgbColor(XSSFColor color) { - _fill.getPatternFill().setBgColor(color.getCTColor()); - } + public boolean equals(Object o){ + if(!(o instanceof XSSFCellFill)) return false; - public void setFillForegroundRgbColor(XSSFColor color) { - _fill.getPatternFill().setFgColor(color.getCTColor()); - } - - public void setPatternType(Enum patternType) { - getPatternFill().setPatternType(patternType); - } + XSSFCellFill cf = (XSSFCellFill)o; + return _fill.toString().equals(cf.getCTFill().toString()); + } } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFColor.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFColor.java index 8b2d0e7062..56a1312a4e 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFColor.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFColor.java @@ -39,6 +39,11 @@ public class XSSFColor { this.ctColor = CTColor.Factory.newInstance(); } + public XSSFColor(java.awt.Color clr) { + this(); + ctColor.setRgb(new byte[]{(byte)clr.getRed(), (byte)clr.getGreen(), (byte)clr.getBlue()}); + } + /** * A boolean value indicating the ctColor is automatic and system ctColor dependent. */ @@ -56,8 +61,8 @@ public class XSSFColor { /** * Indexed ctColor value. Only used for backwards compatibility. References a ctColor in indexedColors. */ - public int getIndexed() { - return (int)ctColor.getIndexed(); + public short getIndexed() { + return (short)ctColor.getIndexed(); } /** @@ -195,4 +200,16 @@ public class XSSFColor { public CTColor getCTColor(){ return ctColor; } + + public int hashCode(){ + return ctColor.toString().hashCode(); + } + + public boolean equals(Object o){ + if(!(o instanceof XSSFColor)) return false; + + XSSFColor cf = (XSSFColor)o; + return ctColor.toString().equals(cf.getCTColor().toString()); + } + } diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFCellStyle.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFCellStyle.java index e1207d681d..87aec4bc85 100644 --- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFCellStyle.java +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFCellStyle.java @@ -26,12 +26,13 @@ import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder; import org.apache.poi.xssf.usermodel.extensions.XSSFCellFill; import org.apache.poi.xssf.usermodel.extensions.XSSFColor; import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide; +import org.apache.poi.hssf.usermodel.HSSFWorkbook; +import org.apache.poi.hssf.usermodel.HSSFCellStyle; import org.openxmlformats.schemas.spreadsheetml.x2006.main.*; public class TestXSSFCellStyle extends TestCase { - private static final int AUTO_COLOR_INDEX = 64; private StylesTable stylesTable; private CTBorder ctBorderA; private CTFill ctFill; @@ -48,14 +49,13 @@ public class TestXSSFCellStyle extends TestCase { ctStylesheet = stylesTable._getRawStylesheet(); - // Until we do XSSFBorder properly, cheat ctBorderA = CTBorder.Factory.newInstance(); XSSFCellBorder borderA = new XSSFCellBorder(ctBorderA); long borderId = stylesTable.putBorder(borderA); assertEquals(1, borderId); XSSFCellBorder borderB = new XSSFCellBorder(); - assertEquals(2, stylesTable.putBorder(borderB)); + assertEquals(1, stylesTable.putBorder(borderB)); ctFill = CTFill.Factory.newInstance(); XSSFCellFill fill = new XSSFCellFill(ctFill); @@ -84,225 +84,430 @@ public class TestXSSFCellStyle extends TestCase { } public void testGetSetBorderBottom() { - ctBorderA.addNewBottom().setStyle(STBorderStyle.THIN); - assertEquals((short)1, cellStyle.getBorderBottom()); - cellStyle.setBorderBottom((short) 2); - assertEquals(STBorderStyle.THIN, ctBorderA.getBottom().getStyle()); - cellStyle.setBorderBottomEnum(STBorderStyle.THICK); - assertEquals(6, ctBorderA.getBottom().getStyle().intValue()); - } - - public void testGetBorderBottomAsString() { - ctBorderA.addNewBottom().setStyle(STBorderStyle.THIN); - assertEquals("thin", cellStyle.getBorderBottomAsString()); - } - - public void testGetSetBorderRight() { - ctBorderA.addNewRight().setStyle(STBorderStyle.MEDIUM); - assertEquals((short)2, cellStyle.getBorderRight()); - cellStyle.setBorderRight((short) 2); - assertEquals(STBorderStyle.THIN, ctBorderA.getRight().getStyle()); - cellStyle.setBorderRightEnum(STBorderStyle.THICK); - assertEquals(6, ctBorderA.getRight().getStyle().intValue()); - } - - public void testGetBorderRightAsString() { - ctBorderA.addNewRight().setStyle(STBorderStyle.MEDIUM); - assertEquals("medium", cellStyle.getBorderRightAsString()); - } + //default values + assertEquals(CellStyle.BORDER_NONE, cellStyle.getBorderBottom()); + + int num = stylesTable.getBorders().size(); + cellStyle.setBorderBottom(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderBottom()); + //a new border has been added + assertEquals(num + 1, stylesTable.getBorders().size()); + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(STBorderStyle.MEDIUM, ctBorder.getBottom().getStyle()); + + num = stylesTable.getBorders().size(); + //setting the same border multiple times should not change borderId + for (int i = 0; i < 3; i++) { + cellStyle.setBorderBottom(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderBottom()); + } + assertEquals(borderId, cellStyle.getCoreXf().getBorderId()); + assertEquals(num, stylesTable.getBorders().size()); + assertSame(ctBorder, stylesTable.getBorderAt(borderId).getCTBorder()); + + //setting border to none removes the element + cellStyle.setBorderBottom(CellStyle.BORDER_NONE); + assertEquals(num, stylesTable.getBorders().size()); + borderId = (int)cellStyle.getCoreXf().getBorderId(); + ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertFalse(ctBorder.isSetBottom()); + } + + public void testGetSetBorderRight() { + //default values + assertEquals(CellStyle.BORDER_NONE, cellStyle.getBorderRight()); + + int num = stylesTable.getBorders().size(); + cellStyle.setBorderRight(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderRight()); + //a new border has been added + assertEquals(num + 1, stylesTable.getBorders().size()); + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(STBorderStyle.MEDIUM, ctBorder.getRight().getStyle()); + + num = stylesTable.getBorders().size(); + //setting the same border multiple times should not change borderId + for (int i = 0; i < 3; i++) { + cellStyle.setBorderRight(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderRight()); + } + assertEquals(borderId, cellStyle.getCoreXf().getBorderId()); + assertEquals(num, stylesTable.getBorders().size()); + assertSame(ctBorder, stylesTable.getBorderAt(borderId).getCTBorder()); + + //setting border to none removes the element + cellStyle.setBorderRight(CellStyle.BORDER_NONE); + assertEquals(num, stylesTable.getBorders().size()); + borderId = (int)cellStyle.getCoreXf().getBorderId(); + ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertFalse(ctBorder.isSetRight()); + } public void testGetSetBorderLeft() { - ctBorderA.addNewLeft().setStyle(STBorderStyle.DASHED); - assertEquals((short)3, cellStyle.getBorderLeft()); - cellStyle.setBorderLeft((short) 2); - assertEquals(STBorderStyle.THIN, ctBorderA.getLeft().getStyle()); - cellStyle.setBorderLeftEnum(STBorderStyle.THICK); - assertEquals(6, ctBorderA.getLeft().getStyle().intValue()); - } - - public void testGetBorderLeftAsString() { - ctBorderA.addNewLeft().setStyle(STBorderStyle.DASHED); - assertEquals("dashed", cellStyle.getBorderLeftAsString()); + //default values + assertEquals(CellStyle.BORDER_NONE, cellStyle.getBorderLeft()); + + int num = stylesTable.getBorders().size(); + cellStyle.setBorderLeft(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderLeft()); + //a new border has been added + assertEquals(num + 1, stylesTable.getBorders().size()); + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(STBorderStyle.MEDIUM, ctBorder.getLeft().getStyle()); + + num = stylesTable.getBorders().size(); + //setting the same border multiple times should not change borderId + for (int i = 0; i < 3; i++) { + cellStyle.setBorderLeft(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderLeft()); + } + assertEquals(borderId, cellStyle.getCoreXf().getBorderId()); + assertEquals(num, stylesTable.getBorders().size()); + assertSame(ctBorder, stylesTable.getBorderAt(borderId).getCTBorder()); + + //setting border to none removes the element + cellStyle.setBorderLeft(CellStyle.BORDER_NONE); + assertEquals(num, stylesTable.getBorders().size()); + borderId = (int)cellStyle.getCoreXf().getBorderId(); + ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertFalse(ctBorder.isSetLeft()); } public void testGetSetBorderTop() { - ctBorderA.addNewTop().setStyle(STBorderStyle.HAIR); - assertEquals((short)7, cellStyle.getBorderTop()); - cellStyle.setBorderTop((short) 2); - assertEquals(STBorderStyle.THIN, ctBorderA.getTop().getStyle()); - cellStyle.setBorderTopEnum(STBorderStyle.THICK); - assertEquals(6, ctBorderA.getTop().getStyle().intValue()); - } - - public void testGetBorderTopAsString() { - ctBorderA.addNewTop().setStyle(STBorderStyle.HAIR); - assertEquals("hair", cellStyle.getBorderTopAsString()); + //default values + assertEquals(CellStyle.BORDER_NONE, cellStyle.getBorderTop()); + + int num = stylesTable.getBorders().size(); + cellStyle.setBorderTop(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderTop()); + //a new border has been added + assertEquals(num + 1, stylesTable.getBorders().size()); + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(STBorderStyle.MEDIUM, ctBorder.getTop().getStyle()); + + num = stylesTable.getBorders().size(); + //setting the same border multiple times should not change borderId + for (int i = 0; i < 3; i++) { + cellStyle.setBorderTop(CellStyle.BORDER_MEDIUM); + assertEquals(CellStyle.BORDER_MEDIUM, cellStyle.getBorderTop()); + } + assertEquals(borderId, cellStyle.getCoreXf().getBorderId()); + assertEquals(num, stylesTable.getBorders().size()); + assertSame(ctBorder, stylesTable.getBorderAt(borderId).getCTBorder()); + + //setting border to none removes the element + cellStyle.setBorderTop(CellStyle.BORDER_NONE); + assertEquals(num, stylesTable.getBorders().size()); + borderId = (int)cellStyle.getCoreXf().getBorderId(); + ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertFalse(ctBorder.isSetTop()); } public void testGetSetBottomBorderColor() { - CTColor ctColor = ctBorderA.addNewBottom().addNewColor(); - ctColor.setIndexed(2); - assertEquals((short)2, cellStyle.getBottomBorderColor()); - CTColor anotherCtColor = CTColor.Factory.newInstance(); - anotherCtColor.setIndexed(4); - anotherCtColor.setTheme(3); - anotherCtColor.setRgb("1234".getBytes()); - XSSFColor anotherColor = new XSSFColor(anotherCtColor); - cellStyle.setBorderColor(BorderSide.BOTTOM, anotherColor); - assertEquals((short)4, cellStyle.getBottomBorderColor()); - assertEquals("1234", new String(cellStyle.getBorderColor(BorderSide.BOTTOM).getRgb())); - } + //defaults + assertEquals(IndexedColors.BLACK.getIndex(), cellStyle.getBottomBorderColor()); + assertNull(cellStyle.getBottomBorderRgbColor()); + + int num = stylesTable.getBorders().size(); + + XSSFColor clr; + + //setting indexed color + cellStyle.setBottomBorderColor(IndexedColors.BLUE_GREY.getIndex()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), cellStyle.getBottomBorderColor()); + clr = cellStyle.getBottomBorderRgbColor(); + assertTrue(clr.getCTColor().isSetIndexed()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), clr.getIndexed()); + //a new border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), ctBorder.getBottom().getColor().getIndexed()); + + //setting XSSFColor + num = stylesTable.getBorders().size(); + clr = new XSSFColor(java.awt.Color.CYAN); + cellStyle.setBottomBorderColor(clr); + assertEquals(clr.getCTColor().toString(), cellStyle.getBottomBorderRgbColor().getCTColor().toString()); + byte[] rgb = cellStyle.getBottomBorderRgbColor().getRgb(); + assertEquals(java.awt.Color.CYAN, new java.awt.Color(rgb[0] & 0xFF, rgb[1] & 0xFF, rgb[2] & 0xFF)); + //another border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //passing null unsets the color + cellStyle.setBottomBorderColor(null); + assertNull(cellStyle.getBottomBorderRgbColor()); + } public void testGetSetTopBorderColor() { - CTColor ctColor = ctBorderA.addNewTop().addNewColor(); - ctColor.setIndexed(5); - assertEquals((short)5, cellStyle.getTopBorderColor()); - CTColor anotherCtColor = CTColor.Factory.newInstance(); - anotherCtColor.setIndexed(7); - anotherCtColor.setTheme(3); - anotherCtColor.setRgb("abcd".getBytes()); - XSSFColor anotherColor = new XSSFColor(anotherCtColor); - cellStyle.setBorderColor(BorderSide.TOP, anotherColor); - assertEquals((short)7, cellStyle.getTopBorderColor()); - assertEquals("abcd", new String(cellStyle.getBorderColor(BorderSide.TOP).getRgb())); + //defaults + assertEquals(IndexedColors.BLACK.getIndex(), cellStyle.getTopBorderColor()); + assertNull(cellStyle.getTopBorderRgbColor()); + + int num = stylesTable.getBorders().size(); + + XSSFColor clr; + + //setting indexed color + cellStyle.setTopBorderColor(IndexedColors.BLUE_GREY.getIndex()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), cellStyle.getTopBorderColor()); + clr = cellStyle.getTopBorderRgbColor(); + assertTrue(clr.getCTColor().isSetIndexed()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), clr.getIndexed()); + //a new border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), ctBorder.getTop().getColor().getIndexed()); + + //setting XSSFColor + num = stylesTable.getBorders().size(); + clr = new XSSFColor(java.awt.Color.CYAN); + cellStyle.setTopBorderColor(clr); + assertEquals(clr.getCTColor().toString(), cellStyle.getTopBorderRgbColor().getCTColor().toString()); + byte[] rgb = cellStyle.getTopBorderRgbColor().getRgb(); + assertEquals(java.awt.Color.CYAN, new java.awt.Color(rgb[0] & 0xFF, rgb[1] & 0xFF, rgb[2] & 0xFF)); + //another border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //passing null unsets the color + cellStyle.setTopBorderColor(null); + assertNull(cellStyle.getTopBorderRgbColor()); } public void testGetSetLeftBorderColor() { - CTColor ctColor = ctBorderA.addNewLeft().addNewColor(); - ctColor.setIndexed(2); - assertEquals((short)2, cellStyle.getLeftBorderColor()); - CTColor anotherCtColor = CTColor.Factory.newInstance(); - anotherCtColor.setIndexed(4); - anotherCtColor.setTheme(3); - anotherCtColor.setRgb("1234".getBytes()); - XSSFColor anotherColor = new XSSFColor(anotherCtColor); - cellStyle.setBorderColor(BorderSide.LEFT, anotherColor); - assertEquals((short)4, cellStyle.getLeftBorderColor()); - assertEquals("1234", new String(cellStyle.getBorderColor(BorderSide.LEFT).getRgb())); + //defaults + assertEquals(IndexedColors.BLACK.getIndex(), cellStyle.getLeftBorderColor()); + assertNull(cellStyle.getLeftBorderRgbColor()); + + int num = stylesTable.getBorders().size(); + + XSSFColor clr; + + //setting indexed color + cellStyle.setLeftBorderColor(IndexedColors.BLUE_GREY.getIndex()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), cellStyle.getLeftBorderColor()); + clr = cellStyle.getLeftBorderRgbColor(); + assertTrue(clr.getCTColor().isSetIndexed()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), clr.getIndexed()); + //a new border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), ctBorder.getLeft().getColor().getIndexed()); + + //setting XSSFColor + num = stylesTable.getBorders().size(); + clr = new XSSFColor(java.awt.Color.CYAN); + cellStyle.setLeftBorderColor(clr); + assertEquals(clr.getCTColor().toString(), cellStyle.getLeftBorderRgbColor().getCTColor().toString()); + byte[] rgb = cellStyle.getLeftBorderRgbColor().getRgb(); + assertEquals(java.awt.Color.CYAN, new java.awt.Color(rgb[0] & 0xFF, rgb[1] & 0xFF, rgb[2] & 0xFF)); + //another border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //passing null unsets the color + cellStyle.setLeftBorderColor(null); + assertNull(cellStyle.getLeftBorderRgbColor()); } public void testGetSetRightBorderColor() { - CTColor ctColor = ctBorderA.addNewRight().addNewColor(); - ctColor.setIndexed(8); - assertEquals((short)8, cellStyle.getRightBorderColor()); - CTColor anotherCtColor = CTColor.Factory.newInstance(); - anotherCtColor.setIndexed(14); - anotherCtColor.setTheme(3); - anotherCtColor.setRgb("af67".getBytes()); - XSSFColor anotherColor = new XSSFColor(anotherCtColor); - cellStyle.setBorderColor(BorderSide.RIGHT, anotherColor); - assertEquals((short)14, cellStyle.getRightBorderColor()); - assertEquals("af67", new String(cellStyle.getBorderColor(BorderSide.RIGHT).getRgb())); + //defaults + assertEquals(IndexedColors.BLACK.getIndex(), cellStyle.getRightBorderColor()); + assertNull(cellStyle.getRightBorderRgbColor()); + + int num = stylesTable.getBorders().size(); + + XSSFColor clr; + + //setting indexed color + cellStyle.setRightBorderColor(IndexedColors.BLUE_GREY.getIndex()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), cellStyle.getRightBorderColor()); + clr = cellStyle.getRightBorderRgbColor(); + assertTrue(clr.getCTColor().isSetIndexed()); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), clr.getIndexed()); + //a new border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //id of the created border + int borderId = (int)cellStyle.getCoreXf().getBorderId(); + assertTrue(borderId > 0); + //check changes in the underlying xml bean + CTBorder ctBorder = stylesTable.getBorderAt(borderId).getCTBorder(); + assertEquals(IndexedColors.BLUE_GREY.getIndex(), ctBorder.getRight().getColor().getIndexed()); + + //setting XSSFColor + num = stylesTable.getBorders().size(); + clr = new XSSFColor(java.awt.Color.CYAN); + cellStyle.setRightBorderColor(clr); + assertEquals(clr.getCTColor().toString(), cellStyle.getRightBorderRgbColor().getCTColor().toString()); + byte[] rgb = cellStyle.getRightBorderRgbColor().getRgb(); + assertEquals(java.awt.Color.CYAN, new java.awt.Color(rgb[0] & 0xFF, rgb[1] & 0xFF, rgb[2] & 0xFF)); + //another border was added to the styles table + assertEquals(num + 1, stylesTable.getBorders().size()); + + //passing null unsets the color + cellStyle.setRightBorderColor(null); + assertNull(cellStyle.getRightBorderRgbColor()); } - public void testGetFillBackgroundColor() { - - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - CTColor ctBgColor = ctPatternFill.addNewBgColor(); - ctBgColor.setIndexed(IndexedColors.BRIGHT_GREEN.getIndex()); - ctPatternFill.setBgColor(ctBgColor); - - XSSFCellFill cellFill=new XSSFCellFill(ctFill); - long index=stylesTable.putFill(cellFill); - cellStyle.getCoreXf().setFillId(index); - - assertEquals(2,cellStyle.getCoreXf().getFillId()); - assertEquals(IndexedColors.BRIGHT_GREEN.getIndex(), cellStyle.getFillBackgroundColor()); - - cellStyle.setFillBackgroundColor(IndexedColors.BLUE.getIndex()); - assertEquals(IndexedColors.BLUE.getIndex(), ctFill.getPatternFill().getBgColor().getIndexed()); - - //test rgb color - XSSFColor - CTColor ctColor=CTColor.Factory.newInstance(); - ctColor.setRgb("FFFFFF".getBytes()); - ctPatternFill.setBgColor(ctColor); - assertEquals(ctColor.toString(), cellStyle.getFillBackgroundRgbColor().getCTColor().toString()); - - cellStyle.setFillBackgroundRgbColor(new XSSFColor(ctColor)); - assertEquals(ctColor.getRgb()[0], ctPatternFill.getBgColor().getRgb()[0]); - assertEquals(ctColor.getRgb()[1], ctPatternFill.getBgColor().getRgb()[1]); - assertEquals(ctColor.getRgb()[2], ctPatternFill.getBgColor().getRgb()[2]); - assertEquals(ctColor.getRgb()[3], ctPatternFill.getBgColor().getRgb()[3]); + public void testGetSetFillBackgroundColor() { + + assertEquals(IndexedColors.AUTOMATIC.getIndex(), cellStyle.getFillBackgroundColor()); + assertNull(cellStyle.getFillBackgroundRgbColor()); + + XSSFColor clr; + + int num = stylesTable.getFills().size(); + + //setting indexed color + cellStyle.setFillBackgroundColor(IndexedColors.RED.getIndex()); + assertEquals(IndexedColors.RED.getIndex(), cellStyle.getFillBackgroundColor()); + clr = cellStyle.getFillBackgroundRgbColor(); + assertTrue(clr.getCTColor().isSetIndexed()); + assertEquals(IndexedColors.RED.getIndex(), clr.getIndexed()); + //a new fill was added to the styles table + assertEquals(num + 1, stylesTable.getFills().size()); + + //id of the created border + int fillId = (int)cellStyle.getCoreXf().getFillId(); + assertTrue(fillId > 0); + //check changes in the underlying xml bean + CTFill ctFill = stylesTable.getFillAt(fillId).getCTFill(); + assertEquals(IndexedColors.RED.getIndex(), ctFill.getPatternFill().getBgColor().getIndexed()); + + //setting XSSFColor + num = stylesTable.getFills().size(); + clr = new XSSFColor(java.awt.Color.CYAN); + cellStyle.setFillBackgroundColor(clr); + assertEquals(clr.getCTColor().toString(), cellStyle.getFillBackgroundRgbColor().getCTColor().toString()); + byte[] rgb = cellStyle.getFillBackgroundRgbColor().getRgb(); + assertEquals(java.awt.Color.CYAN, new java.awt.Color(rgb[0] & 0xFF, rgb[1] & 0xFF, rgb[2] & 0xFF)); + //another border was added to the styles table + assertEquals(num + 1, stylesTable.getFills().size()); + + //passing null unsets the color + cellStyle.setFillBackgroundColor(null); + assertNull(cellStyle.getFillBackgroundRgbColor()); + assertEquals(IndexedColors.AUTOMATIC.getIndex(), cellStyle.getFillBackgroundColor()); } - public void testGetFillBackgroundColor_default() { - - XSSFWorkbook wb = new XSSFWorkbook(); - - XSSFCellStyle style = wb.createCellStyle(); - - short color; - try { - color = style.getFillBackgroundColor(); - } catch (NullPointerException e) { - throw new AssertionFailedError("Identified bug 45898"); - } - assertEquals(AUTO_COLOR_INDEX, color); - XSSFColor xcolor=style.getFillBackgroundRgbColor(); - assertEquals(xcolor.getIndexed(), AUTO_COLOR_INDEX); + public void testDefaultStyles() { + + XSSFWorkbook wb1 = new XSSFWorkbook(); + + XSSFCellStyle style1 = wb1.createCellStyle(); + assertEquals(IndexedColors.AUTOMATIC.getIndex(), style1.getFillBackgroundColor()); + assertNull(style1.getFillBackgroundRgbColor()); + + //compatibility with HSSF + HSSFWorkbook wb2 = new HSSFWorkbook(); + HSSFCellStyle style2 = wb2.createCellStyle(); + assertEquals(style2.getFillBackgroundColor(), style1.getFillBackgroundColor()); + assertEquals(style2.getFillForegroundColor(), style1.getFillForegroundColor()); + assertEquals(style2.getFillPattern(), style1.getFillPattern()); + + assertEquals(style2.getLeftBorderColor(), style1.getLeftBorderColor()); + assertEquals(style2.getTopBorderColor(), style1.getTopBorderColor()); + assertEquals(style2.getRightBorderColor(), style1.getRightBorderColor()); + assertEquals(style2.getBottomBorderColor(), style1.getBottomBorderColor()); + + assertEquals(style2.getBorderBottom(), style1.getBorderBottom()); + assertEquals(style2.getBorderLeft(), style1.getBorderLeft()); + assertEquals(style2.getBorderRight(), style1.getBorderRight()); + assertEquals(style2.getBorderTop(), style1.getBorderTop()); } public void testGetFillForegroundColor() { - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - CTColor ctFgColor = ctPatternFill.addNewFgColor(); - ctFgColor.setIndexed(IndexedColors.BRIGHT_GREEN.getIndex()); - ctPatternFill.setFgColor(ctFgColor); + XSSFWorkbook wb = new XSSFWorkbook(); + StylesTable styles = wb.getStylesSource(); + assertEquals(1, wb.getNumCellStyles()); + assertEquals(2, styles.getFills().size()); - XSSFCellFill cellFill=new XSSFCellFill(ctFill); - long index=stylesTable.putFill(cellFill); - cellStyle.getCoreXf().setFillId(index); + XSSFCellStyle defaultStyle = wb.getCellStyleAt((short)0); + assertEquals(IndexedColors.AUTOMATIC.getIndex(), defaultStyle.getFillForegroundColor()); + assertEquals(null, defaultStyle.getFillForegroundRgbColor()); + assertEquals(CellStyle.NO_FILL, defaultStyle.getFillPattern()); - assertEquals(2,cellStyle.getCoreXf().getFillId()); - assertEquals(IndexedColors.BRIGHT_GREEN.getIndex(), cellStyle.getFillForegroundColor()); - - cellStyle.setFillForegroundColor(IndexedColors.BLUE.getIndex()); - assertEquals(IndexedColors.BLUE.getIndex(), ctFill.getPatternFill().getFgColor().getIndexed()); - - //test rgb color - XSSFColor - CTColor ctColor=CTColor.Factory.newInstance(); - ctColor.setRgb("FFFFFF".getBytes()); - ctPatternFill.setFgColor(ctColor); - assertEquals(ctColor.toString(), cellStyle.getFillForegroundRgbColor().getCTColor().toString()); - - cellStyle.setFillForegroundRgbColor(new XSSFColor(ctColor)); - assertEquals(ctColor.getRgb()[0], ctPatternFill.getFgColor().getRgb()[0]); - assertEquals(ctColor.getRgb()[1], ctPatternFill.getFgColor().getRgb()[1]); - assertEquals(ctColor.getRgb()[2], ctPatternFill.getFgColor().getRgb()[2]); - assertEquals(ctColor.getRgb()[3], ctPatternFill.getFgColor().getRgb()[3]); - } - - public void testGetFillForegroundColor_default() { + XSSFCellStyle customStyle = wb.createCellStyle(); + + customStyle.setFillPattern(CellStyle.SOLID_FOREGROUND); + assertEquals(CellStyle.SOLID_FOREGROUND, customStyle.getFillPattern()); + assertEquals(3, styles.getFills().size()); + + customStyle.setFillForegroundColor(IndexedColors.BRIGHT_GREEN.getIndex()); + assertEquals(IndexedColors.BRIGHT_GREEN.getIndex(), customStyle.getFillForegroundColor()); + assertEquals(4, styles.getFills().size()); - XSSFWorkbook wb = new XSSFWorkbook(); + for (int i = 0; i < 3; i++) { + XSSFCellStyle style = wb.createCellStyle(); - XSSFCellStyle style = wb.createCellStyle(); + style.setFillPattern(CellStyle.SOLID_FOREGROUND); + assertEquals(CellStyle.SOLID_FOREGROUND, style.getFillPattern()); + assertEquals(4, styles.getFills().size()); - short color; - try { - color = style.getFillForegroundColor(); - } catch (NullPointerException e) { - throw new AssertionFailedError("Identified bug 45898"); - } - assertEquals(AUTO_COLOR_INDEX, color); - XSSFColor xcolor=style.getFillForegroundRgbColor(); - assertEquals(xcolor.getIndexed(), AUTO_COLOR_INDEX); + style.setFillForegroundColor(IndexedColors.BRIGHT_GREEN.getIndex()); + assertEquals(IndexedColors.BRIGHT_GREEN.getIndex(), style.getFillForegroundColor()); + assertEquals(4, styles.getFills().size()); + } } - public void testGetFillPattern() { - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - ctPatternFill.setPatternType(STPatternType.DARK_DOWN); - XSSFCellFill cellFill=new XSSFCellFill(ctFill); - long index=stylesTable.putFill(cellFill); - cellStyle.getCoreXf().setFillId(index); - - assertEquals(CellStyle.THICK_FORWARD_DIAG, cellStyle.getFillPattern()); - - cellStyle.setFillPattern(CellStyle.BRICKS); - assertEquals(STPatternType.INT_DARK_TRELLIS,ctPatternFill.getPatternType().intValue()); + assertEquals(CellStyle.NO_FILL, cellStyle.getFillPattern()); + + int num = stylesTable.getFills().size(); + cellStyle.setFillPattern(CellStyle.SOLID_FOREGROUND); + assertEquals(CellStyle.SOLID_FOREGROUND, cellStyle.getFillPattern()); + assertEquals(num + 1, stylesTable.getFills().size()); + int fillId = (int)cellStyle.getCoreXf().getFillId(); + assertTrue(fillId > 0); + //check changes in the underlying xml bean + CTFill ctFill = stylesTable.getFillAt(fillId).getCTFill(); + assertEquals(STPatternType.SOLID, ctFill.getPatternFill().getPatternType()); + + //setting the same fill multiple time does not update the styles table + for (int i = 0; i < 3; i++) { + cellStyle.setFillPattern(CellStyle.SOLID_FOREGROUND); + } + assertEquals(num + 1, stylesTable.getFills().size()); + + cellStyle.setFillPattern(CellStyle.NO_FILL); + assertEquals(CellStyle.NO_FILL, cellStyle.getFillPattern()); + fillId = (int)cellStyle.getCoreXf().getFillId(); + ctFill = stylesTable.getFillAt(fillId).getCTFill(); + assertFalse(ctFill.getPatternFill().isSetPatternType()); + } public void testGetFont() { diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFFont.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFFont.java index c68a9f19a5..3fcd77b381 100755 --- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFFont.java +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFFont.java @@ -255,9 +255,11 @@ public final class TestXSSFFont extends TestCase{ s1 = wb.getSheetAt(0); assertEquals(2, wb.getNumberOfFonts()); - assertNotNull(s1.getRow(0).getCell(0).getCellStyle().getFont(wb)); - assertEquals(IndexedColors.YELLOW.getIndex(), s1.getRow(0).getCell(0).getCellStyle().getFont(wb).getColor()); - assertEquals("Courier", s1.getRow(0).getCell(0).getCellStyle().getFont(wb).getFontName()); + short idx = s1.getRow(0).getCell(0).getCellStyle().getFontIndex(); + Font fnt = wb.getFontAt(idx); + assertNotNull(fnt); + assertEquals(IndexedColors.YELLOW.getIndex(), fnt.getColor()); + assertEquals("Courier", fnt.getFontName()); // Now add an orphaned one XSSFFont font2 = wb.createFont(); @@ -342,4 +344,92 @@ public final class TestXSSFFont extends TestCase{ XSSFTestDataSamples.writeOutAndReadBack(workbook); } + + /** + * Test that fonts get added properly + * + * @see org.apache.poi.hssf.usermodel.TestBugs#test45338() + */ + public void test45338() { + XSSFWorkbook wb = new XSSFWorkbook(); + assertEquals(1, wb.getNumberOfFonts()); + + XSSFSheet s = wb.createSheet(); + s.createRow(0); + s.createRow(1); + XSSFCell c1 = s.getRow(0).createCell(0); + XSSFCell c2 = s.getRow(1).createCell(0); + + assertEquals(1, wb.getNumberOfFonts()); + + XSSFFont f1 = wb.getFontAt((short)0); + assertEquals(XSSFFont.BOLDWEIGHT_NORMAL, f1.getBoldweight()); + + // Check that asking for the same font + // multiple times gives you the same thing. + // Otherwise, our tests wouldn't work! + assertEquals( + wb.getFontAt((short)0), + wb.getFontAt((short)0) + ); + + // Look for a new font we have + // yet to add + assertNull( + wb.findFont( + (short)11, (short)123, (short)22, + "Thingy", false, true, (short)2, (byte)2 + ) + ); + + XSSFFont nf = wb.createFont(); + assertEquals(2, wb.getNumberOfFonts()); + + assertEquals(1, nf.getIndex()); + assertEquals(nf, wb.getFontAt((short)1)); + + nf.setBoldweight((short)11); + nf.setColor((short)123); + nf.setFontHeight((short)22); + nf.setFontName("Thingy"); + nf.setItalic(false); + nf.setStrikeout(true); + nf.setTypeOffset((short)2); + nf.setUnderline((byte)2); + + assertEquals(2, wb.getNumberOfFonts()); + assertEquals(nf, wb.getFontAt((short)1)); + + assertEquals( + wb.getFontAt((short)1), + wb.getFontAt((short)1) + ); + assertTrue( + wb.getFontAt((short)0) + != + wb.getFontAt((short)1) + ); + + // Find it now + assertNotNull( + wb.findFont( + (short)11, (short)123, (short)22, + "Thingy", false, true, (short)2, (byte)2 + ) + ); + assertEquals( + 1, + wb.findFont( + (short)11, (short)123, (short)22, + "Thingy", false, true, (short)2, (byte)2 + ).getIndex() + ); + assertEquals(nf, + wb.findFont( + (short)11, (short)123, (short)22, + "Thingy", false, true, (short)2, (byte)2 + ) + ); + } + } diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java index a8cdda1f55..ce1de14e18 100644 --- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFWorkbook.java @@ -256,7 +256,7 @@ public final class TestXSSFWorkbook extends TestCase { Font font=workbook.createFont(); ((XSSFFont)font).setBold(true); font.setUnderline(Font.U_DOUBLE); - StylesSource styleSource=new StylesTable(); + StylesTable styleSource=new StylesTable(); long index=styleSource.putFont(font); System.out.println("index="+index); workbook.setStylesSource(styleSource); diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFBorder.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFBorder.java index 59995a6e78..18fad7f9d3 100644 --- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFBorder.java +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFBorder.java @@ -17,14 +17,15 @@ package org.apache.poi.xssf.usermodel.extensions; +import junit.framework.TestCase; + +import org.apache.poi.xssf.usermodel.BorderStyle; import org.apache.poi.xssf.usermodel.extensions.XSSFCellBorder.BorderSide; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorder; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTBorderPr; import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTStylesheet; import org.openxmlformats.schemas.spreadsheetml.x2006.main.STBorderStyle; -import junit.framework.TestCase; - public class TestXSSFBorder extends TestCase { @@ -34,15 +35,20 @@ public class TestXSSFBorder extends TestCase { CTBorderPr top = border.addNewTop(); CTBorderPr right = border.addNewRight(); CTBorderPr bottom = border.addNewBottom(); + top.setStyle(STBorderStyle.DASH_DOT); right.setStyle(STBorderStyle.NONE); bottom.setStyle(STBorderStyle.THIN); + XSSFCellBorder cellBorderStyle = new XSSFCellBorder(border); - assertEquals("dashDot", cellBorderStyle.getBorderStyle(BorderSide.TOP).toString()); - assertEquals("none", cellBorderStyle.getBorderStyle(BorderSide.RIGHT).toString()); - assertEquals(1, cellBorderStyle.getBorderStyle(BorderSide.RIGHT).intValue()); - assertEquals("thin", cellBorderStyle.getBorderStyle(BorderSide.BOTTOM).toString()); - assertEquals(2, cellBorderStyle.getBorderStyle(BorderSide.BOTTOM).intValue()); + assertEquals("DASH_DOT", cellBorderStyle.getBorderStyle(BorderSide.TOP).toString()); + + assertEquals("NONE", cellBorderStyle.getBorderStyle(BorderSide.RIGHT).toString()); + assertEquals(BorderStyle.NONE.ordinal(), cellBorderStyle.getBorderStyle(BorderSide.RIGHT).ordinal()); + + assertEquals("THIN", cellBorderStyle.getBorderStyle(BorderSide.BOTTOM).toString()); + + assertEquals(BorderStyle.THIN.ordinal(), cellBorderStyle.getBorderStyle(BorderSide.BOTTOM).ordinal()); } } diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFCellFill.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFCellFill.java index e69cd968e7..36b1e7bc59 100644 --- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFCellFill.java +++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/extensions/TestXSSFCellFill.java @@ -1,58 +1,67 @@ -/* ==================================================================== - 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.xssf.usermodel.extensions; - - -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPatternFill; -import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType; - -import junit.framework.TestCase; - - -public class TestXSSFCellFill extends TestCase { - - public void testGetFillBackgroundColor() { - CTFill ctFill = CTFill.Factory.newInstance(); - XSSFCellFill cellFill = new XSSFCellFill(ctFill); - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - CTColor bgColor = ctPatternFill.addNewBgColor(); - assertNotNull(cellFill.getFillBackgroundColor()); - bgColor.setIndexed(2); - assertEquals(2, cellFill.getFillBackgroundColor().getIndexed()); - } - - public void testGetFillForegroundColor() { - CTFill ctFill = CTFill.Factory.newInstance(); - XSSFCellFill cellFill = new XSSFCellFill(ctFill); - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - CTColor fgColor = ctPatternFill.addNewFgColor(); - assertNotNull(cellFill.getFillForegroundColor()); - fgColor.setIndexed(8); - assertEquals(8, cellFill.getFillForegroundColor().getIndexed()); - } - - public void testGetPatternType() { - CTFill ctFill = CTFill.Factory.newInstance(); - XSSFCellFill cellFill = new XSSFCellFill(ctFill); - CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); - ctPatternFill.setPatternType(STPatternType.DARK_DOWN); - assertEquals(8, cellFill.getPatternType().intValue()); - } -} +/* ==================================================================== + 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.xssf.usermodel.extensions; + + +import org.apache.poi.xssf.usermodel.FillPatternType; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTFill; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPatternFill; +import org.openxmlformats.schemas.spreadsheetml.x2006.main.STPatternType; + +import junit.framework.TestCase; + + +public class TestXSSFCellFill extends TestCase { + + public void testGetFillBackgroundColor() { + CTFill ctFill = CTFill.Factory.newInstance(); + XSSFCellFill cellFill = new XSSFCellFill(ctFill); + CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); + CTColor bgColor = ctPatternFill.addNewBgColor(); + assertNotNull(cellFill.getFillBackgroundColor()); + bgColor.setIndexed(2); + assertEquals(2, cellFill.getFillBackgroundColor().getIndexed()); + } + + public void testGetFillForegroundColor() { + CTFill ctFill = CTFill.Factory.newInstance(); + XSSFCellFill cellFill = new XSSFCellFill(ctFill); + CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); + CTColor fgColor = ctPatternFill.addNewFgColor(); + assertNotNull(cellFill.getFillForegroundColor()); + fgColor.setIndexed(8); + assertEquals(8, cellFill.getFillForegroundColor().getIndexed()); + } + + public void testGetSetPatternType() { + CTFill ctFill = CTFill.Factory.newInstance(); + XSSFCellFill cellFill = new XSSFCellFill(ctFill); + CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); + ctPatternFill.setPatternType(STPatternType.SOLID); + //assertEquals(FillPatternType.SOLID_FOREGROUND.ordinal(), cellFill.getPatternType().ordinal()); + } + + public void testGetNotModifies() { + CTFill ctFill = CTFill.Factory.newInstance(); + XSSFCellFill cellFill = new XSSFCellFill(ctFill); + CTPatternFill ctPatternFill = ctFill.addNewPatternFill(); + ctPatternFill.setPatternType(STPatternType.DARK_DOWN); + assertEquals(8, cellFill.getPatternType().intValue()); + } +} -- 2.39.5