net.sf.jasperreports.engine.export.JRXlsAbstractExporterNature Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see getRowLevelSuffixes(JRPrintElement element)
{
if (element.hasProperties())
{
return JRPropertiesUtil.getProperties(element,ExcelAbstractExporter.PROPERTY_ROW_OUTLINE_LEVEL_PREFIX);
}
return null;
}
public String getSheetName(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(ExcelAbstractExporter.PROPERTY_SHEET_NAME)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, ExcelAbstractExporter.PROPERTY_SHEET_NAME);
}
return null;
}
public EdgeEnum getFreezeRowEdge(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(ExcelAbstractExporter.PROPERTY_FREEZE_ROW_EDGE)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return EdgeEnum.getByName(getPropertiesUtil().getProperty(element, ExcelAbstractExporter.PROPERTY_FREEZE_ROW_EDGE));
}
return null;
}
public EdgeEnum getFreezeColumnEdge(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(ExcelAbstractExporter.PROPERTY_FREEZE_COLUMN_EDGE)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return EdgeEnum.getByName(getPropertiesUtil().getProperty(element, ExcelAbstractExporter.PROPERTY_FREEZE_COLUMN_EDGE));
}
return null;
}
public String getSheetTabColor(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_TAB_COLOR)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_TAB_COLOR);
}
return null;
}
public Integer getPageScale(JRPrintElement element)
{
if (
element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PAGE_SCALE)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PAGE_SCALE, 0);
}
return null;
}
public Integer getFirstPageNumber(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_FIRST_PAGE_NUMBER)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_FIRST_PAGE_NUMBER, 0);
}
return null;
}
public PropertySuffix[] getDefinedNames(JRPrintElement element)
{
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_DEFINED_NAMES_PREFIX)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
List propertySuffixes = propertiesUtil.getProperties(PROPERTY_DEFINED_NAMES_PREFIX);
if (propertySuffixes != null && !propertySuffixes.isEmpty())
{
return propertySuffixes.toArray(new PropertySuffix[propertySuffixes.size()]);
}
}
return null;
}
@Override
public void setXProperties(CutsInfo xCuts, JRPrintElement element, int row1, int col1, int row2, int col2)
{
Map xCutsProperties = xCuts.getPropertiesMap();
setXProperties(xCutsProperties, element);
if (!element.hasProperties())
{
//quick exit for performance
return;
}
Cut cut = xCuts.getCut(col1);
Boolean columnAutoFit = getColumnAutoFit(element);
if (columnAutoFit != null)
{
if(!cut.hasProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_COLUMN))
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_COLUMN, columnAutoFit);
}
else
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_COLUMN, (Boolean)cut.getProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_COLUMN) && columnAutoFit);
}
}
Integer columnCustomWidth = getCustomColumnWidth(element);
Integer cutColumnCustomWidth = (Integer)cut.getProperty(ExcelAbstractExporter.PROPERTY_COLUMN_WIDTH);
if (columnCustomWidth != null && (cutColumnCustomWidth == null || cutColumnCustomWidth < columnCustomWidth))
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_COLUMN_WIDTH, columnCustomWidth);
}
}
@Override
public void setXProperties(Map xCutsProperties, JRPrintElement element)
{
}
private void setMargin(Integer marginValue, Cut cut, String marginName)
{
if(
marginValue != null && (!cut.hasProperty(marginName) || (Integer)cut.getProperty(marginName) < marginValue)
)
{
// a margin value cannot be negative
cut.setProperty(marginName, max(marginValue,0));
}
}
private void setHeaderFooter(String headerFooterValue, Cut cut, String headerFooterName)
{
if(headerFooterValue != null && headerFooterValue.trim().length() > 0)
{
cut.setProperty(headerFooterName, headerFooterValue);
}
}
@Override
public void setYProperties(CutsInfo yCuts, JRPrintElement element, int row1, int col1, int row2, int col2)
{
Map yCutsProperties = yCuts.getPropertiesMap();
setYProperties(yCutsProperties, element);
if (!element.hasProperties())
{
//quick exit for performance
return;
}
Cut cut = yCuts.getCut(row1);
Boolean rowAutoFit = getRowAutoFit(element);
if (rowAutoFit != null)
{
if(!cut.hasProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_ROW))
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_ROW, rowAutoFit);
}
else
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_ROW, (Boolean)cut.getProperty(ExcelAbstractExporter.PROPERTY_AUTO_FIT_ROW) && rowAutoFit);
}
}
List rowLevelSuffixes = getRowLevelSuffixes(element);
if(rowLevelSuffixes != null && !rowLevelSuffixes.isEmpty())
{
SortedMap levelMap = new TreeMap<>();
for(PropertySuffix suffix : rowLevelSuffixes)
{
String level = suffix.getSuffix();
String marker = suffix.getValue();
levelMap.put(level, "end".equalsIgnoreCase(marker));
}
// FIXMEXLS we should preserve existing outline level information in the current y cut
// SortedMap oldLevelMap = (SortedMap)cut.getProperty(ExcelAbstractExporter.PROPERTY_ROW_OUTLINE_LEVEL_PREFIX);
// if (oldLevelMap != null)
// {
// oldLevelMap.putAll(levelMap);
// levelMap = oldLevelMap;
// }
cut.setProperty(ExcelAbstractExporter.PROPERTY_ROW_OUTLINE_LEVEL_PREFIX, levelMap);
}
String sheetName = getSheetName(element);
if(sheetName != null)
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_SHEET_NAME, sheetName);
}
String tabColor = getSheetTabColor(element);
if(tabColor != null)
{
cut.setProperty(PROPERTY_SHEET_TAB_COLOR, tabColor);
}
Integer pageScale = getPageScale(element);
if(pageScale != null && pageScale > 9 && pageScale < 401)
{
cut.setProperty(PROPERTY_PAGE_SCALE, pageScale);
}
Integer firstPageNumber = getFirstPageNumber(element);
if(firstPageNumber != null)
{
cut.setProperty(PROPERTY_FIRST_PAGE_NUMBER, firstPageNumber);
}
Boolean showGridlines = getShowGridlines(element);
if(showGridlines != null)
{
cut.setProperty(PROPERTY_SHOW_GRIDLINES, showGridlines);
}
Boolean ignoreCellBackground = getIgnoreCellBackground(element);
if(ignoreCellBackground != null)
{
cut.setProperty(PROPERTY_IGNORE_CELL_BACKGROUND, ignoreCellBackground);
}
Boolean ignoreCellBorder = getIgnoreCellBorder(element);
if(ignoreCellBorder != null)
{
cut.setProperty(PROPERTY_IGNORE_CELL_BORDER, ignoreCellBorder);
}
Boolean whitePageBackground = getWhitePageBackground(element);
if(whitePageBackground != null)
{
cut.setProperty(PROPERTY_WHITE_PAGE_BACKGROUND, whitePageBackground);
}
EdgeEnum freezeColumnEdge = getFreezeColumnEdge(element);
int columnFreezeIndex = freezeColumnEdge == null
? 0
: (EdgeEnum.RIGHT.equals(freezeColumnEdge)
? col2
: col1
);
if(columnFreezeIndex > 0)
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_FREEZE_COLUMN_EDGE, columnFreezeIndex);
}
EdgeEnum freezeRowEdge = getFreezeRowEdge(element);
int rowFreezeIndex = freezeRowEdge == null
? 0
: (EdgeEnum.BOTTOM.equals(freezeRowEdge)
? row2
: row1
);
if(rowFreezeIndex > 0)
{
cut.setProperty(ExcelAbstractExporter.PROPERTY_FREEZE_ROW_EDGE, rowFreezeIndex);
}
Float columnWidthRatio = getColumnWidthRatio(element);
// only positive values are allowed
if(columnWidthRatio != null && columnWidthRatio > 0f)
{
cut.setProperty(PROPERTY_COLUMN_WIDTH_RATIO, columnWidthRatio);
}
Integer printPageHeight = getPrintPageHeight(element);
// only positive values are allowed
if(printPageHeight != null && printPageHeight > 0
&& (!cut.hasProperty(PROPERTY_PRINT_PAGE_HEIGHT) || (Integer)cut.getProperty(PROPERTY_PRINT_PAGE_HEIGHT) < printPageHeight))
{
cut.setProperty(PROPERTY_PRINT_PAGE_HEIGHT, printPageHeight);
}
Integer printPageWidth = getPrintPageWidth(element);
// only positive values are allowed
if(printPageWidth != null && printPageWidth > 0
&& (!cut.hasProperty(PROPERTY_PRINT_PAGE_WIDTH) || (Integer)cut.getProperty(PROPERTY_PRINT_PAGE_WIDTH) < printPageWidth))
{
cut.setProperty(PROPERTY_PRINT_PAGE_WIDTH, printPageWidth);
}
setMargin(getPrintPageTopMargin(element), cut, PROPERTY_PRINT_PAGE_TOP_MARGIN);
setMargin(getPrintPageLeftMargin(element), cut, PROPERTY_PRINT_PAGE_LEFT_MARGIN);
setMargin(getPrintPageBottomMargin(element), cut, PROPERTY_PRINT_PAGE_BOTTOM_MARGIN);
setMargin(getPrintPageRightMargin(element), cut, PROPERTY_PRINT_PAGE_RIGHT_MARGIN);
setMargin(getPrintHeaderMargin(element), cut, PROPERTY_PRINT_HEADER_MARGIN);
setMargin(getPrintFooterMargin(element), cut, PROPERTY_PRINT_FOOTER_MARGIN);
setHeaderFooter(getSheetHeaderLeft(element), cut, PROPERTY_SHEET_HEADER_LEFT);
setHeaderFooter(getSheetHeaderCenter(element), cut, PROPERTY_SHEET_HEADER_CENTER);
setHeaderFooter(getSheetHeaderRight(element), cut, PROPERTY_SHEET_HEADER_RIGHT);
setHeaderFooter(getSheetFooterLeft(element), cut, PROPERTY_SHEET_FOOTER_LEFT);
setHeaderFooter(getSheetFooterCenter(element), cut, PROPERTY_SHEET_FOOTER_CENTER);
setHeaderFooter(getSheetFooterRight(element), cut, PROPERTY_SHEET_FOOTER_RIGHT);
}
@Override
public void setYProperties(Map yCutsProperties, JRPrintElement element)
{
// nothing to do here
}
public Integer getPrintPageTopMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_TOP_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_TOP_MARGIN, 0);
}
return null;
}
public Integer getPrintPageLeftMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_LEFT_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_LEFT_MARGIN, 0);
}
return null;
}
public Integer getPrintPageBottomMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_BOTTOM_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_BOTTOM_MARGIN, 0);
}
return null;
}
public Integer getPrintPageRightMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_RIGHT_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_RIGHT_MARGIN, 0);
}
return null;
}
public Integer getPrintPageHeight(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_HEIGHT)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_HEIGHT);
}
return null;
}
public Integer getPrintPageWidth(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_PAGE_WIDTH)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_PAGE_WIDTH);
}
return null;
}
public Integer getPrintHeaderMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_HEADER_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_HEADER_MARGIN, 0);
}
return null;
}
public Integer getPrintFooterMargin(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_PRINT_FOOTER_MARGIN)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getIntegerProperty(element, PROPERTY_PRINT_FOOTER_MARGIN, 0);
}
return null;
}
public String getSheetHeaderLeft(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_HEADER_LEFT)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_HEADER_LEFT);
}
return null;
}
public String getSheetHeaderCenter(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_HEADER_CENTER)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_HEADER_CENTER);
}
return null;
}
public String getSheetHeaderRight(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_HEADER_RIGHT)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_HEADER_RIGHT);
}
return null;
}
public String getSheetFooterLeft(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_FOOTER_LEFT)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_FOOTER_LEFT);
}
return null;
}
public String getSheetFooterCenter(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_FOOTER_CENTER)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_FOOTER_CENTER);
}
return null;
}
public String getSheetFooterRight(JRPrintElement element) {
if (element.hasProperties()
&& element.getPropertiesMap().containsProperty(PROPERTY_SHEET_FOOTER_RIGHT)
)
{
// we make this test to avoid reaching the global default value of the property directly
// and thus skipping the report level one, if present
return getPropertiesUtil().getProperty(element, PROPERTY_SHEET_FOOTER_RIGHT);
}
return null;
}
}