Package net.sf.jasperreports.export

Interface XlsMetadataReportConfiguration

All Superinterfaces:

CommonExportConfiguration, ReportExportConfiguration, XlsReportConfiguration

All Known Subinterfaces:

XlsxMetadataReportConfiguration

All Known Implementing Classes:

SimpleXlsMetadataReportConfiguration, SimpleXlsxMetadataReportConfiguration

public interface XlsMetadataReportConfiguration
extends XlsReportConfiguration

Interface containing settings used by the Excel metadata exporters.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• JRXlsAbstractMetadataExporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_COLUMN_NAMES_PREFIX	Properties having this prefix contain comma-separated column names.
static final String	PROPERTY_WRITE_HEADER	Property whose value is used as default for the isWriteHeader() export configuration flag.

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

Method Summary

Modifier and Type	Method	Description
String[]	getColumnNames()	Returns an array of strings representing the comma-separated names of the columns that should be exported.
Boolean	isWriteHeader()	Returns a boolean that specifies whether the export header (the column names) should be written or not.

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

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

getColumnWidthRatio, getDefinedNames, getFirstPageNumber, getFitHeight, getFitWidth, getFormatPatternsMap, getFreezeColumn, getFreezeRow, getImageAnchorType, getMaxRowsPerSheet, getPageScale, getPassword, getPrintFooterMargin, getPrintHeaderMargin, getPrintPageBottomMargin, getPrintPageHeight, getPrintPageLeftMargin, getPrintPageRightMargin, getPrintPageTopMargin, getPrintPageWidth, getSheetDirection, getSheetFooterCenter, getSheetFooterLeft, getSheetFooterRight, getSheetHeaderCenter, getSheetHeaderLeft, getSheetHeaderRight, getSheetNames, getSheetTabColor, getSingleSheetName, isAutoFitPageHeight, isAutoFitRow, isCellHidden, isCellLocked, isCollapseRowSpan, isDetectCellType, isFontSizeFixEnabled, isForcePageBreaks, isIgnoreAnchors, isIgnoreCellBackground, isIgnoreCellBorder, isIgnoreGraphics, isIgnoreHyperlink, isIgnorePageMargins, isIgnoreTextFormatting, isImageBorderFixEnabled, isOnePagePerSheet, isRemoveEmptySpaceBetweenColumns, isRemoveEmptySpaceBetweenRows, isShowGridLines, isShrinkToFit, isUseTimeZone, isWhitePageBackground, isWrapText

Field Details

PROPERTY_WRITE_HEADER

static final String PROPERTY_WRITE_HEADER

Property whose value is used as default for the isWriteHeader() export configuration flag.

The property itself defaults to false.

See Also:

• JRPropertiesUtil
• Constant Field Values

PROPERTY_COLUMN_NAMES_PREFIX

static final String PROPERTY_COLUMN_NAMES_PREFIX

Properties having this prefix contain comma-separated column names. If set, these values are considered as defaults for the getColumnNames() export configuration setting.

See Also:

• JRPropertiesUtil
• Constant Field Values

Method Details

isWriteHeader

Boolean isWriteHeader()

Returns a boolean that specifies whether the export header (the column names) should be written or not.

See Also:

• PROPERTY_WRITE_HEADER

getColumnNames

String[] getColumnNames()

Returns an array of strings representing the comma-separated names of the columns that should be exported. NOTE: The order of the columns is important and for accurate results they should be in the same order as the original columns.

See Also:

• PROPERTY_COLUMN_NAMES_PREFIX