Package net.sf.jasperreports.export

Class AbstractXlsReportConfiguration

java.lang.Object

net.sf.jasperreports.export.SimpleCommonExportConfiguration

net.sf.jasperreports.export.SimpleReportExportConfiguration

net.sf.jasperreports.export.AbstractXlsReportConfiguration

All Implemented Interfaces:

CommonExportConfiguration, ReportExportConfiguration, XlsReportConfiguration

Direct Known Subclasses:

SimpleOdsReportConfiguration, SimpleXlsMetadataReportConfiguration, SimpleXlsReportConfiguration, SimpleXlsxMetadataReportConfiguration

public class AbstractXlsReportConfiguration
extends SimpleReportExportConfiguration
implements XlsReportConfiguration

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS

Fields inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

PROPERTY_IGNORE_PAGE_MARGINS

Fields inherited from interface net.sf.jasperreports.export.XlsReportConfiguration

FORMAT_PATTERN_PREFIX, PROPERTY_AUTO_FIT_PAGE_HEIGHT, PROPERTY_CELL_HIDDEN, PROPERTY_CELL_LOCKED, PROPERTY_COLLAPSE_ROW_SPAN, PROPERTY_COLUMN_WIDTH_RATIO, PROPERTY_DEFINED_NAMES_PREFIX, PROPERTY_DETECT_CELL_TYPE, PROPERTY_FIRST_PAGE_NUMBER, PROPERTY_FIT_HEIGHT, PROPERTY_FIT_WIDTH, PROPERTY_FONT_SIZE_FIX_ENABLED, PROPERTY_FORCE_PAGE_BREAKS, PROPERTY_FREEZE_COLUMN, PROPERTY_FREEZE_ROW, PROPERTY_IGNORE_ANCHORS, PROPERTY_IGNORE_CELL_BACKGROUND, PROPERTY_IGNORE_CELL_BORDER, PROPERTY_IGNORE_GRAPHICS, PROPERTY_IGNORE_HYPERLINK, PROPERTY_IGNORE_TEXT_FORMATTING, PROPERTY_IMAGE_ANCHOR_TYPE, PROPERTY_IMAGE_BORDER_FIX_ENABLED, PROPERTY_MAXIMUM_ROWS_PER_SHEET, PROPERTY_ONE_PAGE_PER_SHEET, PROPERTY_PAGE_SCALE, PROPERTY_PASSWORD, PROPERTY_PRINT_FOOTER_MARGIN, PROPERTY_PRINT_HEADER_MARGIN, PROPERTY_PRINT_PAGE_BOTTOM_MARGIN, PROPERTY_PRINT_PAGE_HEIGHT, PROPERTY_PRINT_PAGE_LEFT_MARGIN, PROPERTY_PRINT_PAGE_RIGHT_MARGIN, PROPERTY_PRINT_PAGE_TOP_MARGIN, PROPERTY_PRINT_PAGE_WIDTH, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS, PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS, PROPERTY_SHEET_DIRECTION, PROPERTY_SHEET_FOOTER_CENTER, PROPERTY_SHEET_FOOTER_LEFT, PROPERTY_SHEET_FOOTER_RIGHT, PROPERTY_SHEET_HEADER_CENTER, PROPERTY_SHEET_HEADER_LEFT, PROPERTY_SHEET_HEADER_RIGHT, PROPERTY_SHEET_NAMES_PREFIX, PROPERTY_SHEET_TAB_COLOR, PROPERTY_SHOW_GRIDLINES, PROPERTY_SHRINK_TO_FIT, PROPERTY_SINGLE_SHEET_NAME, PROPERTY_USE_TIMEZONE, PROPERTY_WHITE_PAGE_BACKGROUND, PROPERTY_WRAP_TEXT

Constructor Summary

Constructors

Constructor	Description
AbstractXlsReportConfiguration()

Method Summary

