bug 58787: reintegrate changes from ss_border_property_template branch at r1748074. The BorderPropertyTemplate allows changes to border formatting to be staged in a template and applied to a sheet at a later time. This reduces the number of intermediate styles created, reduces interactions with cell objects (CellUtil.get/setCellProperties), and makes it easier to make the same formatting changes to multiple sheets. This utility can currently apply border line style and border color. This utility also adds the ability to add a border around a cell range rather than a single cell. Contributed by Mark Murphy.

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1748075 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 112 insertions, 0 deletions

diff --git a/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java b/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
new file mode 100644
index 0000000000..b42289385b
--- /dev/null
+++ b/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
@@ -0,0 +1,112 @@
+/*
+ *  ====================================================================
+ *    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.ss.examples;
+
+import java.io.FileOutputStream;
+import java.io.IOException;
+
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.ss.usermodel.BorderStyle;
+import org.apache.poi.ss.usermodel.Cell;
+import org.apache.poi.ss.usermodel.IndexedColors;
+import org.apache.poi.ss.usermodel.Row;
+import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.ss.util.BorderPropertyTemplate;
+import org.apache.poi.ss.util.BorderPropertyTemplate.BorderExtent;
+import org.apache.poi.ss.util.CellRangeAddress;
+import org.apache.poi.xssf.usermodel.XSSFWorkbook;
+
+/**
+ * Excel Border Drawing - examples
+ * 
+ * <p>
+ * Partly based on the code snippets from
+ * org.apache.poi.ss.examples.ConditionalFormats
+ * </p>
+ */
+public class DrawingBorders {
+
+    public static void main(String[] args) throws IOException {
+        Workbook wb;
+
+        if (args.length > 0 && args[0].equals("-xls")) {
+            wb = new HSSFWorkbook();
+        } else {
+            wb = new XSSFWorkbook();
+        }
+
+        // add a sheet, and put some values into it
+        Sheet sh1 = wb.createSheet("Sheet1");
+        Row r = sh1.createRow(0);
+        Cell c = r.createCell(1);
+        c.setCellValue("All Borders Medium Width");
+        r = sh1.createRow(4);
+        c = r.createCell(1);
+        c.setCellValue("Medium Outside / Thin Inside Borders");
+        r = sh1.createRow(8);
+        c = r.createCell(1);
+        c.setCellValue("Colored Borders");
+        
+        CellRangeAddress b2d4 = CellRangeAddress.valueOf("B2:D4");
+        CellRangeAddress b6d8 = CellRangeAddress.valueOf("B6:D8");
+        CellRangeAddress b10d12 = CellRangeAddress.valueOf("B10:D12");
+        CellRangeAddress c11 = CellRangeAddress.valueOf("C11:C11");
+        short red = IndexedColors.RED.getIndex();
+        short green = IndexedColors.GREEN.getIndex();
+        short blue = IndexedColors.BLUE.getIndex();
+
+        // draw borders (three 3x3 grids)
+        BorderPropertyTemplate pt = new BorderPropertyTemplate();
+        
+        // #1) these borders will all be medium in default color
+        pt.drawBorders(b2d4, BorderStyle.MEDIUM, BorderExtent.ALL);
+        
+        // #2) these cells will have medium outside borders and thin inside borders
+        pt.drawBorders(b6d8, BorderStyle.MEDIUM, BorderExtent.OUTSIDE);
+        pt.drawBorders(b6d8, BorderStyle.THIN, BorderExtent.INSIDE);
+        
+        // #3) these cells will all be medium weight with different colors for the
+        //     outside, inside horizontal, and inside vertical borders. The center
+        //     cell will have no borders.
+        pt.drawColoredBorders(b10d12, BorderStyle.MEDIUM, red, BorderExtent.OUTSIDE);
+        pt.drawColoredBorders(b10d12, BorderStyle.MEDIUM, blue, BorderExtent.INSIDE_VERTICAL);
+        pt.drawColoredBorders(b10d12, BorderStyle.MEDIUM, green, BorderExtent.INSIDE_HORIZONTAL);
+        pt.drawBorders(c11, BorderStyle.NONE, BorderExtent.ALL);
+
+        // apply borders to sheet
+        pt.applyBorders(sh1);
+        
+        // add another sheet and apply the borders to it
+        Sheet sh2 = wb.createSheet("Sheet2");
+        pt.applyBorders(sh2);
+
+        // Write the output to a file
+        String file = "DrawingBorders-poi.xls";
+        if (wb instanceof XSSFWorkbook)
+            file += "x";
+        FileOutputStream out = new FileOutputStream(file);
+        wb.write(out);
+        out.close();
+        wb.close();
+        System.out.println("Generated: " + file);
+    }
+
+}