public class AbstractXlsReportConfiguration extends SimpleReportExportConfiguration implements XlsReportConfiguration
PROPERTY_AUTO_FIT_PAGE_HEIGHT, PROPERTY_CELL_HIDDEN, PROPERTY_CELL_LOCKED, PROPERTY_COLLAPSE_ROW_SPAN, PROPERTY_COLUMN_WIDTH_RATIO, 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_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_USE_TIMEZONE, PROPERTY_WHITE_PAGE_BACKGROUND, PROPERTY_WRAP_TEXTPROPERTY_IGNORE_PAGE_MARGINSPROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS| Constructor and Description |
|---|
AbstractXlsReportConfiguration() |
| Modifier and Type | Method and 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.
|
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.
|
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.
|
Boolean |
isAutoFitPageHeight()
Flag that specifies whether the fit height should be estimated automatically.
|
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 |
setCellHidden(Boolean isCellHidden) |
void |
setCellLocked(Boolean isCellLocked) |
void |
setCollapseRowSpan(Boolean isCollapseRowSpan) |
void |
setColumnWidthRatio(Float columnWidthRatio) |
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 |
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 |
setUseTimeZone(Boolean isUseTimeZone) |
void |
setWhitePageBackground(Boolean isWhitePageBackground) |
void |
setWrapText(Boolean isWrapText) |
getEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndex, setEndPageIndex, setExporterFilter, setHyperlinkProducerFactory, setOffsetX, setOffsetY, setPageIndex, setProgressMonitor, setStartPageIndexisOverrideHints, setOverrideHintsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetEndPageIndex, getExporterFilter, getHyperlinkProducerFactory, getOffsetX, getOffsetY, getPageIndex, getProgressMonitor, getStartPageIndexisOverrideHintspublic Boolean isOnePagePerSheet()
XlsReportConfigurationisOnePagePerSheet in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_ONE_PAGE_PER_SHEETpublic void setOnePagePerSheet(Boolean isOnePagePerSheet)
public Boolean isRemoveEmptySpaceBetweenColumns()
XlsReportConfigurationisRemoveEmptySpaceBetweenColumns in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNSpublic void setRemoveEmptySpaceBetweenColumns(Boolean isRemoveEmptySpaceBetweenColumns)
public Boolean isRemoveEmptySpaceBetweenRows()
XlsReportConfigurationisRemoveEmptySpaceBetweenRows in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWSpublic void setRemoveEmptySpaceBetweenRows(Boolean isRemoveEmptySpaceBetweenRows)
public Boolean isWhitePageBackground()
XlsReportConfigurationisWhitePageBackground in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_WHITE_PAGE_BACKGROUNDpublic void setWhitePageBackground(Boolean isWhitePageBackground)
public Boolean isDetectCellType()
XlsReportConfiguration
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.
isDetectCellType in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_DETECT_CELL_TYPEpublic void setDetectCellType(Boolean isDetectCellType)
public Boolean isFontSizeFixEnabled()
XlsReportConfigurationisFontSizeFixEnabled in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FONT_SIZE_FIX_ENABLEDpublic void setFontSizeFixEnabled(Boolean isFontSizeFixEnabled)
public Boolean isImageBorderFixEnabled()
XlsReportConfigurationisImageBorderFixEnabled in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IMAGE_BORDER_FIX_ENABLEDpublic void setImageBorderFixEnabled(Boolean isImageBorderFixEnabled)
public Boolean isIgnoreGraphics()
XlsReportConfigurationisIgnoreGraphics in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_GRAPHICSpublic void setIgnoreGraphics(Boolean isIgnoreGraphics)
public Boolean isCollapseRowSpan()
XlsReportConfigurationisCollapseRowSpan in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_COLLAPSE_ROW_SPANpublic void setCollapseRowSpan(Boolean isCollapseRowSpan)
public Boolean isIgnoreCellBorder()
XlsReportConfigurationisIgnoreCellBorder in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_CELL_BORDERpublic void setIgnoreCellBorder(Boolean isIgnoreCellBorder)
public Boolean isIgnoreCellBackground()
XlsReportConfigurationisIgnoreCellBackground in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_CELL_BACKGROUNDpublic void setIgnoreCellBackground(Boolean isIgnoreCellBackground)
public Boolean isWrapText()
XlsReportConfigurationisWrapText in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_WRAP_TEXTpublic void setWrapText(Boolean isWrapText)
public Boolean isCellLocked()
XlsReportConfigurationisCellLocked in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_CELL_LOCKEDpublic void setCellLocked(Boolean isCellLocked)
public Boolean isCellHidden()
XlsReportConfigurationisCellHidden in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_CELL_HIDDENpublic void setCellHidden(Boolean isCellHidden)
public Integer getMaxRowsPerSheet()
XlsReportConfigurationgetMaxRowsPerSheet in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_MAXIMUM_ROWS_PER_SHEETpublic void setMaxRowsPerSheet(Integer maxRowsPerSheet)
public Boolean isIgnorePageMargins()
XlsReportConfiguration
If set to true, any page in the document will be exported without taking into account its margins.
isIgnorePageMargins in interface XlsReportConfigurationReportExportConfiguration.PROPERTY_IGNORE_PAGE_MARGINSpublic void setIgnorePageMargins(Boolean isIgnorePageMargins)
public String getSheetHeaderLeft()
XlsReportConfigurationgetSheetHeaderLeft in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_HEADER_LEFTpublic void setSheetHeaderLeft(String sheetHeaderLeft)
public String getSheetHeaderCenter()
XlsReportConfigurationgetSheetHeaderCenter in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_HEADER_CENTERpublic void setSheetHeaderCenter(String sheetHeaderCenter)
public String getSheetHeaderRight()
XlsReportConfigurationgetSheetHeaderRight in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_HEADER_RIGHTpublic void setSheetHeaderRight(String sheetHeaderRight)
public String getSheetFooterLeft()
XlsReportConfigurationgetSheetFooterLeft in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_FOOTER_LEFTpublic void setSheetFooterLeft(String sheetFooterLeft)
public String getSheetFooterCenter()
XlsReportConfigurationgetSheetFooterCenter in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_FOOTER_CENTERpublic void setSheetFooterCenter(String sheetFooterCenter)
public String getSheetFooterRight()
XlsReportConfigurationgetSheetFooterRight in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_FOOTER_RIGHTpublic void setSheetFooterRight(String sheetFooterRight)
public String getPassword()
XlsReportConfigurationgetPassword in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_PASSWORDpublic void setPassword(String password)
public String[] getSheetNames()
XlsReportConfigurationgetSheetNames in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_NAMES_PREFIXpublic void setSheetNames(String[] sheetNames)
public Map<String,String> getFormatPatternsMap()
XlsReportConfigurationgetFormatPatternsMap in interface XlsReportConfigurationHSSFDataFormat,
NumberFormatpublic Boolean isIgnoreHyperlink()
isIgnoreHyperlink in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_HYPERLINKpublic void setIgnoreHyperlink(Boolean isIgnoreHyperlink)
public Boolean isIgnoreAnchors()
XlsReportConfigurationisIgnoreAnchors in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_ANCHORSpublic void setIgnoreAnchors(Boolean isIgnoreAnchors)
public Integer getFitWidth()
XlsReportConfigurationgetFitWidth in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FIT_WIDTHpublic void setFitWidth(Integer fitWidth)
public Integer getFitHeight()
XlsReportConfigurationgetFitHeight in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FIT_WIDTHpublic void setFitHeight(Integer fitHeight)
public Integer getPageScale()
XlsReportConfigurationXlsReportConfiguration.getFitWidth() and XlsReportConfiguration.getFitHeight() settings.getPageScale in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_PAGE_SCALEpublic void setPageScale(Integer pageScale)
public RunDirectionEnum getSheetDirection()
XlsReportConfigurationgetSheetDirection in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_DIRECTIONpublic void setSheetDirection(RunDirectionEnum sheetDirection)
public Float getColumnWidthRatio()
XlsReportConfigurationgetColumnWidthRatio in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_COLUMN_WIDTH_RATIOpublic void setColumnWidthRatio(Float columnWidthRatio)
public Boolean isUseTimeZone()
XlsReportConfiguration
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.
isUseTimeZone in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_USE_TIMEZONEpublic void setUseTimeZone(Boolean isUseTimeZone)
public Integer getFirstPageNumber()
XlsReportConfigurationgetFirstPageNumber in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FIRST_PAGE_NUMBERpublic void setFirstPageNumber(Integer firstPageNumber)
public Boolean isShowGridLines()
XlsReportConfigurationisShowGridLines in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHOW_GRIDLINESpublic void setShowGridLines(Boolean isShowGridLines)
public ImageAnchorTypeEnum getImageAnchorType()
XlsReportConfigurationgetImageAnchorType in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IMAGE_ANCHOR_TYPEpublic void setImageAnchorType(ImageAnchorTypeEnum imageAnchorType)
public Boolean isAutoFitPageHeight()
XlsReportConfigurationisAutoFitPageHeight in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_AUTO_FIT_PAGE_HEIGHTpublic void setAutoFitPageHeight(Boolean isAutoFitPageHeight)
public Boolean isForcePageBreaks()
XlsReportConfigurationisForcePageBreaks in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FORCE_PAGE_BREAKSpublic void setForcePageBreaks(Boolean isForcePageBreaks)
public Boolean isShrinkToFit()
XlsReportConfigurationXlsReportConfiguration.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.isShrinkToFit in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHRINK_TO_FITpublic void setShrinkToFit(Boolean isShrinkToFit)
public Boolean isIgnoreTextFormatting()
XlsReportConfigurationisIgnoreTextFormatting in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_IGNORE_TEXT_FORMATTINGpublic void setIgnoreTextFormatting(Boolean isIgnoreTextFormatting)
public Color getSheetTabColor()
XlsReportConfigurationgetSheetTabColor in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_SHEET_TAB_COLORpublic void setSheetTabColor(Color tabColor)
public Integer getFreezeRow()
XlsReportConfigurationgetFreezeRow in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FREEZE_ROWpublic void setFreezeRow(Integer freezeRow)
public String getFreezeColumn()
XlsReportConfigurationgetFreezeColumn in interface XlsReportConfigurationXlsReportConfiguration.PROPERTY_FREEZE_COLUMNpublic void setFreezeColumn(String freezeColumn)
Copyright © 2017. All rights reserved.