Modifier and Type	Method	Description
Float	getColumnWidthRatio()	Setting used to adjust all column widths in a document or sheet with the same width ratio, in order to get column width values suitable for Excel output.
JRPropertiesUtil.PropertySuffix[]	getDefinedNames()	Returns an array of strings representing defined names in the generated workbook.
Integer	getFirstPageNumber()	Setting that specifies the first page number in the page setup dialog.
Integer	getFitHeight()	This setting indicates the number of pages height to fit the sheet in.
Integer	getFitWidth()	This setting indicates the number of pages wide to fit the sheet in.
Map<String,String>	getFormatPatternsMap()	This export configuration setting should be used when converting java format patterns to equivalent proprietary format patterns.
String	getFreezeColumn()	Indicates the name of the first unlocked column in document's sheets.
Integer	getFreezeRow()	Specifies the index of the first unlocked row in document's sheets.
ImageAnchorTypeEnum	getImageAnchorType()	Specifies the image anchor type.
Integer	getMaxRowsPerSheet()	Returns an integer value specifying the maximum number of rows allowed to be shown in a sheet.
Integer	getPageScale()	This setting is used to adjust the page content to a given percent of the normal size in the print preview pane.
String	getPassword()	Returns a String value representing the password in case of password protected documents.
Integer	getPrintFooterMargin()	Specifies the sheet footer margin in print preview pane, measured in pixels.
Integer	getPrintHeaderMargin()	Specifies the sheet header margin in print preview pane, measured in pixels.
Integer	getPrintPageBottomMargin()	Specifies the page bottom margin in print preview pane, measured in pixels.
Integer	getPrintPageHeight()	Specifies the page height in print preview pane, measured in pixels.
Integer	getPrintPageLeftMargin()	Specifies the page left margin in print preview pane, measured in pixels.
Integer	getPrintPageRightMargin()	Specifies the page right margin in print preview pane, measured in pixels.
Integer	getPrintPageTopMargin()	Specifies the page top margin in print preview pane, measured in pixels.
Integer	getPrintPageWidth()	Specifies the page width in print preview pane, measured in pixels.
RunDirectionEnum	getSheetDirection()	This setting indicates if the sheet is left-to-right or right-to-left oriented.
String	getSheetFooterCenter()	This property stores the text content of the sheet footer's center.
String	getSheetFooterLeft()	This property stores the text content of the sheet footer's left side.
String	getSheetFooterRight()	This property stores the text content of the sheet footer's right side.
String	getSheetHeaderCenter()	This property stores the text content of the sheet header's center.
String	getSheetHeaderLeft()	This property stores the text content of the sheet header's left side.
String	getSheetHeaderRight()	This property stores the text content of the sheet header's right side.
String[]	getSheetNames()	Returns an array of strings representing custom sheet names.
Color	getSheetTabColor()	This setting is used to set the tab color of the sheets.
String	getSingleSheetName()	Returns the value representing the custom sheet name to use instead of the report name, which would be the default, in case the XlsReportConfiguration.isOnePagePerSheet() is set to false.
Boolean	isAutoFitPageHeight()	Flag that specifies whether the fit height should be estimated automatically.
Boolean	isAutoFitRow()
Boolean	isCellHidden()	This flag indicates whether the cell content is hidden.
Boolean	isCellLocked()	This flag indicates whether the cell is locked.
Boolean	isCollapseRowSpan()	Flag for collapsing row span and avoid merging cells across rows.
Boolean	isDetectCellType()	Flag used to indicate whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.
Boolean	isFontSizeFixEnabled()	Flag for decreasing font size so that texts fit into the specified cell height.
Boolean	isForcePageBreaks()	Flag that specifies whether the page breaks to be marked automatically on each sheet.
Boolean	isIgnoreAnchors()	Flag that indicates whether local anchors should be ignored when elements are exported to Excel.
Boolean	isIgnoreCellBackground()	Flag for ignoring the cell background color.
Boolean	isIgnoreCellBorder()	Flag for ignoring the cell border.
Boolean	isIgnoreGraphics()	Flag for ignoring graphic elements and exporting text elements only.
Boolean	isIgnoreHyperlink()
Boolean	isIgnorePageMargins()	Indicates whether page margins should be ignored when the report is exported using a grid-based exporter
Boolean	isIgnoreTextFormatting()	Flag that indicates whether the text elements should be exported without text formatting features, such as bold, italic, underline, text color, backcolor, etc.
Boolean	isImageBorderFixEnabled()	Flag for forcing the minimum image padding to 1 pixel, to avoid situations where the image hides the cell border.
Boolean	isOnePagePerSheet()	Returns a boolean value specifying whether each report page should be written in a different XLS sheet.
Boolean	isRemoveEmptySpaceBetweenColumns()	Returns a boolean value specifying whether the empty spaces that could appear between columns should be removed or not.
Boolean	isRemoveEmptySpaceBetweenRows()	Returns a boolean value specifying whether the empty spaces that could appear between rows should be removed or not.
Boolean	isShowGridLines()	Flag that specifies if the gridlines in a given sheet are shown.
Boolean	isShrinkToFit()	Flag that indicates whether the text font size should be decreased in order to keep the entire text visible in the cell.
Boolean	isUseTimeZone()	Flag that determines whether date values are to be translated to the timezone that was used to fill the report.
Boolean	isWhitePageBackground()	Returns a boolean value specifying whether the page background should be white or the default XLS background color.
Boolean	isWrapText()	This flag indicates whether text wrapping is allowed in a given cell.
void	setAutoFitPageHeight(Boolean isAutoFitPageHeight)
void	setAutoFitRow(Boolean isAutoFitRow)
void	setCellHidden(Boolean isCellHidden)
void	setCellLocked(Boolean isCellLocked)
void	setCollapseRowSpan(Boolean isCollapseRowSpan)
void	setColumnWidthRatio(Float columnWidthRatio)
void	setDefinedNames(JRPropertiesUtil.PropertySuffix[] definedNames)
void	setDetectCellType(Boolean isDetectCellType)
void	setFirstPageNumber(Integer firstPageNumber)
void	setFitHeight(Integer fitHeight)
void	setFitWidth(Integer fitWidth)
void	setFontSizeFixEnabled(Boolean isFontSizeFixEnabled)
void	setForcePageBreaks(Boolean isForcePageBreaks)
void	setFormatPatternsMap(Map<String,String> formatPatternsMap)
void	setFreezeColumn(String freezeColumn)
void	setFreezeRow(Integer freezeRow)
void	setIgnoreAnchors(Boolean isIgnoreAnchors)
void	setIgnoreCellBackground(Boolean isIgnoreCellBackground)
void	setIgnoreCellBorder(Boolean isIgnoreCellBorder)
void	setIgnoreGraphics(Boolean isIgnoreGraphics)
void	setIgnoreHyperlink(Boolean isIgnoreHyperlink)
void	setIgnorePageMargins(Boolean isIgnorePageMargins)
void	setIgnoreTextFormatting(Boolean isIgnoreTextFormatting)
void	setImageAnchorType(ImageAnchorTypeEnum imageAnchorType)
void	setImageBorderFixEnabled(Boolean isImageBorderFixEnabled)
void	setMaxRowsPerSheet(Integer maxRowsPerSheet)
void	setOnePagePerSheet(Boolean isOnePagePerSheet)
void	setPageScale(Integer pageScale)
void	setPassword(String password)
void	setPrintFooterMargin(Integer printFooterMargin)
void	setPrintHeaderMargin(Integer printHeaderMargin)
void	setPrintPageBottomMargin(Integer printPageBottomMargin)
void	setPrintPageHeight(Integer printPageHeight)
void	setPrintPageLeftMargin(Integer printPageLeftMargin)
void	setPrintPageRightMargin(Integer printPageRightMargin)
void	setPrintPageTopMargin(Integer printPageTopMargin)
void	setPrintPageWidth(Integer printPageWidth)
void	setRemoveEmptySpaceBetweenColumns(Boolean isRemoveEmptySpaceBetweenColumns)
void	setRemoveEmptySpaceBetweenRows(Boolean isRemoveEmptySpaceBetweenRows)
void	setSheetDirection(RunDirectionEnum sheetDirection)
void	setSheetFooterCenter(String sheetFooterCenter)
void	setSheetFooterLeft(String sheetFooterLeft)
void	setSheetFooterRight(String sheetFooterRight)
void	setSheetHeaderCenter(String sheetHeaderCenter)
void	setSheetHeaderLeft(String sheetHeaderLeft)
void	setSheetHeaderRight(String sheetHeaderRight)
void	setSheetNames(String[] sheetNames)
void	setSheetTabColor(Color tabColor)
void	setShowGridLines(Boolean isShowGridLines)
void	setShrinkToFit(Boolean isShrinkToFit)
void	setSingleSheetName(String singleSheetName)
void	setUseTimeZone(Boolean isUseTimeZone)
void	setWhitePageBackground(Boolean isWhitePageBackground)
void	setWrapText(Boolean isWrapText)

