poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From one...@apache.org
Subject svn commit: r1747851 [1/2] - in /poi/branches/ss_border_property_template/src: examples/src/org/apache/poi/ss/examples/DrawingBorders.java java/org/apache/poi/ss/util/PropertyTemplate.java testcases/org/apache/poi/ss/util/TestPropertyTemplate.java
Date Sat, 11 Jun 2016 06:47:25 GMT
Author: onealj
Date: Sat Jun 11 06:47:25 2016
New Revision: 1747851

URL: http://svn.apache.org/viewvc?rev=1747851&view=rev
Log:
bug 58787: add PropertyTemplate, unit test, and example from Mark Murphy
Attachment 33684 plus changes to TestPropertyTemplate#applyBorders: replaced assertEquals(CellStyle.BORDER_*,
cs.getBorder*()) with assertEquals(BorderStyle.*, cs.getBorder*())

Added:
    poi/branches/ss_border_property_template/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
    poi/branches/ss_border_property_template/src/java/org/apache/poi/ss/util/PropertyTemplate.java
    poi/branches/ss_border_property_template/src/testcases/org/apache/poi/ss/util/TestPropertyTemplate.java

Added: poi/branches/ss_border_property_template/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
URL: http://svn.apache.org/viewvc/poi/branches/ss_border_property_template/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java?rev=1747851&view=auto
==============================================================================
--- poi/branches/ss_border_property_template/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
(added)
+++ poi/branches/ss_border_property_template/src/examples/src/org/apache/poi/ss/examples/DrawingBorders.java
Sat Jun 11 06:47:25 2016
@@ -0,0 +1,111 @@
+/*
+ *  ====================================================================
+ *    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.Cell;
+import org.apache.poi.ss.usermodel.CellStyle;
+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.PropertyTemplate;
+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");
+
+        // draw borders (three 3x3 grids)
+        PropertyTemplate pt = new PropertyTemplate();
+        // #1) these borders will all be medium in default color
+        pt.drawBorders(new CellRangeAddress(1, 3, 1, 3),
+                CellStyle.BORDER_MEDIUM, PropertyTemplate.Extent.ALL);
+        // #2) these cells will have medium outside borders and thin inside borders
+        pt.drawBorders(new CellRangeAddress(5, 7, 1, 3),
+                CellStyle.BORDER_MEDIUM, PropertyTemplate.Extent.OUTSIDE);
+        pt.drawBorders(new CellRangeAddress(5, 7, 1, 3), CellStyle.BORDER_THIN,
+                PropertyTemplate.Extent.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.drawBorders(new CellRangeAddress(9, 11, 1, 3),
+                CellStyle.BORDER_MEDIUM, IndexedColors.RED.getIndex(),
+                PropertyTemplate.Extent.OUTSIDE);
+        pt.drawBorders(new CellRangeAddress(9, 11, 1, 3),
+                CellStyle.BORDER_MEDIUM, IndexedColors.BLUE.getIndex(),
+                PropertyTemplate.Extent.INSIDE_VERTICAL);
+        pt.drawBorders(new CellRangeAddress(9, 11, 1, 3),
+                CellStyle.BORDER_MEDIUM, IndexedColors.GREEN.getIndex(),
+                PropertyTemplate.Extent.INSIDE_HORIZONTAL);
+        pt.drawBorders(new CellRangeAddress(10, 10, 2, 2),
+                CellStyle.BORDER_NONE, 
+                PropertyTemplate.Extent.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 = "db-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);
+    }
+
+}

Added: poi/branches/ss_border_property_template/src/java/org/apache/poi/ss/util/PropertyTemplate.java
URL: http://svn.apache.org/viewvc/poi/branches/ss_border_property_template/src/java/org/apache/poi/ss/util/PropertyTemplate.java?rev=1747851&view=auto
==============================================================================
--- poi/branches/ss_border_property_template/src/java/org/apache/poi/ss/util/PropertyTemplate.java
(added)
+++ poi/branches/ss_border_property_template/src/java/org/apache/poi/ss/util/PropertyTemplate.java
Sat Jun 11 06:47:25 2016
@@ -0,0 +1,989 @@
+/* ====================================================================
+   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.util;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.ss.SpreadsheetVersion;
+import org.apache.poi.ss.usermodel.Cell;
+import org.apache.poi.ss.usermodel.CellStyle;
+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;
+
+/**
+ * <p>
+ * A {@link PropertyTemplate} is a template that can be applied to any sheet in
+ * a project. It contains all the border type and color attributes needed to
+ * draw all the borders for a single sheet. That template can be applied to any
+ * sheet in any workbook.
+ * 
+ * This class requires the full spreadsheet to be in memory so
+ * {@link SWorkbook} Spreadsheets are not supported. The same
+ * {@link PropertyTemplate} can, however, be applied to both
+ * {@link org.apache.poi.hssf.usermodel.HSSFWorkbook}, and Workbook objects
+ * if necessary. Portions of the border that fall outside the max range of the
+ * {@link HSSFWorkbook} sheet are ignored.
+ * </p>
+ * 
+ * <p>
+ * This would replace {@link RegionUtil}.
+ * </p>
+ */
+public final class PropertyTemplate {
+
+    /**
+     * Provides various extents of the properties being added to the template
+     */
+    public enum Extent {
+        /**
+         * No properties defined. This can be used to remove existing
+         * properties.
+         */
+        NONE,
+
+        /**
+         * All borders, that is top, bottom, left and right, including interior
+         * borders for the range. Does not include diagonals which are different
+         * and not implemented here.
+         */
+        ALL,
+
+        /**
+         * All inside borders. This is top, bottom, left, and right borders, but
+         * restricted to the interior borders for the range. For a range of one
+         * cell, this will produce no borders.
+         */
+        INSIDE,
+
+        /**
+         * All outside borders. That is top, bottom, left and right borders that
+         * bound the range only.
+         */
+        OUTSIDE,
+
+        /**
+         * This is just the top border for the range. No interior borders will
+         * be produced.
+         */
+        TOP,
+
+        /**
+         * This is just the bottom border for the range. No interior borders
+         * will be produced.
+         */
+        BOTTOM,
+
+        /**
+         * This is just the left border for the range, no interior borders will
+         * be produced.
+         */
+        LEFT,
+
+        /**
+         * This is just the right border for the range, no interior borders will
+         * be produced.
+         */
+        RIGHT,
+
+        /**
+         * This is all horizontal borders for the range, including interior and
+         * outside borders.
+         */
+        HORIZONTAL,
+
+        /**
+         * This is just the interior horizontal borders for the range.
+         */
+        INSIDE_HORIZONTAL,
+
+        /**
+         * This is just the outside horizontal borders for the range.
+         */
+        OUTSIDE_HORIZONTAL,
+
+        /**
+         * This is all vertical borders for the range, including interior and
+         * outside borders.
+         */
+        VERTICAL,
+
+        /**
+         * This is just the interior vertical borders for the range.
+         */
+        INSIDE_VERTICAL,
+
+        /**
+         * This is just the outside vertical borders for the range.
+         */
+        OUTSIDE_VERTICAL
+    }
+
+    /**
+     * This is a list of cell properties for one shot application to a range of
+     * cells at a later time.
+     */
+    private Map<CellAddress, Map<String, Object>> _propertyTemplate;
+
+    /**
+     *
+     */
+    public PropertyTemplate() {
+        _propertyTemplate = new HashMap<CellAddress, Map<String, Object>>();
+    }
+
+    /**
+     * Draws a group of cell borders for a cell range. The borders are not
+     * applied to the cells at this time, just the template is drawn. To apply
+     * the drawn borders to a sheet, use {@link #applyBorders}.
+     * 
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders to be
+     *            applied.
+     */
+    public void drawBorders(CellRangeAddress range, short borderType,
+            Extent extent) {
+        switch (extent) {
+        case NONE:
+            removeBorders(range);
+            break;
+        case ALL:
+            drawHorizontalBorders(range, borderType, Extent.ALL);
+            drawVerticalBorders(range, borderType, Extent.ALL);
+            break;
+        case INSIDE:
+            drawHorizontalBorders(range, borderType, Extent.INSIDE);
+            drawVerticalBorders(range, borderType, Extent.INSIDE);
+            break;
+        case OUTSIDE:
+            drawOutsideBorders(range, borderType, Extent.ALL);
+            break;
+        case TOP:
+            drawTopBorder(range, borderType);
+            break;
+        case BOTTOM:
+            drawBottomBorder(range, borderType);
+            break;
+        case LEFT:
+            drawLeftBorder(range, borderType);
+            break;
+        case RIGHT:
+            drawRightBorder(range, borderType);
+            break;
+        case HORIZONTAL:
+            drawHorizontalBorders(range, borderType, Extent.ALL);
+            break;
+        case INSIDE_HORIZONTAL:
+            drawHorizontalBorders(range, borderType, Extent.INSIDE);
+            break;
+        case OUTSIDE_HORIZONTAL:
+            drawOutsideBorders(range, borderType, Extent.HORIZONTAL);
+            break;
+        case VERTICAL:
+            drawVerticalBorders(range, borderType, Extent.ALL);
+            break;
+        case INSIDE_VERTICAL:
+            drawVerticalBorders(range, borderType, Extent.INSIDE);
+            break;
+        case OUTSIDE_VERTICAL:
+            drawOutsideBorders(range, borderType, Extent.VERTICAL);
+            break;
+        }
+    }
+
+    /**
+     * Draws a group of cell borders for a cell range. The borders are not
+     * applied to the cells at this time, just the template is drawn. To apply
+     * the drawn borders to a sheet, use {@link #applyBorders}.
+     * 
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders to be
+     *            applied.
+     */
+    public void drawBorders(CellRangeAddress range, short borderType,
+            short color, Extent extent) {
+        drawBorders(range, borderType, extent);
+        if (borderType != CellStyle.BORDER_NONE) {
+            drawBorderColors(range, color, extent);
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the top border for a range of cells
+     * </p>
+     * 
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     */
+    private void drawTopBorder(CellRangeAddress range, short borderType) {
+        int row = range.getFirstRow();
+        int firstCol = range.getFirstColumn();
+        int lastCol = range.getLastColumn();
+        for (int i = firstCol; i <= lastCol; i++) {
+            addProperty(row, i, CellUtil.BORDER_TOP, borderType);
+            if (borderType == CellStyle.BORDER_NONE && row > 0) {
+                addProperty(row - 1, i, CellUtil.BORDER_BOTTOM, borderType);
+            }
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the bottom border for a range of cells
+     * </p>
+     * 
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     */
+    private void drawBottomBorder(CellRangeAddress range, short borderType) {
+        int row = range.getLastRow();
+        int firstCol = range.getFirstColumn();
+        int lastCol = range.getLastColumn();
+        for (int i = firstCol; i <= lastCol; i++) {
+            addProperty(row, i, CellUtil.BORDER_BOTTOM, borderType);
+            if (borderType == CellStyle.BORDER_NONE
+                    && row < SpreadsheetVersion.EXCEL2007.getMaxRows() - 1) {
+                addProperty(row + 1, i, CellUtil.BORDER_TOP, borderType);
+            }
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the left border for a range of cells
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     */
+    private void drawLeftBorder(CellRangeAddress range, short borderType) {
+        int firstRow = range.getFirstRow();
+        int lastRow = range.getLastRow();
+        int col = range.getFirstColumn();
+        for (int i = firstRow; i <= lastRow; i++) {
+            addProperty(i, col, CellUtil.BORDER_LEFT, borderType);
+            if (borderType == CellStyle.BORDER_NONE && col > 0) {
+                addProperty(i, col - 1, CellUtil.BORDER_RIGHT, borderType);
+            }
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the right border for a range of cells
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     */
+    private void drawRightBorder(CellRangeAddress range, short borderType) {
+        int firstRow = range.getFirstRow();
+        int lastRow = range.getLastRow();
+        int col = range.getLastColumn();
+        for (int i = firstRow; i <= lastRow; i++) {
+            addProperty(i, col, CellUtil.BORDER_RIGHT, borderType);
+            if (borderType == CellStyle.BORDER_NONE
+                    && col < SpreadsheetVersion.EXCEL2007.getMaxColumns() - 1)
{
+                addProperty(i, col + 1, CellUtil.BORDER_LEFT, borderType);
+            }
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the outside borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders to be
+     *            applied. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.HORIZONTAL</li>
+     *            <li>CellBorder.Extent.VERTICAL</li>
+     *            </ul>
+     */
+    private void drawOutsideBorders(CellRangeAddress range, short borderType,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case HORIZONTAL:
+        case VERTICAL:
+            if (extent == Extent.ALL || extent == Extent.HORIZONTAL) {
+                drawTopBorder(range, borderType);
+                drawBottomBorder(range, borderType);
+            }
+            if (extent == Extent.ALL || extent == Extent.VERTICAL) {
+                drawLeftBorder(range, borderType);
+                drawRightBorder(range, borderType);
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL, HORIZONTAL,
and VERTICAL");
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the horizontal borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders to be
+     *            applied. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.INSIDE</li>
+     *            </ul>
+     */
+    private void drawHorizontalBorders(CellRangeAddress range, short borderType,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case INSIDE:
+            int firstRow = range.getFirstRow();
+            int lastRow = range.getLastRow();
+            int firstCol = range.getFirstColumn();
+            int lastCol = range.getLastColumn();
+            for (int i = firstRow; i <= lastRow; i++) {
+                CellRangeAddress row = new CellRangeAddress(i, i, firstCol,
+                        lastCol);
+                if (extent == Extent.ALL || i > firstRow) {
+                    drawTopBorder(row, borderType);
+                }
+                if (extent == Extent.ALL || i < lastRow) {
+                    drawBottomBorder(row, borderType);
+                }
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL and INSIDE");
+        }
+    }
+
+    /**
+     * <p>
+     * Draws the vertical borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which borders are
+     *            drawn.
+     * @param borderType
+     *            - Type of border to draw. Use BORDER_XXX constants in
+     *            {@link CellStyle}.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders to be
+     *            applied. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.INSIDE</li>
+     *            </ul>
+     */
+    private void drawVerticalBorders(CellRangeAddress range, short borderType,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case INSIDE:
+            int firstRow = range.getFirstRow();
+            int lastRow = range.getLastRow();
+            int firstCol = range.getFirstColumn();
+            int lastCol = range.getLastColumn();
+            for (int i = firstCol; i <= lastCol; i++) {
+                CellRangeAddress row = new CellRangeAddress(firstRow, lastRow,
+                        i, i);
+                if (extent == Extent.ALL || i > firstCol) {
+                    drawLeftBorder(row, borderType);
+                }
+                if (extent == Extent.ALL || i < lastCol) {
+                    drawRightBorder(row, borderType);
+                }
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL and INSIDE");
+        }
+    }
+
+    /**
+     * Removes all border properties from this {@link PropertyTemplate} for the
+     * specified range.
+     * 
+     * @parm range - {@link CellRangeAddress} range of cells to remove borders.
+     */
+    private void removeBorders(CellRangeAddress range) {
+        Set<String> properties = new HashSet<String>();
+        properties.add(CellUtil.BORDER_TOP);
+        properties.add(CellUtil.BORDER_BOTTOM);
+        properties.add(CellUtil.BORDER_LEFT);
+        properties.add(CellUtil.BORDER_RIGHT);
+        for (int row = range.getFirstRow(); row <= range.getLastRow(); row++) {
+            for (int col = range.getFirstColumn(); col <= range
+                    .getLastColumn(); col++) {
+                removeProperties(row, col, properties);
+            }
+        }
+        removeBorderColors(range);
+    }
+
+    /**
+     * Applies the drawn borders to a Sheet. The borders that are applied are
+     * the ones that have been drawn by the {@link #drawBorders} and
+     * {@link #drawBorderColors} methods.
+     *
+     * @param sheet
+     *            - {@link Sheet} on which to apply borders
+     */
+    public void applyBorders(Sheet sheet) {
+        Workbook wb = sheet.getWorkbook();
+        for (Map.Entry<CellAddress, Map<String, Object>> entry : _propertyTemplate
+                .entrySet()) {
+            CellAddress cellAddress = entry.getKey();
+            if (cellAddress.getRow() < wb.getSpreadsheetVersion().getMaxRows()
+                    && cellAddress.getColumn() < wb.getSpreadsheetVersion()
+                            .getMaxColumns()) {
+                Map<String, Object> properties = entry.getValue();
+                Row row = CellUtil.getRow(cellAddress.getRow(), sheet);
+                Cell cell = CellUtil.getCell(row, cellAddress.getColumn());
+                CellUtil.setCellStyleProperties(cell, properties);
+            }
+        }
+    }
+
+    /**
+     * Sets the color for a group of cell borders for a cell range. The borders
+     * are not applied to the cells at this time, just the template is drawn. If
+     * the borders do not exist, a BORDER_THIN border is used. To apply the
+     * drawn borders to a sheet, use {@link #applyBorders}.
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders for which
+     *            colors are set.
+     */
+    public void drawBorderColors(CellRangeAddress range, short color,
+            Extent extent) {
+        switch (extent) {
+        case NONE:
+            removeBorderColors(range);
+            break;
+        case ALL:
+            drawHorizontalBorderColors(range, color, Extent.ALL);
+            drawVerticalBorderColors(range, color, Extent.ALL);
+            break;
+        case INSIDE:
+            drawHorizontalBorderColors(range, color, Extent.INSIDE);
+            drawVerticalBorderColors(range, color, Extent.INSIDE);
+            break;
+        case OUTSIDE:
+            drawOutsideBorderColors(range, color, Extent.ALL);
+            break;
+        case TOP:
+            drawTopBorderColor(range, color);
+            break;
+        case BOTTOM:
+            drawBottomBorderColor(range, color);
+            break;
+        case LEFT:
+            drawLeftBorderColor(range, color);
+            break;
+        case RIGHT:
+            drawRightBorderColor(range, color);
+            break;
+        case HORIZONTAL:
+            drawHorizontalBorderColors(range, color, Extent.ALL);
+            break;
+        case INSIDE_HORIZONTAL:
+            drawHorizontalBorderColors(range, color, Extent.INSIDE);
+            break;
+        case OUTSIDE_HORIZONTAL:
+            drawOutsideBorderColors(range, color, Extent.HORIZONTAL);
+            break;
+        case VERTICAL:
+            drawVerticalBorderColors(range, color, Extent.ALL);
+            break;
+        case INSIDE_VERTICAL:
+            drawVerticalBorderColors(range, color, Extent.INSIDE);
+            break;
+        case OUTSIDE_VERTICAL:
+            drawOutsideBorderColors(range, color, Extent.VERTICAL);
+            break;
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the top border for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     */
+    private void drawTopBorderColor(CellRangeAddress range, short color) {
+        int row = range.getFirstRow();
+        int firstCol = range.getFirstColumn();
+        int lastCol = range.getLastColumn();
+        for (int i = firstCol; i <= lastCol; i++) {
+            if (getTemplateProperty(row, i, CellUtil.BORDER_TOP) == 0) {
+                drawTopBorder(new CellRangeAddress(row, row, i, i),
+                        CellStyle.BORDER_THIN);
+            }
+            addProperty(row, i, CellUtil.TOP_BORDER_COLOR, color);
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the bottom border for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     */
+    private void drawBottomBorderColor(CellRangeAddress range, short color) {
+        int row = range.getLastRow();
+        int firstCol = range.getFirstColumn();
+        int lastCol = range.getLastColumn();
+        for (int i = firstCol; i <= lastCol; i++) {
+            if (getTemplateProperty(row, i, CellUtil.BORDER_BOTTOM) == 0) {
+                drawBottomBorder(new CellRangeAddress(row, row, i, i),
+                        CellStyle.BORDER_THIN);
+            }
+            addProperty(row, i, CellUtil.BOTTOM_BORDER_COLOR, color);
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the left border for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     */
+    private void drawLeftBorderColor(CellRangeAddress range, short color) {
+        int firstRow = range.getFirstRow();
+        int lastRow = range.getLastRow();
+        int col = range.getFirstColumn();
+        for (int i = firstRow; i <= lastRow; i++) {
+            if (getTemplateProperty(i, col, CellUtil.BORDER_LEFT) == 0) {
+                drawLeftBorder(new CellRangeAddress(i, i, col, col),
+                        CellStyle.BORDER_THIN);
+            }
+            addProperty(i, col, CellUtil.LEFT_BORDER_COLOR, color);
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the right border for a range of cells. If the border is
+     * not drawn, it defaults to BORDER_THIN
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     */
+    private void drawRightBorderColor(CellRangeAddress range, short color) {
+        int firstRow = range.getFirstRow();
+        int lastRow = range.getLastRow();
+        int col = range.getLastColumn();
+        for (int i = firstRow; i <= lastRow; i++) {
+            if (getTemplateProperty(i, col, CellUtil.BORDER_RIGHT) == 0) {
+                drawRightBorder(new CellRangeAddress(i, i, col, col),
+                        CellStyle.BORDER_THIN);
+            }
+            addProperty(i, col, CellUtil.RIGHT_BORDER_COLOR, color);
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the outside borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders for which
+     *            colors are set. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.HORIZONTAL</li>
+     *            <li>CellBorder.Extent.VERTICAL</li>
+     *            </ul>
+     */
+    private void drawOutsideBorderColors(CellRangeAddress range, short color,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case HORIZONTAL:
+        case VERTICAL:
+            if (extent == Extent.ALL || extent == Extent.HORIZONTAL) {
+                drawTopBorderColor(range, color);
+                drawBottomBorderColor(range, color);
+            }
+            if (extent == Extent.ALL || extent == Extent.VERTICAL) {
+                drawLeftBorderColor(range, color);
+                drawRightBorderColor(range, color);
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL, HORIZONTAL,
and VERTICAL");
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the horizontal borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders for which
+     *            colors are set. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.INSIDE</li>
+     *            </ul>
+     */
+    private void drawHorizontalBorderColors(CellRangeAddress range, short color,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case INSIDE:
+            int firstRow = range.getFirstRow();
+            int lastRow = range.getLastRow();
+            int firstCol = range.getFirstColumn();
+            int lastCol = range.getLastColumn();
+            for (int i = firstRow; i <= lastRow; i++) {
+                CellRangeAddress row = new CellRangeAddress(i, i, firstCol,
+                        lastCol);
+                if (extent == Extent.ALL || i > firstRow) {
+                    drawTopBorderColor(row, color);
+                }
+                if (extent == Extent.ALL || i < lastRow) {
+                    drawBottomBorderColor(row, color);
+                }
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL and INSIDE");
+        }
+    }
+
+    /**
+     * <p>
+     * Sets the color of the vertical borders for a range of cells.
+     * </p>
+     *
+     * @param range
+     *            - {@link CellRangeAddress} range of cells on which colors are
+     *            set.
+     * @param color
+     *            - Color index from {@link IndexedColors} used to draw the
+     *            borders.
+     * @param extent
+     *            - {@link PropertyTemplate.Extent} of the borders for which
+     *            colors are set. Valid Values are:
+     *            <ul>
+     *            <li>CellBorder.Extent.ALL</li>
+     *            <li>CellBorder.Extent.INSIDE</li>
+     *            </ul>
+     */
+    private void drawVerticalBorderColors(CellRangeAddress range, short color,
+            Extent extent) {
+        switch (extent) {
+        case ALL:
+        case INSIDE:
+            int firstRow = range.getFirstRow();
+            int lastRow = range.getLastRow();
+            int firstCol = range.getFirstColumn();
+            int lastCol = range.getLastColumn();
+            for (int i = firstCol; i <= lastCol; i++) {
+                CellRangeAddress row = new CellRangeAddress(firstRow, lastRow,
+                        i, i);
+                if (extent == Extent.ALL || i > firstCol) {
+                    drawLeftBorderColor(row, color);
+                }
+                if (extent == Extent.ALL || i < lastCol) {
+                    drawRightBorderColor(row, color);
+                }
+            }
+            break;
+        default:
+            throw new IllegalArgumentException(
+                    "Unsupported PropertyTemplate.Extent, valid Extents are ALL and INSIDE");
+        }
+    }
+
+    /**
+     * Removes all border properties from this {@link PropertyTemplate} for the
+     * specified range.
+     * 
+     * @parm range - {@link CellRangeAddress} range of cells to remove borders.
+     */
+    private void removeBorderColors(CellRangeAddress range) {
+        Set<String> properties = new HashSet<String>();
+        properties.add(CellUtil.TOP_BORDER_COLOR);
+        properties.add(CellUtil.BOTTOM_BORDER_COLOR);
+        properties.add(CellUtil.LEFT_BORDER_COLOR);
+        properties.add(CellUtil.RIGHT_BORDER_COLOR);
+        for (int row = range.getFirstRow(); row <= range.getLastRow(); row++) {
+            for (int col = range.getFirstColumn(); col <= range
+                    .getLastColumn(); col++) {
+                removeProperties(row, col, properties);
+            }
+        }
+    }
+
+    /**
+     * Adds a property to this {@link PropertyTemplate} for a given cell
+     *
+     * @param row
+     * @param col
+     * @param property
+     * @param value
+     */
+    private void addProperty(int row, int col, String property, short value) {
+        CellAddress cell = new CellAddress(row, col);
+        Map<String, Object> cellProperties = _propertyTemplate.get(cell);
+        if (cellProperties == null) {
+            cellProperties = new HashMap<String, Object>();
+        }
+        cellProperties.put(property, Short.valueOf(value));
+        _propertyTemplate.put(cell, cellProperties);
+    }
+
+    /**
+     * Removes a set of properties from this {@link PropertyTemplate} for a
+     * given cell
+     *
+     * @param row
+     * @param col
+     * @param properties
+     */
+    private void removeProperties(int row, int col, Set<String> properties) {
+        CellAddress cell = new CellAddress(row, col);
+        Map<String, Object> cellProperties = _propertyTemplate.get(cell);
+        if (cellProperties != null) {
+            cellProperties.keySet().removeAll(properties);
+            if (cellProperties.isEmpty()) {
+                _propertyTemplate.remove(cell);
+            } else {
+                _propertyTemplate.put(cell, cellProperties);
+            }
+        }
+    }
+
+    /**
+     * Retrieves the number of borders assigned to a cell
+     *
+     * @param cell
+     */
+    public int getNumBorders(CellAddress cell) {
+        Map<String, Object> cellProperties = _propertyTemplate.get(cell);
+        if (cellProperties == null) {
+            return 0;
+        }
+
+        int count = 0;
+        for (String property : cellProperties.keySet()) {
+            if (property.equals(CellUtil.BORDER_TOP))
+                count += 1;
+            if (property.equals(CellUtil.BORDER_BOTTOM))
+                count += 1;
+            if (property.equals(CellUtil.BORDER_LEFT))
+                count += 1;
+            if (property.equals(CellUtil.BORDER_RIGHT))
+                count += 1;
+        }
+        return count;
+    }
+
+    /**
+     * Retrieves the number of borders assigned to a cell
+     *
+     * @param row
+     * @param col
+     */
+    public int getNumBorders(int row, int col) {
+        return getNumBorders(new CellAddress(row, col));
+    }
+
+    /**
+     * Retrieves the number of border colors assigned to a cell
+     *
+     * @param cell
+     */
+    public int getNumBorderColors(CellAddress cell) {
+        Map<String, Object> cellProperties = _propertyTemplate.get(cell);
+        if (cellProperties == null) {
+            return 0;
+        }
+
+        int count = 0;
+        for (String property : cellProperties.keySet()) {
+            if (property.equals(CellUtil.TOP_BORDER_COLOR))
+                count += 1;
+            if (property.equals(CellUtil.BOTTOM_BORDER_COLOR))
+                count += 1;
+            if (property.equals(CellUtil.LEFT_BORDER_COLOR))
+                count += 1;
+            if (property.equals(CellUtil.RIGHT_BORDER_COLOR))
+                count += 1;
+        }
+        return count;
+    }
+
+    /**
+     * Retrieves the number of border colors assigned to a cell
+     *
+     * @param row
+     * @param col
+     */
+    public int getNumBorderColors(int row, int col) {
+        return getNumBorderColors(new CellAddress(row, col));
+    }
+
+    /**
+     * Retrieves the border style for a given cell
+     * 
+     * @param cell
+     * @param property
+     */
+    public short getTemplateProperty(CellAddress cell, String property) {
+        short value = 0;
+        Map<String, Object> cellProperties = _propertyTemplate.get(cell);
+        if (cellProperties != null) {
+            Object obj = cellProperties.get(property);
+            if (obj != null) {
+                value = getShort(obj);
+            }
+        }
+        return value;
+    }
+
+    /**
+     * Retrieves the border style for a given cell
+     * 
+     * @param row
+     * @param col
+     * @param property
+     */
+    public short getTemplateProperty(int row, int col, String property) {
+        return getTemplateProperty(new CellAddress(row, col), property);
+    }
+
+    /**
+     * Converts a Short object to a short value or 0 if the object is not a
+     * Short
+     *
+     * @param value
+     * @return
+     */
+    private static short getShort(Object value) {
+        if (value instanceof Short) {
+            return ((Short) value).shortValue();
+        }
+        return 0;
+    }
+}




---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org


Mime
View raw message