back out changes for bug 58787: will replae BorderPropertyTemplate with a more general CellStyleTemplate in the future
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1748293 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
4a85959d45
commit
beef6df971
@ -1,943 +0,0 @@
|
||||
/* ====================================================================
|
||||
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.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Set;
|
||||
|
||||
import org.apache.poi.ss.SpreadsheetVersion;
|
||||
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.util.Beta;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* A BorderPropertyTemplate 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.
|
||||
*
|
||||
* <p>
|
||||
* This class requires the full spreadsheet to be in memory so
|
||||
* {@link org.apache.poi.xssf.streaming.SXSSFWorkbook} spreadsheets may not work. The same
|
||||
* BorderPropertyTemplate can be reused on different types of workbooks, such as
|
||||
* {@link org.apache.poi.hssf.usermodel.HSSFWorkbook} and
|
||||
* {@link org.apache.poi.xssf.usermodel.XSSFWorkbook} instances.
|
||||
* Portions of the border that fall outside the max range of the
|
||||
* sheet are ignored.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* This may be merged with {@link RegionUtil} in the future.
|
||||
* </p>
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
@Beta
|
||||
public final class BorderPropertyTemplate {
|
||||
|
||||
/**
|
||||
* Provides various extents of the properties being added to the template
|
||||
* Note that the Border BorderExtent differs from a BorderStyle. A BorderStyle
|
||||
* refers to the border around a single cell while a BorderExtent refers to
|
||||
* borders around and through an area of cells.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public enum BorderExtent {
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
|
||||
/**
|
||||
* A set of the border color property names
|
||||
*/
|
||||
private static final Set<String> BORDER_COLOR_PROPERTY_NAMES;
|
||||
static {
|
||||
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);
|
||||
BORDER_COLOR_PROPERTY_NAMES = Collections.unmodifiableSet(properties);
|
||||
}
|
||||
|
||||
/**
|
||||
* A set of the border direction property names
|
||||
*/
|
||||
private static final Set<String> BORDER_DIRECTION_PROPERTY_NAMES;
|
||||
static {
|
||||
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);
|
||||
BORDER_DIRECTION_PROPERTY_NAMES = Collections.unmodifiableSet(properties);
|
||||
}
|
||||
|
||||
// this must be greater than or equal to the workbooks used in #applyBorders
|
||||
private static final SpreadsheetVersion _ss = SpreadsheetVersion.EXCEL2007;
|
||||
|
||||
/**
|
||||
* This is a list of cell properties for one shot application to a range of
|
||||
* cells at a later time.
|
||||
*
|
||||
* Data types:
|
||||
* _propertyTemplate as {A1: property map}
|
||||
* property map as {property key : property value}
|
||||
* property key as String as (border direction as CellUtil.BORDER_*) or (border color as CellUtil.*_BORDER_COLOR)
|
||||
* property value as (border line style as BorderStyle) or (color as short)
|
||||
*/
|
||||
private final Map<CellAddress, Map<String, Object>> _propertyTemplate;
|
||||
|
||||
/**
|
||||
* Create a new Border Property Template to stage border formatting changes to a spreadsheet
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public BorderPropertyTemplate() {
|
||||
_propertyTemplate = new HashMap<CellAddress, Map<String, Object>>();
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy constructor
|
||||
*
|
||||
* Create a template from an existing template.
|
||||
* Changes made to either template do not affect the other template.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public BorderPropertyTemplate(BorderPropertyTemplate prototype) {
|
||||
this();
|
||||
// deep copy the _propertyTemplate map from prototype
|
||||
for (Entry<CellAddress, Map<String, Object>> other : prototype._propertyTemplate.entrySet()) {
|
||||
CellAddress cell = other.getKey();
|
||||
Map<String, Object> otherMap = other.getValue();
|
||||
|
||||
// The keys in otherMap are immutable Strings
|
||||
// The values in otherMap are immutable Shorts or BorderStyles
|
||||
// Therefore, this map's data cannot be modified through protoype
|
||||
Map<String, Object> map = new HashMap<String, Object>(otherMap);
|
||||
|
||||
// CellAddress is an immutable class, therefore it is ok to reference the same instance
|
||||
_propertyTemplate.put(cell, map);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a group of cell borders for a cell range to the border property template.
|
||||
* The borders are not applied to the cells at this time, just the template is drawn
|
||||
* (<code>drawBorders</code> stages changes using the border property template).
|
||||
* To apply the drawn borders to a sheet, use {@link #applyBorders}.
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
* @param extent BorderExtent of the borders to be applied.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public void drawBorders(CellRangeAddress range, BorderStyle borderType, BorderExtent extent) {
|
||||
switch (extent) {
|
||||
case NONE:
|
||||
removeBorders(range);
|
||||
break;
|
||||
case ALL:
|
||||
drawHorizontalBorders(range, borderType, BorderExtent.ALL);
|
||||
drawVerticalBorders(range, borderType, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE:
|
||||
drawHorizontalBorders(range, borderType, BorderExtent.INSIDE);
|
||||
drawVerticalBorders(range, borderType, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE:
|
||||
drawOutsideBorders(range, borderType, BorderExtent.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, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE_HORIZONTAL:
|
||||
drawHorizontalBorders(range, borderType, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE_HORIZONTAL:
|
||||
drawOutsideBorders(range, borderType, BorderExtent.HORIZONTAL);
|
||||
break;
|
||||
case VERTICAL:
|
||||
drawVerticalBorders(range, borderType, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE_VERTICAL:
|
||||
drawVerticalBorders(range, borderType, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE_VERTICAL:
|
||||
drawOutsideBorders(range, borderType, BorderExtent.VERTICAL);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a group of cell borders and colors for a cell range to the border property template.
|
||||
* The borders are not applied to the cells at this time, just the template is drawn
|
||||
* (<code>drawBorders</code> stages changes using the border property template).
|
||||
* To apply the drawn borders to a sheet, use {@link #applyBorders}.
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
* @param color Color index from {@link IndexedColors} used to draw the borders.
|
||||
* @param extent BorderExtent of the borders to be applied.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public void drawColoredBorders(CellRangeAddress range, BorderStyle borderType, short color, BorderExtent extent) {
|
||||
drawBorders(range, borderType, extent);
|
||||
if (borderType != BorderStyle.NONE) {
|
||||
drawBorderColors(range, color, extent);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the top border for a range of cells
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
*/
|
||||
private void drawTopBorder(CellRangeAddress range, BorderStyle borderType) {
|
||||
int row = range.getFirstRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
boolean addBottom = (borderType == BorderStyle.NONE && row > 0);
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
addProperty(row, i, CellUtil.BORDER_TOP, borderType);
|
||||
if (addBottom) {
|
||||
addProperty(row - 1, i, CellUtil.BORDER_BOTTOM, borderType);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the bottom border for a range of cells
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
*/
|
||||
private void drawBottomBorder(CellRangeAddress range, BorderStyle borderType) {
|
||||
int row = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
boolean addTop = (borderType == BorderStyle.NONE && row < _ss.getLastRowIndex());
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
addProperty(row, i, CellUtil.BORDER_BOTTOM, borderType);
|
||||
if (addTop) {
|
||||
addProperty(row + 1, i, CellUtil.BORDER_TOP, borderType);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the left border for a range of cells
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
*/
|
||||
private void drawLeftBorder(CellRangeAddress range, BorderStyle borderType) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int col = range.getFirstColumn();
|
||||
boolean addRight = (borderType == BorderStyle.NONE && col > 0);
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
addProperty(i, col, CellUtil.BORDER_LEFT, borderType);
|
||||
if (addRight) {
|
||||
addProperty(i, col - 1, CellUtil.BORDER_RIGHT, borderType);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the right border for a range of cells
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
*/
|
||||
private void drawRightBorder(CellRangeAddress range, BorderStyle borderType) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int col = range.getLastColumn();
|
||||
boolean addLeft = (borderType == BorderStyle.NONE && col < _ss.getLastColumnIndex());
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
addProperty(i, col, CellUtil.BORDER_RIGHT, borderType);
|
||||
if (addLeft) {
|
||||
addProperty(i, col + 1, CellUtil.BORDER_LEFT, borderType);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the outside borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
* @param extent BorderExtent of the borders to be applied. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.HORIZONTAL</li>
|
||||
* <li>Extent.VERTICAL</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawOutsideBorders(CellRangeAddress range, BorderStyle borderType, BorderExtent extent) {
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
drawTopBorder(range, borderType);
|
||||
drawBottomBorder(range, borderType);
|
||||
drawLeftBorder(range, borderType);
|
||||
drawRightBorder(range, borderType);
|
||||
break;
|
||||
case HORIZONTAL:
|
||||
drawTopBorder(range, borderType);
|
||||
drawBottomBorder(range, borderType);
|
||||
break;
|
||||
case VERTICAL:
|
||||
drawLeftBorder(range, borderType);
|
||||
drawRightBorder(range, borderType);
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException(
|
||||
"Illegal BorderExtent. Allowed: ALL, HORIZONTAL, and VERTICAL");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the horizontal borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
* @param extent BorderExtent of the borders to be applied. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.INSIDE</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawHorizontalBorders(CellRangeAddress range, BorderStyle borderType, BorderExtent extent) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(i, i, firstCol, lastCol);
|
||||
drawTopBorder(row, borderType);
|
||||
drawBottomBorder(row, borderType);
|
||||
}
|
||||
break;
|
||||
case INSIDE:
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(i, i, firstCol, lastCol);
|
||||
if (i > firstRow) drawTopBorder(row, borderType);
|
||||
if (i < lastRow) drawBottomBorder(row, borderType);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException("Illegal BorderExtent. Allowed: ALL and INSIDE");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Draws the vertical borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which borders are drawn.
|
||||
* @param borderType Type of border to draw.
|
||||
* @param extent BorderExtent of the borders to be applied. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.INSIDE</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawVerticalBorders(CellRangeAddress range, BorderStyle borderType, BorderExtent extent) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(firstRow, lastRow, i, i);
|
||||
drawLeftBorder(row, borderType);
|
||||
drawRightBorder(row, borderType);
|
||||
}
|
||||
break;
|
||||
case INSIDE:
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(firstRow, lastRow, i, i);
|
||||
if (i > firstCol) drawLeftBorder(row, borderType);
|
||||
if (i < lastCol) drawRightBorder(row, borderType);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException("Illegal BorderExtent. Allowed: ALL and INSIDE");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all border properties from this BorderPropertyTemplate for the
|
||||
* specified range.
|
||||
*
|
||||
* @param range - range of cells to remove borders.
|
||||
*/
|
||||
private void removeBorders(CellRangeAddress range) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
for (int row = firstRow; row <= lastRow; row++) {
|
||||
for (int col = firstCol; col <= lastCol; col++) {
|
||||
CellAddress cell = new CellAddress(row, col);
|
||||
removeProperties(cell, BORDER_DIRECTION_PROPERTY_NAMES);
|
||||
}
|
||||
}
|
||||
removeBorderColors(range);
|
||||
}
|
||||
|
||||
/**
|
||||
* Applies the drawn borders to a Sheet. The borders that are applied are
|
||||
* the ones that have been drawn by {@link #drawColoredBorders}, {@link #drawBorders} and
|
||||
* {@link #drawBorderColors}.
|
||||
* The same border property template can be applied to multiple sheets
|
||||
* from the same or different workbooks.
|
||||
*
|
||||
* If the border property template contains cell addresses outside the valid range
|
||||
* of <code>sheet</code>, borders for those cell addresses are quietly ignored and
|
||||
* not applied to <code>sheet</code>.
|
||||
*
|
||||
* @param sheet Sheet on which to apply borders
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public void applyBorders(Sheet sheet) {
|
||||
SpreadsheetVersion ss = sheet.getWorkbook().getSpreadsheetVersion();
|
||||
int lastValidRow = ss.getLastRowIndex();
|
||||
int lastValidCol = ss.getLastColumnIndex();
|
||||
for (Entry<CellAddress, Map<String, Object>> entry : _propertyTemplate.entrySet()) {
|
||||
CellAddress cellAddress = entry.getKey();
|
||||
int r = cellAddress.getRow();
|
||||
int c = cellAddress.getColumn();
|
||||
if (r <= lastValidRow && c <= lastValidCol) {
|
||||
Row row = CellUtil.getRow(r, sheet);
|
||||
Cell cell = CellUtil.getCell(row, c);
|
||||
Map<String, Object> properties = entry.getValue();
|
||||
CellUtil.setCellStyleProperties(cell, properties);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the color for a group of cell borders for a cell range to the border property template.
|
||||
* The borders are not applied to the cells at this time, just the template is drawn
|
||||
* (<code>drawBorders</code> stages changes using the border property template).
|
||||
* If the borders do not exist, a {@link BorderStyle#THIN} border is used.
|
||||
* To apply the drawn borders to a sheet, use {@link #applyBorders}.
|
||||
*
|
||||
* @param range range of cells on which colors are set.
|
||||
* @param color Color index from {@link IndexedColors} used to draw the borders.
|
||||
* @param extent BorderExtent of the borders for which colors are set.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public void drawBorderColors(CellRangeAddress range, short color, BorderExtent extent) {
|
||||
switch (extent) {
|
||||
case NONE:
|
||||
removeBorderColors(range);
|
||||
break;
|
||||
case ALL:
|
||||
drawHorizontalBorderColors(range, color, BorderExtent.ALL);
|
||||
drawVerticalBorderColors(range, color, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE:
|
||||
drawHorizontalBorderColors(range, color, BorderExtent.INSIDE);
|
||||
drawVerticalBorderColors(range, color, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE:
|
||||
drawOutsideBorderColors(range, color, BorderExtent.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, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE_HORIZONTAL:
|
||||
drawHorizontalBorderColors(range, color, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE_HORIZONTAL:
|
||||
drawOutsideBorderColors(range, color, BorderExtent.HORIZONTAL);
|
||||
break;
|
||||
case VERTICAL:
|
||||
drawVerticalBorderColors(range, color, BorderExtent.ALL);
|
||||
break;
|
||||
case INSIDE_VERTICAL:
|
||||
drawVerticalBorderColors(range, color, BorderExtent.INSIDE);
|
||||
break;
|
||||
case OUTSIDE_VERTICAL:
|
||||
drawOutsideBorderColors(range, color, BorderExtent.VERTICAL);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the top border for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range 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++) {
|
||||
CellAddress cell = new CellAddress(row, i);
|
||||
// if BORDER_TOP is not set on BorderPropertyTemplate, make a thin border so that there's something to color
|
||||
if (borderIsNotSet(cell, CellUtil.BORDER_TOP)) {
|
||||
drawTopBorder(new CellRangeAddress(row, row, i, i), BorderStyle.THIN);
|
||||
}
|
||||
addProperty(cell, CellUtil.TOP_BORDER_COLOR, color);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the bottom border for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range 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++) {
|
||||
CellAddress cell = new CellAddress(row, i);
|
||||
// if BORDER_BOTTOM is not set on BorderPropertyTemplate, make a thin border so that there's something to color
|
||||
if (borderIsNotSet(cell, CellUtil.BORDER_BOTTOM)) {
|
||||
drawBottomBorder(new CellRangeAddress(row, row, i, i), BorderStyle.THIN);
|
||||
}
|
||||
addProperty(cell, CellUtil.BOTTOM_BORDER_COLOR, color);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the left border for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range 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++) {
|
||||
CellAddress cell = new CellAddress(i, col);
|
||||
// if BORDER_LEFT is not set on BorderPropertyTemplate, make a thin border so that there's something to color
|
||||
if (borderIsNotSet(cell, CellUtil.BORDER_LEFT)) {
|
||||
drawLeftBorder(new CellRangeAddress(i, i, col, col), BorderStyle.THIN);
|
||||
}
|
||||
addProperty(cell, CellUtil.LEFT_BORDER_COLOR, color);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A helper method to set the border line style before setting the color if the
|
||||
* current line style is not set.
|
||||
*/
|
||||
private boolean borderIsNotSet(CellAddress cell, String borderDirection) {
|
||||
Object borderLineStyle = getTemplateProperty(cell, borderDirection);
|
||||
return (borderLineStyle == null);
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the right border for a range of cells. If the border is
|
||||
* not drawn, it defaults to {@link BorderStyle#THIN}
|
||||
* </p>
|
||||
*
|
||||
* @param range 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++) {
|
||||
CellAddress cell = new CellAddress(i, col);
|
||||
// if BORDER_RIGHT is not set on BorderPropertyTemplate, make a thin border so that there's something to color
|
||||
if (borderIsNotSet(cell, CellUtil.BORDER_RIGHT)) {
|
||||
drawRightBorder(new CellRangeAddress(i, i, col, col), BorderStyle.THIN);
|
||||
}
|
||||
addProperty(cell, CellUtil.RIGHT_BORDER_COLOR, color);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the outside borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which colors are set.
|
||||
* @param color Color index from {@link IndexedColors} used to draw the borders.
|
||||
* @param extent BorderExtent of the borders for which colors are set. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.HORIZONTAL</li>
|
||||
* <li>Extent.VERTICAL</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawOutsideBorderColors(CellRangeAddress range, short color, BorderExtent extent) {
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
drawTopBorderColor(range, color);
|
||||
drawBottomBorderColor(range, color);
|
||||
drawLeftBorderColor(range, color);
|
||||
drawRightBorderColor(range, color);
|
||||
break;
|
||||
case HORIZONTAL:
|
||||
drawTopBorderColor(range, color);
|
||||
drawBottomBorderColor(range, color);
|
||||
break;
|
||||
case VERTICAL:
|
||||
drawLeftBorderColor(range, color);
|
||||
drawRightBorderColor(range, color);
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException(
|
||||
"Illegal BorderExtent. Allowed: ALL, HORIZONTAL, and VERTICAL");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the horizontal borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which colors are set.
|
||||
* @param color Color index from {@link IndexedColors} used to draw the borders.
|
||||
* @param extent BorderExtent of the borders for which colors are set. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.INSIDE</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawHorizontalBorderColors(CellRangeAddress range, short color, BorderExtent extent) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(i, i, firstCol, lastCol);
|
||||
drawTopBorderColor(row, color);
|
||||
drawBottomBorderColor(row, color);
|
||||
}
|
||||
break;
|
||||
case INSIDE:
|
||||
for (int i = firstRow; i <= lastRow; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(i, i, firstCol, lastCol);
|
||||
if (i > firstRow) drawTopBorderColor(row, color);
|
||||
if (i < lastRow) drawBottomBorderColor(row, color);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException("Illegal BorderExtent. Allowed: ALL and INSIDE");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* Sets the color of the vertical borders for a range of cells.
|
||||
* </p>
|
||||
*
|
||||
* @param range range of cells on which colors are set.
|
||||
* @param color Color index from {@link IndexedColors} used to draw the borders.
|
||||
* @param extent BorderExtent of the borders for which colors are set. Valid Values are:
|
||||
* <ul>
|
||||
* <li>Extent.ALL</li>
|
||||
* <li>Extent.INSIDE</li>
|
||||
* </ul>
|
||||
*/
|
||||
private void drawVerticalBorderColors(CellRangeAddress range, short color, BorderExtent extent) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstCol = range.getFirstColumn();
|
||||
int lastCol = range.getLastColumn();
|
||||
switch (extent) {
|
||||
case ALL:
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(firstRow, lastRow, i, i);
|
||||
drawLeftBorderColor(row, color);
|
||||
drawRightBorderColor(row, color);
|
||||
}
|
||||
break;
|
||||
case INSIDE:
|
||||
for (int i = firstCol; i <= lastCol; i++) {
|
||||
CellRangeAddress row = new CellRangeAddress(firstRow, lastRow, i, i);
|
||||
if (i > firstCol) drawLeftBorderColor(row, color);
|
||||
if (i < lastCol) drawRightBorderColor(row, color);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
throw new IllegalArgumentException("Illegal BorderExtent. Allowed: ALL and INSIDE");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all border properties from this BorderPropertyTemplate for the
|
||||
* specified range.
|
||||
*
|
||||
* @param range - range of cells to remove borders.
|
||||
*/
|
||||
private void removeBorderColors(CellRangeAddress range) {
|
||||
int firstRow = range.getFirstRow();
|
||||
int lastRow = range.getLastRow();
|
||||
int firstColumn = range.getFirstColumn();
|
||||
int lastColumn = range.getLastColumn();
|
||||
for (int row = firstRow; row <= lastRow; row++) {
|
||||
for (int col = firstColumn; col <= lastColumn; col++) {
|
||||
CellAddress cell = new CellAddress(row, col);
|
||||
removeProperties(cell, BORDER_COLOR_PROPERTY_NAMES);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a property to this BorderPropertyTemplate for a given cell
|
||||
*
|
||||
* @param cell The cell to add the property to in the property template.
|
||||
* @param property The property key to add to the property template.
|
||||
* @param value The property value to add to the property template.
|
||||
*/
|
||||
private void addProperty(CellAddress cell, String property, Object value) {
|
||||
Map<String, Object> cellProperties = _propertyTemplate.get(cell);
|
||||
if (cellProperties == null) {
|
||||
cellProperties = new HashMap<String, Object>();
|
||||
}
|
||||
cellProperties.put(property, value);
|
||||
_propertyTemplate.put(cell, cellProperties);
|
||||
}
|
||||
/**
|
||||
* Adds a property to this BorderPropertyTemplate for a given cell
|
||||
*
|
||||
* @param row The row number of the cell to add the property to
|
||||
* @param col
|
||||
* @param property The property key to add to the property template.
|
||||
* @param value The property value to add to the property template.
|
||||
*/
|
||||
private void addProperty(int row, int col, String property, Object value) {
|
||||
CellAddress cell = new CellAddress(row, col);
|
||||
addProperty(cell, property, value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a set of properties from this BorderPropertyTemplate for a
|
||||
* given cell
|
||||
*
|
||||
* @param row the row index of the cell to remove properties from
|
||||
* @param col the column index of the cell to remove properties from
|
||||
* @param properties a list of the property names to remove from the cell
|
||||
*/
|
||||
private void removeProperties(CellAddress cell, Set<String> properties) {
|
||||
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 (a value between 0 and 4)
|
||||
*
|
||||
* @param cell the cell to count the number of borders on
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public int getNumBorders(CellAddress cell) {
|
||||
Map<String, Object> cellProperties = _propertyTemplate.get(cell);
|
||||
if (cellProperties == null) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
int count = 0;
|
||||
if (cellProperties.containsKey(CellUtil.BORDER_TOP)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.BORDER_LEFT)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.BORDER_RIGHT)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.BORDER_BOTTOM)) count++;
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the number of border colors assigned to a cell
|
||||
*
|
||||
* @param cell
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public int getNumBorderColors(CellAddress cell) {
|
||||
Map<String, Object> cellProperties = _propertyTemplate.get(cell);
|
||||
if (cellProperties == null) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
int count = 0;
|
||||
if (cellProperties.containsKey(CellUtil.TOP_BORDER_COLOR)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.LEFT_BORDER_COLOR)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.RIGHT_BORDER_COLOR)) count++;
|
||||
if (cellProperties.containsKey(CellUtil.BOTTOM_BORDER_COLOR)) count++;
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the border style for a given cell
|
||||
*
|
||||
* @param cell The cell to get a template property from.
|
||||
* @param property The template property to get from the BorderPropertyTemplate. Example: {@link CellUtil#BORDER_TOP}.
|
||||
* @return The stored template property. If property has not be set on the BorderPropertyTemplate, returns <code>null</code>.
|
||||
* @since 3.15 beta 2
|
||||
*/
|
||||
public Object getTemplateProperty(CellAddress cell, String property) {
|
||||
Map<String, Object> cellProperties = _propertyTemplate.get(cell);
|
||||
if (cellProperties != null) {
|
||||
return cellProperties.get(property);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
@ -24,11 +24,6 @@ import org.apache.poi.ss.usermodel.Workbook;
|
||||
|
||||
/**
|
||||
* Various utility functions that make working with a region of cells easier.
|
||||
*
|
||||
* @see BorderPropertyTemplate <code>BorderPropertyTemplate</code>
|
||||
* to store border changes to a data structure and apply the changes to
|
||||
* multiple sheets. <code>BorderPropertyTemplate</code>
|
||||
* also supports setting INTERNAL borders within a region.
|
||||
*/
|
||||
public final class RegionUtil {
|
||||
|
||||
@ -61,9 +56,6 @@ public final class RegionUtil {
|
||||
* Sets the left border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the left
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -99,9 +91,6 @@ public final class RegionUtil {
|
||||
* Sets the left border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the left
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -115,9 +104,6 @@ public final class RegionUtil {
|
||||
* Sets the left border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the left
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -137,9 +123,6 @@ public final class RegionUtil {
|
||||
* Sets the right border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the right
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -153,9 +136,6 @@ public final class RegionUtil {
|
||||
* Sets the right border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the right
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -175,9 +155,6 @@ public final class RegionUtil {
|
||||
* Sets the right border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the right
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -191,9 +168,6 @@ public final class RegionUtil {
|
||||
* Sets the right border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the right
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -213,9 +187,6 @@ public final class RegionUtil {
|
||||
* Sets the bottom border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the bottom
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -229,9 +200,6 @@ public final class RegionUtil {
|
||||
* Sets the bottom border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the bottom
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -251,9 +219,6 @@ public final class RegionUtil {
|
||||
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the bottom
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -267,9 +232,6 @@ public final class RegionUtil {
|
||||
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the bottom
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -289,9 +251,6 @@ public final class RegionUtil {
|
||||
* Sets the top border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the top
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -305,9 +264,6 @@ public final class RegionUtil {
|
||||
* Sets the top border for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the top
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param border The new border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
@ -327,9 +283,6 @@ public final class RegionUtil {
|
||||
* Sets the top border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the top
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param workbook The workbook that the region is on.
|
||||
@ -343,9 +296,6 @@ public final class RegionUtil {
|
||||
* Sets the top border color for a region of cells by manipulating the cell style of the individual
|
||||
* cells on the top
|
||||
*
|
||||
* @see BorderPropertyTemplate#drawBorders
|
||||
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality.
|
||||
*
|
||||
* @param color The color of the border
|
||||
* @param region The region that should have the border
|
||||
* @param sheet The sheet that the region is on.
|
||||
|
@ -1,767 +0,0 @@
|
||||
/* ====================================================================
|
||||
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 static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNull;
|
||||
|
||||
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.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.BorderPropertyTemplate.BorderExtent;
|
||||
import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Tests Spreadsheet BorderPropertyTemplate
|
||||
*
|
||||
* @see org.apache.poi.ss.util.BorderPropertyTemplate
|
||||
*/
|
||||
public final class TestBorderPropertyTemplate {
|
||||
private static final short RED = IndexedColors.RED.getIndex();
|
||||
private static final short BLUE = IndexedColors.BLUE.getIndex();
|
||||
private static final short AUTOMATIC = IndexedColors.AUTOMATIC.getIndex();
|
||||
|
||||
@Test
|
||||
public void createTemplateFromExisting() throws IOException {
|
||||
CellRangeAddress a1a1 = new CellRangeAddress(0, 0, 0, 0); //A1:A1
|
||||
CellAddress a1 = new CellAddress(0, 0); //A1
|
||||
|
||||
BorderPropertyTemplate pt1 = new BorderPropertyTemplate();
|
||||
pt1.drawColoredBorders(a1a1, BorderStyle.THIN, RED, BorderExtent.TOP);
|
||||
|
||||
// check to make sure borders were copied
|
||||
BorderPropertyTemplate pt2 = new BorderPropertyTemplate(pt1);
|
||||
assertEquals(1, pt2.getNumBorders(a1));
|
||||
assertThin(pt2.getTemplateProperty(a1, CellUtil.BORDER_TOP));
|
||||
assertRed(pt2.getTemplateProperty(a1, CellUtil.TOP_BORDER_COLOR));
|
||||
|
||||
// Changes to original template should not affect copied template.
|
||||
assertEquals(1, pt2.getNumBorders(a1));
|
||||
pt1.drawColoredBorders(a1a1, BorderStyle.THIN, RED, BorderExtent.LEFT);
|
||||
assertEquals(1, pt2.getNumBorders(a1));
|
||||
assertNull(pt2.getTemplateProperty(a1, CellUtil.BORDER_LEFT));
|
||||
assertNull(pt2.getTemplateProperty(a1, CellUtil.LEFT_BORDER_COLOR));
|
||||
|
||||
// Changes to copied template should not affect original template
|
||||
assertEquals(2, pt1.getNumBorders(a1));
|
||||
pt2.drawColoredBorders(a1a1, BorderStyle.THIN, RED, BorderExtent.RIGHT);
|
||||
assertEquals(2, pt1.getNumBorders(a1));
|
||||
assertNull(pt1.getTemplateProperty(a1, CellUtil.BORDER_RIGHT));
|
||||
assertNull(pt1.getTemplateProperty(a1, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getNumBorders() throws IOException {
|
||||
CellRangeAddress a1a1 = new CellRangeAddress(0, 0, 0, 0); //A1:A1
|
||||
CellAddress a1 = new CellAddress(0, 0); //A1
|
||||
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawBorders(a1a1, BorderStyle.THIN, BorderExtent.TOP);
|
||||
assertEquals(1, pt.getNumBorders(a1));
|
||||
|
||||
pt.drawBorders(a1a1, BorderStyle.MEDIUM, BorderExtent.BOTTOM);
|
||||
assertEquals(2, pt.getNumBorders(a1));
|
||||
|
||||
pt.drawBorders(a1a1, BorderStyle.MEDIUM, BorderExtent.NONE);
|
||||
assertEquals(0, pt.getNumBorders(a1));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getNumBorderColors() throws IOException {
|
||||
CellRangeAddress a1a1 = new CellRangeAddress(0, 0, 0, 0); //A1:A1
|
||||
CellAddress a1 = new CellAddress(0, 0); //A1
|
||||
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawBorderColors(a1a1, RED, BorderExtent.TOP);
|
||||
assertEquals(1, pt.getNumBorderColors(a1));
|
||||
|
||||
pt.drawBorderColors(a1a1, RED, BorderExtent.BOTTOM);
|
||||
assertEquals(2, pt.getNumBorderColors(a1));
|
||||
|
||||
pt.drawBorderColors(a1a1, RED, BorderExtent.NONE);
|
||||
assertEquals(0, pt.getNumBorderColors(a1));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTemplateProperties() throws IOException {
|
||||
CellRangeAddress a1a1 = new CellRangeAddress(0, 0, 0, 0); //A1:A1
|
||||
CellAddress a1 = new CellAddress(0, 0); //A1
|
||||
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawBorders(a1a1, BorderStyle.THIN, BorderExtent.TOP);
|
||||
assertThin(pt.getTemplateProperty(a1, CellUtil.BORDER_TOP));
|
||||
|
||||
pt.drawBorders(a1a1, BorderStyle.MEDIUM, BorderExtent.BOTTOM);
|
||||
assertMedium(pt.getTemplateProperty(a1, CellUtil.BORDER_BOTTOM));
|
||||
|
||||
pt.drawBorderColors(a1a1, RED, BorderExtent.TOP);
|
||||
assertRed(pt.getTemplateProperty(a1, CellUtil.TOP_BORDER_COLOR));
|
||||
|
||||
pt.drawBorderColors(a1a1, BLUE, BorderExtent.BOTTOM);
|
||||
assertBlue(pt.getTemplateProperty(a1, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void drawBorders() throws IOException {
|
||||
CellRangeAddress a1c3 = new CellRangeAddress(0, 2, 0, 2); //A1:C3
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.THIN, BorderExtent.ALL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(4, pt.getNumBorders(addr));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.OUTSIDE);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(4, pt.getNumBorders(addr));
|
||||
if (i == 0) {
|
||||
if (j == 0) {
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else if (j == 2) {
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else {
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
} else if (i == 2) {
|
||||
if (j == 0) {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else if (j == 2) {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
} else {
|
||||
if (j == 0) {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else if (j == 2) {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else {
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertThin(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.TOP);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.BOTTOM);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.LEFT);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.RIGHT);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.INSIDE_HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
} else if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
} else {
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.OUTSIDE_HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
} else if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.INSIDE_VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
} else {
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawBorders(a1c3, BorderStyle.MEDIUM, BorderExtent.OUTSIDE_VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
} else if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void drawBorderColors() throws IOException {
|
||||
CellRangeAddress a1c3 = new CellRangeAddress(0, 2, 0, 2);
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawBorderColors(a1c3, RED, BorderExtent.ALL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
String msg = addr.formatAsString();
|
||||
assertEquals(msg, 4, pt.getNumBorders(addr));
|
||||
assertEquals(msg, 4, pt.getNumBorderColors(addr));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.OUTSIDE);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(4, pt.getNumBorders(addr));
|
||||
assertEquals(4, pt.getNumBorderColors(addr));
|
||||
if (i == 0) {
|
||||
if (j == 0) {
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else if (j == 2) {
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else {
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
} else if (i == 2) {
|
||||
if (j == 0) {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else if (j == 2) {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
} else {
|
||||
if (j == 0) {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else if (j == 2) {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else {
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.TOP);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.BOTTOM);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.LEFT);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.RIGHT);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertEquals(2, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.INSIDE_HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
} else if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertEquals(2, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.OUTSIDE_HORIZONTAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (i == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
} else if (i == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertEquals(2, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.INSIDE_VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(2, pt.getNumBorders(addr));
|
||||
assertEquals(2, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, AUTOMATIC, BorderExtent.NONE);
|
||||
pt.drawBorderColors(a1c3, BLUE, BorderExtent.OUTSIDE_VERTICAL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
if (j == 0) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
} else if (j == 2) {
|
||||
assertEquals(1, pt.getNumBorders(addr));
|
||||
assertEquals(1, pt.getNumBorderColors(addr));
|
||||
assertBlue(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
} else {
|
||||
assertEquals(0, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void drawBordersWithColors() throws IOException {
|
||||
CellRangeAddress a1c3 = new CellRangeAddress(0, 2, 0, 2);
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.MEDIUM, RED, BorderExtent.ALL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(4, pt.getNumBorders(addr));
|
||||
assertEquals(4, pt.getNumBorderColors(addr));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertMedium(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.TOP_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.BOTTOM_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.LEFT_BORDER_COLOR));
|
||||
assertRed(pt.getTemplateProperty(addr, CellUtil.RIGHT_BORDER_COLOR));
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(a1c3, BorderStyle.NONE, BorderExtent.NONE);
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.NONE, RED, BorderExtent.ALL);
|
||||
for (int i = 0; i <= 2; i++) {
|
||||
for (int j = 0; j <= 2; j++) {
|
||||
CellAddress addr = new CellAddress(i, j);
|
||||
assertEquals(4, pt.getNumBorders(addr));
|
||||
assertEquals(0, pt.getNumBorderColors(addr));
|
||||
assertNone(pt.getTemplateProperty(addr, CellUtil.BORDER_TOP));
|
||||
assertNone(pt.getTemplateProperty(addr, CellUtil.BORDER_BOTTOM));
|
||||
assertNone(pt.getTemplateProperty(addr, CellUtil.BORDER_LEFT));
|
||||
assertNone(pt.getTemplateProperty(addr, CellUtil.BORDER_RIGHT));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void applyBorders() throws IOException {
|
||||
CellRangeAddress a1c3 = new CellRangeAddress(0, 2, 0, 2);
|
||||
CellRangeAddress b2 = new CellRangeAddress(1, 1, 1, 1);
|
||||
BorderPropertyTemplate pt = new BorderPropertyTemplate();
|
||||
Workbook wb = new HSSFWorkbook();
|
||||
Sheet sheet = wb.createSheet();
|
||||
|
||||
pt.drawColoredBorders(a1c3, BorderStyle.THIN, RED, BorderExtent.ALL);
|
||||
pt.applyBorders(sheet);
|
||||
|
||||
for (Row row: sheet) {
|
||||
for (Cell cell: row) {
|
||||
CellStyle cs = cell.getCellStyle();
|
||||
|
||||
assertThin(cs.getBorderTop());
|
||||
assertRed(cs.getTopBorderColor());
|
||||
|
||||
assertThin(cs.getBorderBottom());
|
||||
assertRed(cs.getBottomBorderColor());
|
||||
|
||||
assertThin(cs.getBorderLeft());
|
||||
assertRed(cs.getLeftBorderColor());
|
||||
|
||||
assertThin(cs.getBorderRight());
|
||||
assertRed(cs.getRightBorderColor());
|
||||
}
|
||||
}
|
||||
|
||||
pt.drawBorders(b2, BorderStyle.NONE, BorderExtent.ALL);
|
||||
pt.applyBorders(sheet);
|
||||
|
||||
for (Row row: sheet) {
|
||||
for (Cell cell: row) {
|
||||
CellStyle cs = cell.getCellStyle();
|
||||
if (cell.getColumnIndex() != 1 || row.getRowNum() == 0) {
|
||||
assertThin(cs.getBorderTop());
|
||||
assertRed(cs.getTopBorderColor());
|
||||
} else {
|
||||
assertNone(cs.getBorderTop());
|
||||
}
|
||||
if (cell.getColumnIndex() != 1 || row.getRowNum() == 2) {
|
||||
assertThin(cs.getBorderBottom());
|
||||
assertRed(cs.getBottomBorderColor());
|
||||
} else {
|
||||
assertNone(cs.getBorderBottom());
|
||||
}
|
||||
if (cell.getColumnIndex() == 0 || row.getRowNum() != 1) {
|
||||
assertThin(cs.getBorderLeft());
|
||||
assertRed(cs.getLeftBorderColor());
|
||||
} else {
|
||||
assertNone(cs.getBorderLeft());
|
||||
}
|
||||
if (cell.getColumnIndex() == 2 || row.getRowNum() != 1) {
|
||||
assertThin(cs.getBorderRight());
|
||||
assertRed(cs.getRightBorderColor());
|
||||
} else {
|
||||
assertNone(cs.getBorderRight());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
wb.close();
|
||||
}
|
||||
|
||||
// helper functions to make sure template properties were set correctly
|
||||
|
||||
//////// Border Styles ///////////
|
||||
private static void assertNone(Object actual) {
|
||||
assertNone((BorderStyle) actual);
|
||||
}
|
||||
private static void assertNone(BorderStyle actual) {
|
||||
assertEquals(BorderStyle.NONE, actual);
|
||||
}
|
||||
|
||||
private static void assertThin(Object actual) {
|
||||
assertThin((BorderStyle) actual);
|
||||
}
|
||||
private static void assertThin(BorderStyle actual) {
|
||||
assertEquals(BorderStyle.THIN, actual);
|
||||
}
|
||||
|
||||
private static void assertMedium(Object actual) {
|
||||
assertMedium((BorderStyle) actual);
|
||||
}
|
||||
private static void assertMedium(BorderStyle actual) {
|
||||
assertEquals(BorderStyle.MEDIUM, actual);
|
||||
}
|
||||
|
||||
//////// Border Colors (use IndexedColor codes, for now ///////////
|
||||
private static void assertRed(Object actual) {
|
||||
IndexedColors actualColor = IndexedColors.fromInt((Short) actual);
|
||||
assertRed(actualColor);
|
||||
}
|
||||
private static void assertRed(IndexedColors actual) {
|
||||
assertEquals(IndexedColors.RED, actual);
|
||||
}
|
||||
|
||||
private static void assertBlue(Object actual) {
|
||||
IndexedColors actualColor = IndexedColors.fromInt((Short) actual);
|
||||
assertBlue(actualColor);
|
||||
}
|
||||
private static void assertBlue(IndexedColors actual) {
|
||||
assertEquals(IndexedColors.BLUE, actual);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user