Methods inherited from class net.sf.jasperreports.export.SimpleReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex, setEndPageIndex, setExporterFilter, setHyperlinkProducerFactory, setOffsetX, setOffsetY, setPageIndex, setProgressMonitor, setStartPageIndex

Methods inherited from class net.sf.jasperreports.export.SimpleCommonExportConfiguration

isOverrideHints, setOverrideHints

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jasperreports.export.CommonExportConfiguration

isOverrideHints

Methods inherited from interface net.sf.jasperreports.export.ReportExportConfiguration

getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex

Constructor Details

AbstractXlsReportConfiguration

public AbstractXlsReportConfiguration()

Method Details

isOnePagePerSheet

public Boolean isOnePagePerSheet()

Description copied from interface: XlsReportConfiguration

Returns a boolean value specifying whether each report page should be written in a different XLS sheet.

Specified by:

isOnePagePerSheet in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_ONE_PAGE_PER_SHEET

setOnePagePerSheet

public void setOnePagePerSheet(Boolean isOnePagePerSheet)

isRemoveEmptySpaceBetweenColumns

public Boolean isRemoveEmptySpaceBetweenColumns()

Description copied from interface: XlsReportConfiguration

Returns a boolean value specifying whether the empty spaces that could appear between columns should be removed or not.

