Bugzilla 9633 - added common code for setting borders of regions (patch from Avinash Kewalramani, Jan22 on POI Users)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@783554 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Josh Micich
parent
af23e1554d
commit
b1081a7e4d
@ -18,16 +18,13 @@
|
|||||||
package org.apache.poi.hssf.usermodel.contrib;
|
package org.apache.poi.hssf.usermodel.contrib;
|
||||||
|
|
||||||
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.Map;
|
|
||||||
|
|
||||||
import org.apache.poi.hssf.usermodel.HSSFCell;
|
import org.apache.poi.hssf.usermodel.HSSFCell;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
|
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFFont;
|
import org.apache.poi.hssf.usermodel.HSSFFont;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFRichTextString;
|
|
||||||
import org.apache.poi.hssf.usermodel.HSSFRow;
|
import org.apache.poi.hssf.usermodel.HSSFRow;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFSheet;
|
import org.apache.poi.hssf.usermodel.HSSFSheet;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
||||||
|
import org.apache.poi.ss.usermodel.contrib.CellUtil;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Various utility functions that make working with a cells and rows easier. The various
|
* Various utility functions that make working with a cells and rows easier. The various
|
||||||
@ -39,42 +36,7 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
|||||||
*
|
*
|
||||||
*@author Eric Pugh epugh@upstate.com
|
*@author Eric Pugh epugh@upstate.com
|
||||||
*/
|
*/
|
||||||
public final class HSSFCellUtil
|
public final class HSSFCellUtil {
|
||||||
{
|
|
||||||
|
|
||||||
public static final String ALIGNMENT = "alignment";
|
|
||||||
public static final String BORDER_BOTTOM = "borderBottom";
|
|
||||||
public static final String BORDER_LEFT = "borderLeft";
|
|
||||||
public static final String BORDER_RIGHT = "borderRight";
|
|
||||||
public static final String BORDER_TOP = "borderTop";
|
|
||||||
public static final String BOTTOM_BORDER_COLOR = "bottomBorderColor";
|
|
||||||
public static final String DATA_FORMAT = "dataFormat";
|
|
||||||
public static final String FILL_BACKGROUND_COLOR = "fillBackgroundColor";
|
|
||||||
public static final String FILL_FOREGROUND_COLOR = "fillForegroundColor";
|
|
||||||
public static final String FILL_PATTERN = "fillPattern";
|
|
||||||
public static final String FONT = "font";
|
|
||||||
public static final String HIDDEN = "hidden";
|
|
||||||
public static final String INDENTION = "indention";
|
|
||||||
public static final String LEFT_BORDER_COLOR = "leftBorderColor";
|
|
||||||
public static final String LOCKED = "locked";
|
|
||||||
public static final String RIGHT_BORDER_COLOR = "rightBorderColor";
|
|
||||||
public static final String ROTATION = "rotation";
|
|
||||||
public static final String TOP_BORDER_COLOR = "topBorderColor";
|
|
||||||
public static final String VERTICAL_ALIGNMENT = "verticalAlignment";
|
|
||||||
public static final String WRAP_TEXT = "wrapText";
|
|
||||||
|
|
||||||
private static UnicodeMapping unicodeMappings[];
|
|
||||||
|
|
||||||
private static final class UnicodeMapping {
|
|
||||||
|
|
||||||
public final String entityName;
|
|
||||||
public final String resolvedValue;
|
|
||||||
|
|
||||||
public UnicodeMapping(String pEntityName, String pResolvedValue) {
|
|
||||||
entityName = "&" + pEntityName + ";";
|
|
||||||
resolvedValue = pResolvedValue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private HSSFCellUtil() {
|
private HSSFCellUtil() {
|
||||||
// no instances of this class
|
// no instances of this class
|
||||||
@ -83,41 +45,25 @@ public final class HSSFCellUtil
|
|||||||
/**
|
/**
|
||||||
* Get a row from the spreadsheet, and create it if it doesn't exist.
|
* Get a row from the spreadsheet, and create it if it doesn't exist.
|
||||||
*
|
*
|
||||||
*@param rowCounter The 0 based row number
|
*@param rowIndex The 0 based row number
|
||||||
*@param sheet The sheet that the row is part of.
|
*@param sheet The sheet that the row is part of.
|
||||||
*@return The row indicated by the rowCounter
|
*@return The row indicated by the rowCounter
|
||||||
*/
|
*/
|
||||||
public static HSSFRow getRow( int rowCounter, HSSFSheet sheet )
|
public static HSSFRow getRow(int rowIndex, HSSFSheet sheet) {
|
||||||
{
|
return (HSSFRow) CellUtil.getRow(rowIndex, sheet);
|
||||||
HSSFRow row = sheet.getRow( rowCounter );
|
|
||||||
if ( row == null )
|
|
||||||
{
|
|
||||||
row = sheet.createRow( rowCounter );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return row;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a specific cell from a row. If the cell doesn't exist,
|
* Get a specific cell from a row. If the cell doesn't exist,
|
||||||
* then create it.
|
* then create it.
|
||||||
*
|
*
|
||||||
*@param row The row that the cell is part of
|
*@param row The row that the cell is part of
|
||||||
*@param column The column index that the cell is in.
|
*@param columnIndex The column index that the cell is in.
|
||||||
*@return The cell indicated by the column.
|
*@return The cell indicated by the column.
|
||||||
*/
|
*/
|
||||||
public static HSSFCell getCell( HSSFRow row, int column )
|
public static HSSFCell getCell(HSSFRow row, int columnIndex) {
|
||||||
{
|
return (HSSFCell) CellUtil.getCell(row, columnIndex);
|
||||||
HSSFCell cell = row.getCell( column );
|
|
||||||
|
|
||||||
if ( cell == null )
|
|
||||||
{
|
|
||||||
cell = row.createCell(column );
|
|
||||||
}
|
}
|
||||||
return cell;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a cell, gives it a value, and applies a style if provided
|
* Creates a cell, gives it a value, and applies a style if provided
|
||||||
@ -128,20 +74,10 @@ public final class HSSFCellUtil
|
|||||||
* @param style If the style is not null, then set
|
* @param style If the style is not null, then set
|
||||||
* @return A new HSSFCell
|
* @return A new HSSFCell
|
||||||
*/
|
*/
|
||||||
public static HSSFCell createCell( HSSFRow row, int column, String value, HSSFCellStyle style )
|
public static HSSFCell createCell(HSSFRow row, int column, String value, HSSFCellStyle style) {
|
||||||
{
|
return (HSSFCell) CellUtil.createCell(row, column, value, style);
|
||||||
HSSFCell cell = getCell( row, column );
|
|
||||||
|
|
||||||
cell.setCellValue(new HSSFRichTextString(value));
|
|
||||||
if ( style != null )
|
|
||||||
{
|
|
||||||
cell.setCellStyle( style );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return cell;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a cell, and give it a value.
|
* Create a cell, and give it a value.
|
||||||
*
|
*
|
||||||
@ -150,12 +86,10 @@ public final class HSSFCellUtil
|
|||||||
*@param value The value of the cell
|
*@param value The value of the cell
|
||||||
*@return A new HSSFCell.
|
*@return A new HSSFCell.
|
||||||
*/
|
*/
|
||||||
public static HSSFCell createCell( HSSFRow row, int column, String value )
|
public static HSSFCell createCell(HSSFRow row, int column, String value) {
|
||||||
{
|
|
||||||
return createCell( row, column, value, null );
|
return createCell( row, column, value, null );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Take a cell, and align it.
|
* Take a cell, and align it.
|
||||||
*
|
*
|
||||||
@ -165,9 +99,8 @@ public final class HSSFCellUtil
|
|||||||
*
|
*
|
||||||
* @see HSSFCellStyle for alignment options
|
* @see HSSFCellStyle for alignment options
|
||||||
*/
|
*/
|
||||||
public static void setAlignment( HSSFCell cell, HSSFWorkbook workbook, short align )
|
public static void setAlignment(HSSFCell cell, HSSFWorkbook workbook, short align) {
|
||||||
{
|
CellUtil.setAlignment(cell, workbook, align);
|
||||||
setCellStyleProperty( cell, workbook, ALIGNMENT, new Short( align ) );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -177,9 +110,8 @@ public final class HSSFCellUtil
|
|||||||
*@param workbook The workbook that is being worked with.
|
*@param workbook The workbook that is being worked with.
|
||||||
*@param font The HSSFFont that you want to set...
|
*@param font The HSSFFont that you want to set...
|
||||||
*/
|
*/
|
||||||
public static void setFont( HSSFCell cell, HSSFWorkbook workbook, HSSFFont font )
|
public static void setFont(HSSFCell cell, HSSFWorkbook workbook, HSSFFont font) {
|
||||||
{
|
CellUtil.setFont(cell, workbook, font);
|
||||||
setCellStyleProperty( cell, workbook, FONT, font );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -195,158 +127,10 @@ public final class HSSFCellUtil
|
|||||||
*@param propertyValue The value of the property that is to be
|
*@param propertyValue The value of the property that is to be
|
||||||
* changed.
|
* changed.
|
||||||
*@param cell The cell that needs it's style changes
|
*@param cell The cell that needs it's style changes
|
||||||
*@exception NestableException Thrown if an error happens.
|
|
||||||
*/
|
*/
|
||||||
public static void setCellStyleProperty( HSSFCell cell, HSSFWorkbook workbook, String propertyName, Object propertyValue )
|
public static void setCellStyleProperty(HSSFCell cell, HSSFWorkbook workbook,
|
||||||
{
|
String propertyName, Object propertyValue) {
|
||||||
HSSFCellStyle originalStyle = cell.getCellStyle();
|
CellUtil.setCellStyleProperty(cell, workbook, propertyName, propertyValue);
|
||||||
HSSFCellStyle newStyle = null;
|
|
||||||
Map values = getFormatProperties( originalStyle );
|
|
||||||
values.put( propertyName, propertyValue );
|
|
||||||
|
|
||||||
// index seems like what index the cellstyle is in the list of styles for a workbook.
|
|
||||||
// not good to compare on!
|
|
||||||
short numberCellStyles = workbook.getNumCellStyles();
|
|
||||||
|
|
||||||
for ( short i = 0; i < numberCellStyles; i++ )
|
|
||||||
{
|
|
||||||
HSSFCellStyle wbStyle = workbook.getCellStyleAt( i );
|
|
||||||
Map wbStyleMap = getFormatProperties( wbStyle );
|
|
||||||
|
|
||||||
if ( wbStyleMap.equals( values ) )
|
|
||||||
{
|
|
||||||
newStyle = wbStyle;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ( newStyle == null )
|
|
||||||
{
|
|
||||||
newStyle = workbook.createCellStyle();
|
|
||||||
setFormatProperties( newStyle, workbook, values );
|
|
||||||
}
|
|
||||||
|
|
||||||
cell.setCellStyle( newStyle );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a map containing the format properties of the given cell style.
|
|
||||||
*
|
|
||||||
* @param style cell style
|
|
||||||
* @return map of format properties (String -> Object)
|
|
||||||
* @see #setFormatProperties(HSSFCellStyle, Map)
|
|
||||||
*/
|
|
||||||
private static Map getFormatProperties(HSSFCellStyle style) {
|
|
||||||
Map properties = new HashMap();
|
|
||||||
putShort( properties, ALIGNMENT, style.getAlignment() );
|
|
||||||
putShort( properties, BORDER_BOTTOM, style.getBorderBottom() );
|
|
||||||
putShort( properties, BORDER_LEFT, style.getBorderLeft() );
|
|
||||||
putShort( properties, BORDER_RIGHT, style.getBorderRight() );
|
|
||||||
putShort( properties, BORDER_TOP, style.getBorderTop() );
|
|
||||||
putShort( properties, BOTTOM_BORDER_COLOR, style.getBottomBorderColor() );
|
|
||||||
putShort( properties, DATA_FORMAT, style.getDataFormat() );
|
|
||||||
putShort( properties, FILL_BACKGROUND_COLOR, style.getFillBackgroundColor() );
|
|
||||||
putShort( properties, FILL_FOREGROUND_COLOR, style.getFillForegroundColor() );
|
|
||||||
putShort( properties, FILL_PATTERN, style.getFillPattern() );
|
|
||||||
putShort( properties, FONT, style.getFontIndex() );
|
|
||||||
putBoolean( properties, HIDDEN, style.getHidden() );
|
|
||||||
putShort( properties, INDENTION, style.getIndention() );
|
|
||||||
putShort( properties, LEFT_BORDER_COLOR, style.getLeftBorderColor() );
|
|
||||||
putBoolean( properties, LOCKED, style.getLocked() );
|
|
||||||
putShort( properties, RIGHT_BORDER_COLOR, style.getRightBorderColor() );
|
|
||||||
putShort( properties, ROTATION, style.getRotation() );
|
|
||||||
putShort( properties, TOP_BORDER_COLOR, style.getTopBorderColor() );
|
|
||||||
putShort( properties, VERTICAL_ALIGNMENT, style.getVerticalAlignment() );
|
|
||||||
putBoolean( properties, WRAP_TEXT, style.getWrapText() );
|
|
||||||
return properties;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the format properties of the given style based on the given map.
|
|
||||||
*
|
|
||||||
* @param style cell style
|
|
||||||
* @param workbook parent workbook
|
|
||||||
* @param properties map of format properties (String -> Object)
|
|
||||||
* @see #getFormatProperties(HSSFCellStyle)
|
|
||||||
*/
|
|
||||||
private static void setFormatProperties(
|
|
||||||
HSSFCellStyle style, HSSFWorkbook workbook, Map properties) {
|
|
||||||
style.setAlignment( getShort( properties, ALIGNMENT ) );
|
|
||||||
style.setBorderBottom( getShort( properties, BORDER_BOTTOM ) );
|
|
||||||
style.setBorderLeft( getShort( properties, BORDER_LEFT ) );
|
|
||||||
style.setBorderRight( getShort( properties, BORDER_RIGHT ) );
|
|
||||||
style.setBorderTop( getShort( properties, BORDER_TOP ) );
|
|
||||||
style.setBottomBorderColor( getShort( properties, BOTTOM_BORDER_COLOR ) );
|
|
||||||
style.setDataFormat( getShort( properties, DATA_FORMAT ) );
|
|
||||||
style.setFillBackgroundColor( getShort( properties, FILL_BACKGROUND_COLOR ) );
|
|
||||||
style.setFillForegroundColor( getShort( properties, FILL_FOREGROUND_COLOR ) );
|
|
||||||
style.setFillPattern( getShort( properties, FILL_PATTERN ) );
|
|
||||||
style.setFont( workbook.getFontAt( getShort( properties, FONT ) ) );
|
|
||||||
style.setHidden( getBoolean( properties, HIDDEN ) );
|
|
||||||
style.setIndention( getShort( properties, INDENTION ) );
|
|
||||||
style.setLeftBorderColor( getShort( properties, LEFT_BORDER_COLOR ) );
|
|
||||||
style.setLocked( getBoolean( properties, LOCKED ) );
|
|
||||||
style.setRightBorderColor( getShort( properties, RIGHT_BORDER_COLOR ) );
|
|
||||||
style.setRotation( getShort( properties, ROTATION ) );
|
|
||||||
style.setTopBorderColor( getShort( properties, TOP_BORDER_COLOR ) );
|
|
||||||
style.setVerticalAlignment( getShort( properties, VERTICAL_ALIGNMENT ) );
|
|
||||||
style.setWrapText( getBoolean( properties, WRAP_TEXT ) );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Utility method that returns the named short value form the given map.
|
|
||||||
* Returns zero if the property does not exist, or is not a {@link Short}.
|
|
||||||
*
|
|
||||||
* @param properties map of named properties (String -> Object)
|
|
||||||
* @param name property name
|
|
||||||
* @return property value, or zero
|
|
||||||
*/
|
|
||||||
private static short getShort(Map properties, String name) {
|
|
||||||
Object value = properties.get( name );
|
|
||||||
if ( value instanceof Short ) {
|
|
||||||
return ((Short) value).shortValue();
|
|
||||||
} else {
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Utility method that returns the named boolean value form the given map.
|
|
||||||
* Returns false if the property does not exist, or is not a {@link Boolean}.
|
|
||||||
*
|
|
||||||
* @param properties map of properties (String -> Object)
|
|
||||||
* @param name property name
|
|
||||||
* @return property value, or false
|
|
||||||
*/
|
|
||||||
private static boolean getBoolean(Map properties, String name) {
|
|
||||||
Object value = properties.get( name );
|
|
||||||
if ( value instanceof Boolean ) {
|
|
||||||
return ((Boolean) value).booleanValue();
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Utility method that puts the named short value to the given map.
|
|
||||||
*
|
|
||||||
* @param properties map of properties (String -> Object)
|
|
||||||
* @param name property name
|
|
||||||
* @param value property value
|
|
||||||
*/
|
|
||||||
private static void putShort(Map properties, String name, short value) {
|
|
||||||
properties.put( name, new Short( value ) );
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Utility method that puts the named boolean value to the given map.
|
|
||||||
*
|
|
||||||
* @param properties map of properties (String -> Object)
|
|
||||||
* @param name property name
|
|
||||||
* @param value property value
|
|
||||||
*/
|
|
||||||
private static void putBoolean(Map properties, String name, boolean value) {
|
|
||||||
properties.put( name, new Boolean( value ) );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -354,52 +138,10 @@ public final class HSSFCellUtil
|
|||||||
* unicode version of it.
|
* unicode version of it.
|
||||||
*
|
*
|
||||||
*@param cell The cell to check for unicode values
|
*@param cell The cell to check for unicode values
|
||||||
*@return transalted to unicode
|
*@return translated to unicode
|
||||||
*/
|
*/
|
||||||
public static HSSFCell translateUnicodeValues( HSSFCell cell )
|
public static HSSFCell translateUnicodeValues(HSSFCell cell){
|
||||||
{
|
CellUtil.translateUnicodeValues(cell);
|
||||||
|
|
||||||
String s = cell.getRichStringCellValue().getString();
|
|
||||||
boolean foundUnicode = false;
|
|
||||||
String lowerCaseStr = s.toLowerCase();
|
|
||||||
|
|
||||||
for (int i = 0; i < unicodeMappings.length; i++) {
|
|
||||||
UnicodeMapping entry = unicodeMappings[i];
|
|
||||||
String key = entry.entityName;
|
|
||||||
if ( lowerCaseStr.indexOf( key ) != -1 )
|
|
||||||
{
|
|
||||||
s = s.replaceAll(key, entry.resolvedValue);
|
|
||||||
foundUnicode = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if ( foundUnicode )
|
|
||||||
{
|
|
||||||
cell.setCellValue(new HSSFRichTextString(s));
|
|
||||||
}
|
|
||||||
return cell;
|
return cell;
|
||||||
}
|
}
|
||||||
|
|
||||||
static {
|
|
||||||
unicodeMappings = new UnicodeMapping[] {
|
|
||||||
um("alpha", "\u03B1" ),
|
|
||||||
um("beta", "\u03B2" ),
|
|
||||||
um("gamma", "\u03B3" ),
|
|
||||||
um("delta", "\u03B4" ),
|
|
||||||
um("epsilon", "\u03B5" ),
|
|
||||||
um("zeta", "\u03B6" ),
|
|
||||||
um("eta", "\u03B7" ),
|
|
||||||
um("theta", "\u03B8" ),
|
|
||||||
um("iota", "\u03B9" ),
|
|
||||||
um("kappa", "\u03BA" ),
|
|
||||||
um("lambda", "\u03BB" ),
|
|
||||||
um("mu", "\u03BC" ),
|
|
||||||
um("nu", "\u03BD" ),
|
|
||||||
um("xi", "\u03BE" ),
|
|
||||||
um("omicron", "\u03BF" ),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
private static UnicodeMapping um(String entityName, String resolvedValue) {
|
|
||||||
return new UnicodeMapping(entityName, resolvedValue);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -17,10 +17,9 @@
|
|||||||
|
|
||||||
package org.apache.poi.hssf.usermodel.contrib;
|
package org.apache.poi.hssf.usermodel.contrib;
|
||||||
|
|
||||||
import org.apache.poi.hssf.usermodel.HSSFCell;
|
|
||||||
import org.apache.poi.hssf.usermodel.HSSFRow;
|
|
||||||
import org.apache.poi.hssf.usermodel.HSSFSheet;
|
import org.apache.poi.hssf.usermodel.HSSFSheet;
|
||||||
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
|
||||||
|
import org.apache.poi.ss.usermodel.contrib.RegionUtil;
|
||||||
import org.apache.poi.ss.util.CellRangeAddress;
|
import org.apache.poi.ss.util.CellRangeAddress;
|
||||||
import org.apache.poi.ss.util.Region;
|
import org.apache.poi.ss.util.Region;
|
||||||
|
|
||||||
@ -34,25 +33,6 @@ public final class HSSFRegionUtil {
|
|||||||
private HSSFRegionUtil() {
|
private HSSFRegionUtil() {
|
||||||
// no instances of this class
|
// no instances of this class
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* For setting the same property on many cells to the same value
|
|
||||||
*/
|
|
||||||
private static final class CellPropertySetter {
|
|
||||||
|
|
||||||
private final HSSFWorkbook _workbook;
|
|
||||||
private final String _propertyName;
|
|
||||||
private final Short _propertyValue;
|
|
||||||
|
|
||||||
public CellPropertySetter(HSSFWorkbook workbook, String propertyName, int value) {
|
|
||||||
_workbook = workbook;
|
|
||||||
_propertyName = propertyName;
|
|
||||||
_propertyValue = new Short((short)value);
|
|
||||||
}
|
|
||||||
public void setProperty(HSSFRow row, int column) {
|
|
||||||
HSSFCell cell = HSSFCellUtil.getCell(row, column);
|
|
||||||
HSSFCellUtil.setCellStyleProperty(cell, _workbook, _propertyName, _propertyValue);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static CellRangeAddress toCRA(Region region) {
|
private static CellRangeAddress toCRA(Region region) {
|
||||||
return Region.convertToCellRangeAddress(region);
|
return Region.convertToCellRangeAddress(region);
|
||||||
@ -76,14 +56,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setBorderLeft(int border, CellRangeAddress region, HSSFSheet sheet,
|
public static void setBorderLeft(int border, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int rowStart = region.getFirstRow();
|
RegionUtil.setBorderLeft(border, region, sheet, workbook);
|
||||||
int rowEnd = region.getLastRow();
|
|
||||||
int column = region.getFirstColumn();
|
|
||||||
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.BORDER_LEFT, border);
|
|
||||||
for (int i = rowStart; i <= rowEnd; i++) {
|
|
||||||
cps.setProperty(HSSFCellUtil.getRow(i, sheet), column);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -103,14 +76,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setLeftBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
public static void setLeftBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int rowStart = region.getFirstRow();
|
RegionUtil.setLeftBorderColor(color, region, sheet, workbook);
|
||||||
int rowEnd = region.getLastRow();
|
|
||||||
int column = region.getFirstColumn();
|
|
||||||
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.LEFT_BORDER_COLOR, color);
|
|
||||||
for (int i = rowStart; i <= rowEnd; i++) {
|
|
||||||
cps.setProperty(HSSFCellUtil.getRow(i, sheet), column);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -130,14 +96,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setBorderRight(int border, CellRangeAddress region, HSSFSheet sheet,
|
public static void setBorderRight(int border, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int rowStart = region.getFirstRow();
|
RegionUtil.setBorderRight(border, region, sheet, workbook);
|
||||||
int rowEnd = region.getLastRow();
|
|
||||||
int column = region.getLastColumn();
|
|
||||||
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.BORDER_RIGHT, border);
|
|
||||||
for (int i = rowStart; i <= rowEnd; i++) {
|
|
||||||
cps.setProperty(HSSFCellUtil.getRow(i, sheet), column);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -157,14 +116,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setRightBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
public static void setRightBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int rowStart = region.getFirstRow();
|
RegionUtil.setRightBorderColor(color, region, sheet, workbook);
|
||||||
int rowEnd = region.getLastRow();
|
|
||||||
int column = region.getLastColumn();
|
|
||||||
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.RIGHT_BORDER_COLOR, color);
|
|
||||||
for (int i = rowStart; i <= rowEnd; i++) {
|
|
||||||
cps.setProperty(HSSFCellUtil.getRow(i, sheet), column);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -184,14 +136,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setBorderBottom(int border, CellRangeAddress region, HSSFSheet sheet,
|
public static void setBorderBottom(int border, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int colStart = region.getFirstColumn();
|
RegionUtil.setBorderBottom(border, region, sheet, workbook);
|
||||||
int colEnd = region.getLastColumn();
|
|
||||||
int rowIndex = region.getLastRow();
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.BORDER_BOTTOM, border);
|
|
||||||
HSSFRow row = HSSFCellUtil.getRow(rowIndex, sheet);
|
|
||||||
for (int i = colStart; i <= colEnd; i++) {
|
|
||||||
cps.setProperty(row, i);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -211,14 +156,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setBottomBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
public static void setBottomBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int colStart = region.getFirstColumn();
|
RegionUtil.setBottomBorderColor(color, region, sheet, workbook);
|
||||||
int colEnd = region.getLastColumn();
|
|
||||||
int rowIndex = region.getLastRow();
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.BOTTOM_BORDER_COLOR, color);
|
|
||||||
HSSFRow row = HSSFCellUtil.getRow(rowIndex, sheet);
|
|
||||||
for (int i = colStart; i <= colEnd; i++) {
|
|
||||||
cps.setProperty(row, i);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -238,14 +176,7 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setBorderTop(int border, CellRangeAddress region, HSSFSheet sheet,
|
public static void setBorderTop(int border, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int colStart = region.getFirstColumn();
|
RegionUtil.setBorderTop(border, region, sheet, workbook);
|
||||||
int colEnd = region.getLastColumn();
|
|
||||||
int rowIndex = region.getFirstRow();
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.BORDER_TOP, border);
|
|
||||||
HSSFRow row = HSSFCellUtil.getRow(rowIndex, sheet);
|
|
||||||
for (int i = colStart; i <= colEnd; i++) {
|
|
||||||
cps.setProperty(row, i);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -265,13 +196,6 @@ public final class HSSFRegionUtil {
|
|||||||
*/
|
*/
|
||||||
public static void setTopBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
public static void setTopBorderColor(int color, CellRangeAddress region, HSSFSheet sheet,
|
||||||
HSSFWorkbook workbook) {
|
HSSFWorkbook workbook) {
|
||||||
int colStart = region.getFirstColumn();
|
RegionUtil.setTopBorderColor(color, region, sheet, workbook);
|
||||||
int colEnd = region.getLastColumn();
|
|
||||||
int rowIndex = region.getFirstRow();
|
|
||||||
CellPropertySetter cps = new CellPropertySetter(workbook, HSSFCellUtil.TOP_BORDER_COLOR, color);
|
|
||||||
HSSFRow row = HSSFCellUtil.getRow(rowIndex, sheet);
|
|
||||||
for (int i = colStart; i <= colEnd; i++) {
|
|
||||||
cps.setProperty(row, i);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -0,0 +1,379 @@
|
|||||||
|
/* ====================================================================
|
||||||
|
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.usermodel.contrib;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
import org.apache.poi.ss.usermodel.Cell;
|
||||||
|
import org.apache.poi.ss.usermodel.CellStyle;
|
||||||
|
import org.apache.poi.ss.usermodel.Font;
|
||||||
|
import org.apache.poi.ss.usermodel.Row;
|
||||||
|
import org.apache.poi.ss.usermodel.Sheet;
|
||||||
|
import org.apache.poi.ss.usermodel.Workbook;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Various utility functions that make working with a cells and rows easier. The various methods
|
||||||
|
* that deal with style's allow you to create your CellStyles as you need them. When you apply a
|
||||||
|
* style change to a cell, the code will attempt to see if a style already exists that meets your
|
||||||
|
* needs. If not, then it will create a new style. This is to prevent creating too many styles.
|
||||||
|
* there is an upper limit in Excel on the number of styles that can be supported.
|
||||||
|
*
|
||||||
|
*@author Eric Pugh epugh@upstate.com
|
||||||
|
*@author (secondary) Avinash Kewalramani akewalramani@accelrys.com
|
||||||
|
*/
|
||||||
|
public final class CellUtil {
|
||||||
|
|
||||||
|
public static final String ALIGNMENT = "alignment";
|
||||||
|
public static final String BORDER_BOTTOM = "borderBottom";
|
||||||
|
public static final String BORDER_LEFT = "borderLeft";
|
||||||
|
public static final String BORDER_RIGHT = "borderRight";
|
||||||
|
public static final String BORDER_TOP = "borderTop";
|
||||||
|
public static final String BOTTOM_BORDER_COLOR = "bottomBorderColor";
|
||||||
|
public static final String DATA_FORMAT = "dataFormat";
|
||||||
|
public static final String FILL_BACKGROUND_COLOR = "fillBackgroundColor";
|
||||||
|
public static final String FILL_FOREGROUND_COLOR = "fillForegroundColor";
|
||||||
|
public static final String FILL_PATTERN = "fillPattern";
|
||||||
|
public static final String FONT = "font";
|
||||||
|
public static final String HIDDEN = "hidden";
|
||||||
|
public static final String INDENTION = "indention";
|
||||||
|
public static final String LEFT_BORDER_COLOR = "leftBorderColor";
|
||||||
|
public static final String LOCKED = "locked";
|
||||||
|
public static final String RIGHT_BORDER_COLOR = "rightBorderColor";
|
||||||
|
public static final String ROTATION = "rotation";
|
||||||
|
public static final String TOP_BORDER_COLOR = "topBorderColor";
|
||||||
|
public static final String VERTICAL_ALIGNMENT = "verticalAlignment";
|
||||||
|
public static final String WRAP_TEXT = "wrapText";
|
||||||
|
|
||||||
|
private static UnicodeMapping unicodeMappings[];
|
||||||
|
|
||||||
|
private static final class UnicodeMapping {
|
||||||
|
|
||||||
|
public final String entityName;
|
||||||
|
public final String resolvedValue;
|
||||||
|
|
||||||
|
public UnicodeMapping(String pEntityName, String pResolvedValue) {
|
||||||
|
entityName = "&" + pEntityName + ";";
|
||||||
|
resolvedValue = pResolvedValue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private CellUtil() {
|
||||||
|
// no instances of this class
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a row from the spreadsheet, and create it if it doesn't exist.
|
||||||
|
*
|
||||||
|
*@param rowIndex The 0 based row number
|
||||||
|
*@param sheet The sheet that the row is part of.
|
||||||
|
*@return The row indicated by the rowCounter
|
||||||
|
*/
|
||||||
|
public static Row getRow(int rowIndex, Sheet sheet) {
|
||||||
|
Row row = sheet.getRow(rowIndex);
|
||||||
|
if (row == null) {
|
||||||
|
row = sheet.createRow(rowIndex);
|
||||||
|
}
|
||||||
|
return row;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a specific cell from a row. If the cell doesn't exist, then create it.
|
||||||
|
*
|
||||||
|
*@param row The row that the cell is part of
|
||||||
|
*@param columnIndex The column index that the cell is in.
|
||||||
|
*@return The cell indicated by the column.
|
||||||
|
*/
|
||||||
|
public static Cell getCell(Row row, int columnIndex) {
|
||||||
|
Cell cell = row.getCell(columnIndex);
|
||||||
|
|
||||||
|
if (cell == null) {
|
||||||
|
cell = row.createCell(columnIndex);
|
||||||
|
}
|
||||||
|
return cell;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a cell, gives it a value, and applies a style if provided
|
||||||
|
*
|
||||||
|
* @param row the row to create the cell in
|
||||||
|
* @param column the column index to create the cell in
|
||||||
|
* @param value The value of the cell
|
||||||
|
* @param style If the style is not null, then set
|
||||||
|
* @return A new Cell
|
||||||
|
*/
|
||||||
|
public static Cell createCell(Row row, int column, String value, CellStyle style) {
|
||||||
|
Cell cell = getCell(row, column);
|
||||||
|
|
||||||
|
cell.setCellValue(cell.getRow().getSheet().getWorkbook().getCreationHelper()
|
||||||
|
.createRichTextString(value));
|
||||||
|
if (style != null) {
|
||||||
|
cell.setCellStyle(style);
|
||||||
|
}
|
||||||
|
return cell;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a cell, and give it a value.
|
||||||
|
*
|
||||||
|
*@param row the row to create the cell in
|
||||||
|
*@param column the column index to create the cell in
|
||||||
|
*@param value The value of the cell
|
||||||
|
*@return A new Cell.
|
||||||
|
*/
|
||||||
|
public static Cell createCell(Row row, int column, String value) {
|
||||||
|
return createCell(row, column, value, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Take a cell, and align it.
|
||||||
|
*
|
||||||
|
*@param cell the cell to set the alignment for
|
||||||
|
*@param workbook The workbook that is being worked with.
|
||||||
|
*@param align the column alignment to use.
|
||||||
|
*
|
||||||
|
* @see CellStyle for alignment options
|
||||||
|
*/
|
||||||
|
public static void setAlignment(Cell cell, Workbook workbook, short align) {
|
||||||
|
setCellStyleProperty(cell, workbook, ALIGNMENT, new Short(align));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Take a cell, and apply a font to it
|
||||||
|
*
|
||||||
|
*@param cell the cell to set the alignment for
|
||||||
|
*@param workbook The workbook that is being worked with.
|
||||||
|
*@param font The Font that you want to set...
|
||||||
|
*/
|
||||||
|
public static void setFont(Cell cell, Workbook workbook, Font font) {
|
||||||
|
setCellStyleProperty(cell, workbook, FONT, font);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method attempt to find an already existing CellStyle that matches what you want the
|
||||||
|
* style to be. If it does not find the style, then it creates a new one. If it does create a
|
||||||
|
* new one, then it applies the propertyName and propertyValue to the style. This is necessary
|
||||||
|
* because Excel has an upper limit on the number of Styles that it supports.
|
||||||
|
*
|
||||||
|
*@param workbook The workbook that is being worked with.
|
||||||
|
*@param propertyName The name of the property that is to be changed.
|
||||||
|
*@param propertyValue The value of the property that is to be changed.
|
||||||
|
*@param cell The cell that needs it's style changes
|
||||||
|
*/
|
||||||
|
public static void setCellStyleProperty(Cell cell, Workbook workbook, String propertyName,
|
||||||
|
Object propertyValue) {
|
||||||
|
CellStyle originalStyle = cell.getCellStyle();
|
||||||
|
CellStyle newStyle = null;
|
||||||
|
Map<String, Object> values = getFormatProperties(originalStyle);
|
||||||
|
values.put(propertyName, propertyValue);
|
||||||
|
|
||||||
|
// index seems like what index the cellstyle is in the list of styles for a workbook.
|
||||||
|
// not good to compare on!
|
||||||
|
short numberCellStyles = workbook.getNumCellStyles();
|
||||||
|
|
||||||
|
for (short i = 0; i < numberCellStyles; i++) {
|
||||||
|
CellStyle wbStyle = workbook.getCellStyleAt(i);
|
||||||
|
Map<String, Object> wbStyleMap = getFormatProperties(wbStyle);
|
||||||
|
|
||||||
|
if (wbStyleMap.equals(values)) {
|
||||||
|
newStyle = wbStyle;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (newStyle == null) {
|
||||||
|
newStyle = workbook.createCellStyle();
|
||||||
|
setFormatProperties(newStyle, workbook, values);
|
||||||
|
}
|
||||||
|
|
||||||
|
cell.setCellStyle(newStyle);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a map containing the format properties of the given cell style.
|
||||||
|
*
|
||||||
|
* @param style cell style
|
||||||
|
* @return map of format properties (String -> Object)
|
||||||
|
* @see #setFormatProperties(CellStyle, Map)
|
||||||
|
*/
|
||||||
|
private static Map<String, Object> getFormatProperties(CellStyle style) {
|
||||||
|
Map<String, Object> properties = new HashMap<String, Object>();
|
||||||
|
putShort(properties, ALIGNMENT, style.getAlignment());
|
||||||
|
putShort(properties, BORDER_BOTTOM, style.getBorderBottom());
|
||||||
|
putShort(properties, BORDER_LEFT, style.getBorderLeft());
|
||||||
|
putShort(properties, BORDER_RIGHT, style.getBorderRight());
|
||||||
|
putShort(properties, BORDER_TOP, style.getBorderTop());
|
||||||
|
putShort(properties, BOTTOM_BORDER_COLOR, style.getBottomBorderColor());
|
||||||
|
putShort(properties, DATA_FORMAT, style.getDataFormat());
|
||||||
|
putShort(properties, FILL_BACKGROUND_COLOR, style.getFillBackgroundColor());
|
||||||
|
putShort(properties, FILL_FOREGROUND_COLOR, style.getFillForegroundColor());
|
||||||
|
putShort(properties, FILL_PATTERN, style.getFillPattern());
|
||||||
|
putShort(properties, FONT, style.getFontIndex());
|
||||||
|
putBoolean(properties, HIDDEN, style.getHidden());
|
||||||
|
putShort(properties, INDENTION, style.getIndention());
|
||||||
|
putShort(properties, LEFT_BORDER_COLOR, style.getLeftBorderColor());
|
||||||
|
putBoolean(properties, LOCKED, style.getLocked());
|
||||||
|
putShort(properties, RIGHT_BORDER_COLOR, style.getRightBorderColor());
|
||||||
|
putShort(properties, ROTATION, style.getRotation());
|
||||||
|
putShort(properties, TOP_BORDER_COLOR, style.getTopBorderColor());
|
||||||
|
putShort(properties, VERTICAL_ALIGNMENT, style.getVerticalAlignment());
|
||||||
|
putBoolean(properties, WRAP_TEXT, style.getWrapText());
|
||||||
|
return properties;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the format properties of the given style based on the given map.
|
||||||
|
*
|
||||||
|
* @param style cell style
|
||||||
|
* @param workbook parent workbook
|
||||||
|
* @param properties map of format properties (String -> Object)
|
||||||
|
* @see #getFormatProperties(CellStyle)
|
||||||
|
*/
|
||||||
|
private static void setFormatProperties(CellStyle style, Workbook workbook, Map<String, Object> properties) {
|
||||||
|
style.setAlignment(getShort(properties, ALIGNMENT));
|
||||||
|
style.setBorderBottom(getShort(properties, BORDER_BOTTOM));
|
||||||
|
style.setBorderLeft(getShort(properties, BORDER_LEFT));
|
||||||
|
style.setBorderRight(getShort(properties, BORDER_RIGHT));
|
||||||
|
style.setBorderTop(getShort(properties, BORDER_TOP));
|
||||||
|
style.setBottomBorderColor(getShort(properties, BOTTOM_BORDER_COLOR));
|
||||||
|
style.setDataFormat(getShort(properties, DATA_FORMAT));
|
||||||
|
style.setFillBackgroundColor(getShort(properties, FILL_BACKGROUND_COLOR));
|
||||||
|
style.setFillForegroundColor(getShort(properties, FILL_FOREGROUND_COLOR));
|
||||||
|
style.setFillPattern(getShort(properties, FILL_PATTERN));
|
||||||
|
style.setFont(workbook.getFontAt(getShort(properties, FONT)));
|
||||||
|
style.setHidden(getBoolean(properties, HIDDEN));
|
||||||
|
style.setIndention(getShort(properties, INDENTION));
|
||||||
|
style.setLeftBorderColor(getShort(properties, LEFT_BORDER_COLOR));
|
||||||
|
style.setLocked(getBoolean(properties, LOCKED));
|
||||||
|
style.setRightBorderColor(getShort(properties, RIGHT_BORDER_COLOR));
|
||||||
|
style.setRotation(getShort(properties, ROTATION));
|
||||||
|
style.setTopBorderColor(getShort(properties, TOP_BORDER_COLOR));
|
||||||
|
style.setVerticalAlignment(getShort(properties, VERTICAL_ALIGNMENT));
|
||||||
|
style.setWrapText(getBoolean(properties, WRAP_TEXT));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility method that returns the named short value form the given map.
|
||||||
|
* @return zero if the property does not exist, or is not a {@link Short}.
|
||||||
|
*
|
||||||
|
* @param properties map of named properties (String -> Object)
|
||||||
|
* @param name property name
|
||||||
|
* @return property value, or zero
|
||||||
|
*/
|
||||||
|
private static short getShort(Map<String, Object> properties, String name) {
|
||||||
|
Object value = properties.get(name);
|
||||||
|
if (value instanceof Short) {
|
||||||
|
return ((Short) value).shortValue();
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility method that returns the named boolean value form the given map.
|
||||||
|
* @return false if the property does not exist, or is not a {@link Boolean}.
|
||||||
|
*
|
||||||
|
* @param properties map of properties (String -> Object)
|
||||||
|
* @param name property name
|
||||||
|
* @return property value, or false
|
||||||
|
*/
|
||||||
|
private static boolean getBoolean(Map<String, Object> properties, String name) {
|
||||||
|
Object value = properties.get(name);
|
||||||
|
if (value instanceof Boolean) {
|
||||||
|
return ((Boolean) value).booleanValue();
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility method that puts the named short value to the given map.
|
||||||
|
*
|
||||||
|
* @param properties map of properties (String -> Object)
|
||||||
|
* @param name property name
|
||||||
|
* @param value property value
|
||||||
|
*/
|
||||||
|
private static void putShort(Map<String, Object> properties, String name, short value) {
|
||||||
|
properties.put(name, new Short(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility method that puts the named boolean value to the given map.
|
||||||
|
*
|
||||||
|
* @param properties map of properties (String -> Object)
|
||||||
|
* @param name property name
|
||||||
|
* @param value property value
|
||||||
|
*/
|
||||||
|
private static void putBoolean(Map<String, Object> properties, String name, boolean value) {
|
||||||
|
properties.put(name, new Boolean(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Looks for text in the cell that should be unicode, like α and provides the
|
||||||
|
* unicode version of it.
|
||||||
|
*
|
||||||
|
*@param cell The cell to check for unicode values
|
||||||
|
*@return translated to unicode
|
||||||
|
*/
|
||||||
|
public static Cell translateUnicodeValues(Cell cell) {
|
||||||
|
|
||||||
|
String s = cell.getRichStringCellValue().getString();
|
||||||
|
boolean foundUnicode = false;
|
||||||
|
String lowerCaseStr = s.toLowerCase();
|
||||||
|
|
||||||
|
for (int i = 0; i < unicodeMappings.length; i++) {
|
||||||
|
UnicodeMapping entry = unicodeMappings[i];
|
||||||
|
String key = entry.entityName;
|
||||||
|
if (lowerCaseStr.indexOf(key) != -1) {
|
||||||
|
s = s.replaceAll(key, entry.resolvedValue);
|
||||||
|
foundUnicode = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (foundUnicode) {
|
||||||
|
cell.setCellValue(cell.getRow().getSheet().getWorkbook().getCreationHelper()
|
||||||
|
.createRichTextString(s));
|
||||||
|
}
|
||||||
|
return cell;
|
||||||
|
}
|
||||||
|
|
||||||
|
static {
|
||||||
|
unicodeMappings = new UnicodeMapping[] {
|
||||||
|
um("alpha", "\u03B1" ),
|
||||||
|
um("beta", "\u03B2" ),
|
||||||
|
um("gamma", "\u03B3" ),
|
||||||
|
um("delta", "\u03B4" ),
|
||||||
|
um("epsilon", "\u03B5" ),
|
||||||
|
um("zeta", "\u03B6" ),
|
||||||
|
um("eta", "\u03B7" ),
|
||||||
|
um("theta", "\u03B8" ),
|
||||||
|
um("iota", "\u03B9" ),
|
||||||
|
um("kappa", "\u03BA" ),
|
||||||
|
um("lambda", "\u03BB" ),
|
||||||
|
um("mu", "\u03BC" ),
|
||||||
|
um("nu", "\u03BD" ),
|
||||||
|
um("xi", "\u03BE" ),
|
||||||
|
um("omicron", "\u03BF" ),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private static UnicodeMapping um(String entityName, String resolvedValue) {
|
||||||
|
return new UnicodeMapping(entityName, resolvedValue);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,224 @@
|
|||||||
|
/* ====================================================================
|
||||||
|
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.usermodel.contrib;
|
||||||
|
|
||||||
|
import org.apache.poi.ss.usermodel.Cell;
|
||||||
|
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.CellRangeAddress;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Various utility functions that make working with a region of cells easier.
|
||||||
|
*
|
||||||
|
* @author Eric Pugh epugh@upstate.com
|
||||||
|
* @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
|
||||||
|
*/
|
||||||
|
public final class RegionUtil {
|
||||||
|
|
||||||
|
private RegionUtil() {
|
||||||
|
// no instances of this class
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* For setting the same property on many cells to the same value
|
||||||
|
*/
|
||||||
|
private static final class CellPropertySetter {
|
||||||
|
|
||||||
|
private final Workbook _workbook;
|
||||||
|
private final String _propertyName;
|
||||||
|
private final Short _propertyValue;
|
||||||
|
|
||||||
|
|
||||||
|
public CellPropertySetter(Workbook workbook, String propertyName, int value) {
|
||||||
|
_workbook = workbook;
|
||||||
|
_propertyName = propertyName;
|
||||||
|
_propertyValue = new Short((short) value);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
public void setProperty(Row row, int column) {
|
||||||
|
Cell cell = CellUtil.getCell(row, column);
|
||||||
|
CellUtil.setCellStyleProperty(cell, _workbook, _propertyName, _propertyValue);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the left border for a region of cells by manipulating the cell style of the individual
|
||||||
|
* cells on the left
|
||||||
|
*
|
||||||
|
* @param border The new border
|
||||||
|
* @param region The region that should have the border
|
||||||
|
* @param workbook The workbook that the region is on.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int rowStart = region.getFirstRow();
|
||||||
|
int rowEnd = region.getLastRow();
|
||||||
|
int column = region.getFirstColumn();
|
||||||
|
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.BORDER_LEFT, border);
|
||||||
|
for (int i = rowStart; i <= rowEnd; i++) {
|
||||||
|
cps.setProperty(CellUtil.getRow(i, sheet), column);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the leftBorderColor attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @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.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setLeftBorderColor(int color, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int rowStart = region.getFirstRow();
|
||||||
|
int rowEnd = region.getLastRow();
|
||||||
|
int column = region.getFirstColumn();
|
||||||
|
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.LEFT_BORDER_COLOR,
|
||||||
|
color);
|
||||||
|
for (int i = rowStart; i <= rowEnd; i++) {
|
||||||
|
cps.setProperty(CellUtil.getRow(i, sheet), column);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the borderRight attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @param border The new border
|
||||||
|
* @param region The region that should have the border
|
||||||
|
* @param workbook The workbook that the region is on.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setBorderRight(int border, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int rowStart = region.getFirstRow();
|
||||||
|
int rowEnd = region.getLastRow();
|
||||||
|
int column = region.getLastColumn();
|
||||||
|
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.BORDER_RIGHT, border);
|
||||||
|
for (int i = rowStart; i <= rowEnd; i++) {
|
||||||
|
cps.setProperty(CellUtil.getRow(i, sheet), column);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the rightBorderColor attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @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.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setRightBorderColor(int color, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int rowStart = region.getFirstRow();
|
||||||
|
int rowEnd = region.getLastRow();
|
||||||
|
int column = region.getLastColumn();
|
||||||
|
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.RIGHT_BORDER_COLOR,
|
||||||
|
color);
|
||||||
|
for (int i = rowStart; i <= rowEnd; i++) {
|
||||||
|
cps.setProperty(CellUtil.getRow(i, sheet), column);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the borderBottom attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @param border The new border
|
||||||
|
* @param region The region that should have the border
|
||||||
|
* @param workbook The workbook that the region is on.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int colStart = region.getFirstColumn();
|
||||||
|
int colEnd = region.getLastColumn();
|
||||||
|
int rowIndex = region.getLastRow();
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.BORDER_BOTTOM, border);
|
||||||
|
Row row = CellUtil.getRow(rowIndex, sheet);
|
||||||
|
for (int i = colStart; i <= colEnd; i++) {
|
||||||
|
cps.setProperty(row, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the bottomBorderColor attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @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.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setBottomBorderColor(int color, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int colStart = region.getFirstColumn();
|
||||||
|
int colEnd = region.getLastColumn();
|
||||||
|
int rowIndex = region.getLastRow();
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.BOTTOM_BORDER_COLOR,
|
||||||
|
color);
|
||||||
|
Row row = CellUtil.getRow(rowIndex, sheet);
|
||||||
|
for (int i = colStart; i <= colEnd; i++) {
|
||||||
|
cps.setProperty(row, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the borderBottom attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @param border The new border
|
||||||
|
* @param region The region that should have the border
|
||||||
|
* @param workbook The workbook that the region is on.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setBorderTop(int border, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int colStart = region.getFirstColumn();
|
||||||
|
int colEnd = region.getLastColumn();
|
||||||
|
int rowIndex = region.getFirstRow();
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.BORDER_TOP, border);
|
||||||
|
Row row = CellUtil.getRow(rowIndex, sheet);
|
||||||
|
for (int i = colStart; i <= colEnd; i++) {
|
||||||
|
cps.setProperty(row, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the topBorderColor attribute of the RegionUtil object
|
||||||
|
*
|
||||||
|
* @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.
|
||||||
|
* @param sheet The sheet that the region is on.
|
||||||
|
*/
|
||||||
|
public static void setTopBorderColor(int color, CellRangeAddress region, Sheet sheet,
|
||||||
|
Workbook workbook) {
|
||||||
|
int colStart = region.getFirstColumn();
|
||||||
|
int colEnd = region.getLastColumn();
|
||||||
|
int rowIndex = region.getFirstRow();
|
||||||
|
CellPropertySetter cps = new CellPropertySetter(workbook, CellUtil.TOP_BORDER_COLOR, color);
|
||||||
|
Row row = CellUtil.getRow(rowIndex, sheet);
|
||||||
|
for (int i = colStart; i <= colEnd; i++) {
|
||||||
|
cps.setProperty(row, i);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user