Specified by:

isRemoveEmptySpaceBetweenColumns in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS

setRemoveEmptySpaceBetweenColumns

public void setRemoveEmptySpaceBetweenColumns(Boolean isRemoveEmptySpaceBetweenColumns)

isRemoveEmptySpaceBetweenRows

public Boolean isRemoveEmptySpaceBetweenRows()

Description copied from interface: XlsReportConfiguration

Returns a boolean value specifying whether the empty spaces that could appear between rows should be removed or not.

Specified by:

isRemoveEmptySpaceBetweenRows in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS

setRemoveEmptySpaceBetweenRows

public void setRemoveEmptySpaceBetweenRows(Boolean isRemoveEmptySpaceBetweenRows)

isWhitePageBackground

public Boolean isWhitePageBackground()

Description copied from interface: XlsReportConfiguration

Returns a boolean value specifying whether the page background should be white or the default XLS background color. This background may vary depending on the XLS viewer properties or the operating system color scheme.

Specified by:

isWhitePageBackground in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_WHITE_PAGE_BACKGROUND

setWhitePageBackground

public void setWhitePageBackground(Boolean isWhitePageBackground)

isDetectCellType

public Boolean isDetectCellType()

Description copied from interface: XlsReportConfiguration

Flag used to indicate whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.

Text fields having numerical or date expressions save type and formatting (format pattern, locale and time zone) information in the JasperPrint/JRPrintText object created by the report fill process.

When this flag is set, the exporter will parse back the String value of numerical/date texts. Numerical/date cells will be created and the original pattern of the text will be included as part of the cell style.

Note that this mechanism would not work when the text field overflows and splits on two pages/columns. Also, it is required that the text field expression has a numerical or date type set.

This flag is off by default to ensure backwards compatibility.

Specified by:

isDetectCellType in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_DETECT_CELL_TYPE

setDetectCellType

public void setDetectCellType(Boolean isDetectCellType)

isFontSizeFixEnabled

public Boolean isFontSizeFixEnabled()

Description copied from interface: XlsReportConfiguration

Flag for decreasing font size so that texts fit into the specified cell height.

Specified by:

isFontSizeFixEnabled in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FONT_SIZE_FIX_ENABLED

setFontSizeFixEnabled

public void setFontSizeFixEnabled(Boolean isFontSizeFixEnabled)

isImageBorderFixEnabled

public Boolean isImageBorderFixEnabled()

Description copied from interface: XlsReportConfiguration

Flag for forcing the minimum image padding to 1 pixel, to avoid situations where the image hides the cell border.

Specified by:

isImageBorderFixEnabled in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IMAGE_BORDER_FIX_ENABLED

setImageBorderFixEnabled

public void setImageBorderFixEnabled(Boolean isImageBorderFixEnabled)

isIgnoreGraphics

public Boolean isIgnoreGraphics()

Description copied from interface: XlsReportConfiguration

Flag for ignoring graphic elements and exporting text elements only.

Specified by:

isIgnoreGraphics in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_GRAPHICS

setIgnoreGraphics

public void setIgnoreGraphics(Boolean isIgnoreGraphics)

isCollapseRowSpan

public Boolean isCollapseRowSpan()

Description copied from interface: XlsReportConfiguration

Flag for collapsing row span and avoid merging cells across rows.

Specified by:

isCollapseRowSpan in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_COLLAPSE_ROW_SPAN

setCollapseRowSpan

public void setCollapseRowSpan(Boolean isCollapseRowSpan)

isIgnoreCellBorder

public Boolean isIgnoreCellBorder()

Description copied from interface: XlsReportConfiguration

Flag for ignoring the cell border.

Specified by:

isIgnoreCellBorder in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_CELL_BORDER

setIgnoreCellBorder

public void setIgnoreCellBorder(Boolean isIgnoreCellBorder)

isIgnoreCellBackground

public Boolean isIgnoreCellBackground()

Description copied from interface: XlsReportConfiguration

Flag for ignoring the cell background color.

Specified by:

isIgnoreCellBackground in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_CELL_BACKGROUND

setIgnoreCellBackground

public void setIgnoreCellBackground(Boolean isIgnoreCellBackground)

isWrapText

public Boolean isWrapText()

Description copied from interface: XlsReportConfiguration

This flag indicates whether text wrapping is allowed in a given cell.

Specified by:

isWrapText in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_WRAP_TEXT

setWrapText

public void setWrapText(Boolean isWrapText)

isCellLocked

public Boolean isCellLocked()

Description copied from interface: XlsReportConfiguration

This flag indicates whether the cell is locked.

Specified by:

isCellLocked in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_CELL_LOCKED

setCellLocked

public void setCellLocked(Boolean isCellLocked)

isCellHidden

public Boolean isCellHidden()

Description copied from interface: XlsReportConfiguration

This flag indicates whether the cell content is hidden.

Specified by:

isCellHidden in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_CELL_HIDDEN

setCellHidden

public void setCellHidden(Boolean isCellHidden)

getMaxRowsPerSheet

public Integer getMaxRowsPerSheet()

Description copied from interface: XlsReportConfiguration

Returns an integer value specifying the maximum number of rows allowed to be shown in a sheet. When set, a new sheet is created for the remaining rows to be displayed. Negative values or zero means that no limit has been set.

Specified by:

getMaxRowsPerSheet in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_MAXIMUM_ROWS_PER_SHEET

setMaxRowsPerSheet

public void setMaxRowsPerSheet(Integer maxRowsPerSheet)

isIgnorePageMargins

public Boolean isIgnorePageMargins()

Description copied from interface: XlsReportConfiguration

Indicates whether page margins should be ignored when the report is exported using a grid-based exporter

If set to true, any page in the document will be exported without taking into account its margins.

Specified by:

isIgnorePageMargins in interface XlsReportConfiguration

See Also:

• ReportExportConfiguration.PROPERTY_IGNORE_PAGE_MARGINS

setIgnorePageMargins

public void setIgnorePageMargins(Boolean isIgnorePageMargins)

getSheetHeaderLeft

public String getSheetHeaderLeft()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet header's left side.

Specified by:

getSheetHeaderLeft in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_HEADER_LEFT

setSheetHeaderLeft

public void setSheetHeaderLeft(String sheetHeaderLeft)

getSheetHeaderCenter

public String getSheetHeaderCenter()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet header's center.

Specified by:

getSheetHeaderCenter in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_HEADER_CENTER

setSheetHeaderCenter

public void setSheetHeaderCenter(String sheetHeaderCenter)

getSheetHeaderRight

public String getSheetHeaderRight()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet header's right side.

Specified by:

getSheetHeaderRight in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_HEADER_RIGHT

setSheetHeaderRight

public void setSheetHeaderRight(String sheetHeaderRight)

getSheetFooterLeft

public String getSheetFooterLeft()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet footer's left side.

Specified by:

getSheetFooterLeft in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_FOOTER_LEFT

setSheetFooterLeft

public void setSheetFooterLeft(String sheetFooterLeft)

getSheetFooterCenter

public String getSheetFooterCenter()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet footer's center.

Specified by:

getSheetFooterCenter in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_FOOTER_CENTER

setSheetFooterCenter

public void setSheetFooterCenter(String sheetFooterCenter)

getSheetFooterRight

public String getSheetFooterRight()

Description copied from interface: XlsReportConfiguration

This property stores the text content of the sheet footer's right side.

Specified by:

getSheetFooterRight in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_FOOTER_RIGHT

setSheetFooterRight

public void setSheetFooterRight(String sheetFooterRight)

getPassword

public String getPassword()

Description copied from interface: XlsReportConfiguration

Returns a String value representing the password in case of password protected documents.

Specified by:

getPassword in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_PASSWORD

setPassword

public void setPassword(String password)

getSingleSheetName

public String getSingleSheetName()

Description copied from interface: XlsReportConfiguration

Returns the value representing the custom sheet name to use instead of the report name, which would be the default, in case the XlsReportConfiguration.isOnePagePerSheet() is set to false.

Specified by:

getSingleSheetName in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SINGLE_SHEET_NAME

setSingleSheetName

public void setSingleSheetName(String singleSheetName)

getSheetNames

public String[] getSheetNames()

Description copied from interface: XlsReportConfiguration

Returns an array of strings representing custom sheet names. This is useful when used with the isOnePagePerSheet() setting.

Specified by:

getSheetNames in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_NAMES_PREFIX

setSheetNames

public void setSheetNames(String[] sheetNames)

getFormatPatternsMap

public Map<String,String> getFormatPatternsMap()

Description copied from interface: XlsReportConfiguration

This export configuration setting should be used when converting java format patterns to equivalent proprietary format patterns. It should be constructed as a Map containing java format patterns as keys and the correspondent proprietary format pattern as correspondent value

Specified by:

getFormatPatternsMap in interface XlsReportConfiguration

See Also:

• HSSFDataFormat

setFormatPatternsMap

public void setFormatPatternsMap(Map<String,String> formatPatternsMap)

isIgnoreHyperlink

public Boolean isIgnoreHyperlink()

Specified by:

isIgnoreHyperlink in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_HYPERLINK

setIgnoreHyperlink

public void setIgnoreHyperlink(Boolean isIgnoreHyperlink)

isIgnoreAnchors

public Boolean isIgnoreAnchors()

Description copied from interface: XlsReportConfiguration

Flag that indicates whether local anchors should be ignored when elements are exported to Excel.

Specified by:

isIgnoreAnchors in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_ANCHORS

setIgnoreAnchors

public void setIgnoreAnchors(Boolean isIgnoreAnchors)

getFitWidth

public Integer getFitWidth()

Description copied from interface: XlsReportConfiguration

This setting indicates the number of pages wide to fit the sheet in.

Specified by:

getFitWidth in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FIT_WIDTH

setFitWidth

public void setFitWidth(Integer fitWidth)

getFitHeight

public Integer getFitHeight()

Description copied from interface: XlsReportConfiguration

This setting indicates the number of pages height to fit the sheet in.

Specified by:

getFitHeight in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FIT_WIDTH

setFitHeight

public void setFitHeight(Integer fitHeight)

getPageScale

public Integer getPageScale()

Description copied from interface: XlsReportConfiguration

This setting is used to adjust the page content to a given percent of the normal size in the print preview pane. Allowed values are positive integers from 10 to 400, representing percents of the normal size. This setting overrides the XlsReportConfiguration.getFitWidth() and XlsReportConfiguration.getFitHeight() settings.

Specified by:

getPageScale in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_PAGE_SCALE

setPageScale

public void setPageScale(Integer pageScale)

getSheetDirection

public RunDirectionEnum getSheetDirection()

Description copied from interface: XlsReportConfiguration

This setting indicates if the sheet is left-to-right or right-to-left oriented. Possible values are:

• LTR - meaning left-to-right
• RTL - meaning right-to-left

The default value is LTR.

Specified by:

getSheetDirection in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_DIRECTION

setSheetDirection

public void setSheetDirection(RunDirectionEnum sheetDirection)

getColumnWidthRatio

public Float getColumnWidthRatio()

Description copied from interface: XlsReportConfiguration

Setting used to adjust all column widths in a document or sheet with the same width ratio, in order to get column width values suitable for Excel output. Usually column widths are measured by Excel in Normal style default character width units, while the JR engine uses pixels as default size units. When exporting the report to the Excel output format, the pixel-to-character width translation depends on the normal style default character width provided by the Excel instance, so it cannot be always accurately fitted. In this case, one can alter the generated column widths by setting this property with a float value representing the adjustment ratio.

Specified by:

getColumnWidthRatio in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_COLUMN_WIDTH_RATIO

setColumnWidthRatio

public void setColumnWidthRatio(Float columnWidthRatio)

isUseTimeZone

public Boolean isUseTimeZone()

Description copied from interface: XlsReportConfiguration

Flag that determines whether date values are to be translated to the timezone that was used to fill the report.

By default, date values are exported to Excel using the default timezone of the system. Setting this to true instructs the exporter to use he report fill timezone to export date values.

This only has effect when XlsReportConfiguration.isDetectCellType() is set.

Specified by:

isUseTimeZone in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_USE_TIMEZONE

setUseTimeZone

public void setUseTimeZone(Boolean isUseTimeZone)

getFirstPageNumber

public Integer getFirstPageNumber()

Description copied from interface: XlsReportConfiguration

Setting that specifies the first page number in the page setup dialog.

Specified by:

getFirstPageNumber in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FIRST_PAGE_NUMBER

setFirstPageNumber

public void setFirstPageNumber(Integer firstPageNumber)

isShowGridLines

public Boolean isShowGridLines()

Description copied from interface: XlsReportConfiguration

Flag that specifies if the gridlines in a given sheet are shown.

Specified by:

isShowGridLines in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHOW_GRIDLINES

setShowGridLines

public void setShowGridLines(Boolean isShowGridLines)

getImageAnchorType

public ImageAnchorTypeEnum getImageAnchorType()

Description copied from interface: XlsReportConfiguration

Specifies the image anchor type.

Specified by:

getImageAnchorType in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IMAGE_ANCHOR_TYPE

setImageAnchorType

public void setImageAnchorType(ImageAnchorTypeEnum imageAnchorType)

isAutoFitPageHeight

public Boolean isAutoFitPageHeight()

Description copied from interface: XlsReportConfiguration

Flag that specifies whether the fit height should be estimated automatically.

Specified by:

isAutoFitPageHeight in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_AUTO_FIT_PAGE_HEIGHT

setAutoFitPageHeight

public void setAutoFitPageHeight(Boolean isAutoFitPageHeight)

isForcePageBreaks

public Boolean isForcePageBreaks()

Description copied from interface: XlsReportConfiguration

Flag that specifies whether the page breaks to be marked automatically on each sheet.

Specified by:

isForcePageBreaks in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FORCE_PAGE_BREAKS

setForcePageBreaks

public void setForcePageBreaks(Boolean isForcePageBreaks)

isShrinkToFit

public Boolean isShrinkToFit()

Description copied from interface: XlsReportConfiguration

Flag that indicates whether the text font size should be decreased in order to keep the entire text visible in the cell. If set to true, this will automatically disable the wrap text property (see XlsReportConfiguration.isWrapText()).

Usually this setting works in conjunction with net.sf.jasperreports.print.keep.full.text, in order to preserve the entire text content at export time.

Specified by:

isShrinkToFit in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHRINK_TO_FIT

setShrinkToFit

public void setShrinkToFit(Boolean isShrinkToFit)

isIgnoreTextFormatting

public Boolean isIgnoreTextFormatting()

Description copied from interface: XlsReportConfiguration

Flag that indicates whether the text elements should be exported without text formatting features, such as bold, italic, underline, text color, backcolor, etc.

Specified by:

isIgnoreTextFormatting in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_IGNORE_TEXT_FORMATTING

setIgnoreTextFormatting

public void setIgnoreTextFormatting(Boolean isIgnoreTextFormatting)

getSheetTabColor

public Color getSheetTabColor()

Description copied from interface: XlsReportConfiguration

This setting is used to set the tab color of the sheets. Global and report-level settings are overridden by element-level settings for this property. If several elements in a sheet contain this property, the engine will consider the value of the last exported element's property.

The setting is neglected in XLS export channel (works with XLSX and ODS only)

Specified by:

getSheetTabColor in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_SHEET_TAB_COLOR

setSheetTabColor

public void setSheetTabColor(Color tabColor)

getFreezeRow

public Integer getFreezeRow()

Description copied from interface: XlsReportConfiguration

Specifies the index of the first unlocked row in document's sheets. All rows above this will be 'frozen'. Allowed values are represented by positive integers in the 1..65536 range. Negative values are not considered.

Specified by:

getFreezeRow in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FREEZE_ROW

setFreezeRow

public void setFreezeRow(Integer freezeRow)

getFreezeColumn

public String getFreezeColumn()

Description copied from interface: XlsReportConfiguration

Indicates the name of the first unlocked column in document's sheets. All columns to the left of this one will be 'frozen'. Allowed values are letters or letter combinations representing valid column names in Excel, such as A, B, AB, AC, etc.

Specified by:

getFreezeColumn in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_FREEZE_COLUMN

setFreezeColumn

public void setFreezeColumn(String freezeColumn)

getPrintPageTopMargin

public Integer getPrintPageTopMargin()

Description copied from interface: XlsReportConfiguration

Specifies the page top margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintPageTopMargin in interface XlsReportConfiguration

setPrintPageTopMargin

public void setPrintPageTopMargin(Integer printPageTopMargin)

getPrintPageLeftMargin

public Integer getPrintPageLeftMargin()

Description copied from interface: XlsReportConfiguration

Specifies the page left margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintPageLeftMargin in interface XlsReportConfiguration

setPrintPageLeftMargin

public void setPrintPageLeftMargin(Integer printPageLeftMargin)

getPrintPageBottomMargin

public Integer getPrintPageBottomMargin()

Description copied from interface: XlsReportConfiguration

Specifies the page bottom margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintPageBottomMargin in interface XlsReportConfiguration

setPrintPageBottomMargin

public void setPrintPageBottomMargin(Integer printPageBottomMargin)

getPrintPageRightMargin

public Integer getPrintPageRightMargin()

Description copied from interface: XlsReportConfiguration

Specifies the page right margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintPageRightMargin in interface XlsReportConfiguration

setPrintPageRightMargin

public void setPrintPageRightMargin(Integer printPageRightMargin)

getPrintPageHeight

public Integer getPrintPageHeight()

Description copied from interface: XlsReportConfiguration

Specifies the page height in print preview pane, measured in pixels.

Specified by:

getPrintPageHeight in interface XlsReportConfiguration

setPrintPageHeight

public void setPrintPageHeight(Integer printPageHeight)

getPrintPageWidth

public Integer getPrintPageWidth()

Description copied from interface: XlsReportConfiguration

Specifies the page width in print preview pane, measured in pixels.

Specified by:

getPrintPageWidth in interface XlsReportConfiguration

setPrintPageWidth

public void setPrintPageWidth(Integer printPageWidth)

getPrintHeaderMargin

public Integer getPrintHeaderMargin()

Description copied from interface: XlsReportConfiguration

Specifies the sheet header margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintHeaderMargin in interface XlsReportConfiguration

setPrintHeaderMargin

public void setPrintHeaderMargin(Integer printHeaderMargin)

getPrintFooterMargin

public Integer getPrintFooterMargin()

Description copied from interface: XlsReportConfiguration

Specifies the sheet footer margin in print preview pane, measured in pixels. Default value is 0.

Specified by:

getPrintFooterMargin in interface XlsReportConfiguration

setPrintFooterMargin

public void setPrintFooterMargin(Integer printFooterMargin)

getDefinedNames

public JRPropertiesUtil.PropertySuffix[] getDefinedNames()

Description copied from interface: XlsReportConfiguration

Returns an array of strings representing defined names in the generated workbook.

Specified by:

getDefinedNames in interface XlsReportConfiguration

See Also:

• XlsReportConfiguration.PROPERTY_DEFINED_NAMES_PREFIX

setDefinedNames

public void setDefinedNames(JRPropertiesUtil.PropertySuffix[] definedNames)

isAutoFitRow

public Boolean isAutoFitRow()

Specified by:

isAutoFitRow in interface XlsReportConfiguration

See Also:

• ExcelAbstractExporter.PROPERTY_AUTO_FIT_ROW

setAutoFitRow

public void setAutoFitRow(Boolean isAutoFitRow)