Package net.sf.jasperreports.engine.export

Class JRXlsAbstractExporterNature

java.lang.Object

net.sf.jasperreports.engine.export.AbstractExporterNature

net.sf.jasperreports.engine.export.JRXlsAbstractExporterNature

All Implemented Interfaces:

ExporterFilter, ExporterNature

Direct Known Subclasses:

JROdsExporterNature, JRXlsExporterNature, JRXlsxExporterNature

public abstract class JRXlsAbstractExporterNature
extends AbstractExporterNature

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isIgnoreGraphics
protected boolean	isIgnorePageMargins

Fields inherited from class net.sf.jasperreports.engine.export.AbstractExporterNature

filter, handlerEnvironment, jasperReportsContext, propertiesUtil

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRXlsAbstractExporterNature(JasperReportsContext jasperReportsContext, ExporterFilter filter, boolean isIgnoreGraphics, boolean isIgnorePageMargins)

Method Summary

Modifier and Type	Method	Description
Boolean	getColumnAutoFit(JRPrintElement element)
Integer	getColumnWidth(JRPrintElement element, boolean columnAutoFit)
Float	getColumnWidthRatio(JRPrintElement element)
JRPropertiesUtil.PropertySuffix[]	getDefinedNames(JRPrintElement element)
Integer	getFirstPageNumber(JRPrintElement element)
CellEdgeEnum	getFreezeColumnEdge(JRPrintElement element)
CellEdgeEnum	getFreezeRowEdge(JRPrintElement element)
Boolean	getIgnoreCellBackground(JRPrintElement element)
Boolean	getIgnoreCellBorder(JRPrintElement element)
Boolean	getIgnoreRowHeight(JRPrintElement element)
Integer	getPageScale(JRPrintElement element)
Integer	getPrintFooterMargin(JRPrintElement element)
Integer	getPrintHeaderMargin(JRPrintElement element)
Integer	getPrintPageBottomMargin(JRPrintElement element)
Integer	getPrintPageHeight(JRPrintElement element)
Integer	getPrintPageLeftMargin(JRPrintElement element)
Integer	getPrintPageRightMargin(JRPrintElement element)
Integer	getPrintPageTopMargin(JRPrintElement element)
Integer	getPrintPageWidth(JRPrintElement element)
Boolean	getRowAutoFit(JRPrintElement element)
List<JRPropertiesUtil.PropertySuffix>	getRowLevelSuffixes(JRPrintElement element)
String	getSheetFooterCenter(JRPrintElement element)
String	getSheetFooterLeft(JRPrintElement element)
String	getSheetFooterRight(JRPrintElement element)
String	getSheetHeaderCenter(JRPrintElement element)
String	getSheetHeaderLeft(JRPrintElement element)
String	getSheetHeaderRight(JRPrintElement element)
String	getSheetName(JRPrintElement element)
String	getSheetTabColor(JRPrintElement element)
Boolean	getShowGridlines(JRPrintElement element)
Boolean	getWhitePageBackground(JRPrintElement element)
boolean	isBreakAfterRow(JRPrintElement element)
boolean	isBreakBeforeRow(JRPrintElement element)
boolean	isDeep(JRPrintFrame frame)	Specified whether to include in the grid sub elements of a given frame element.
boolean	isHorizontallyMergeEmptyCells()	Flag that specifies that empty cells are to be horizontally merged.
boolean	isIgnoreLastRow()
boolean	isIgnorePageMargins()	Specifies whether empty page margins should be ignored
boolean	isSpanCells()	Specifies whether the exporter handles cells span
boolean	isToExport(JRPrintElement element)
void	setXProperties(Map<String,Object> xCutsProperties, JRPrintElement element)
void	setXProperties(CutsInfo xCuts, JRPrintElement element, int row1, int col1, int row2, int col2)
void	setYProperties(Map<String,Object> yCutsProperties, JRPrintElement element)
void	setYProperties(CutsInfo yCuts, JRPrintElement element, int row1, int col1, int row2, int col2)

Methods inherited from class net.sf.jasperreports.engine.export.AbstractExporterNature

getPropertiesUtil

Methods inherited from class java.lang.Object

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

Field Detail

isIgnoreGraphics

protected boolean isIgnoreGraphics

isIgnorePageMargins

protected boolean isIgnorePageMargins

Constructor Detail

JRXlsAbstractExporterNature

protected JRXlsAbstractExporterNature(JasperReportsContext jasperReportsContext,
                                      ExporterFilter filter,
                                      boolean isIgnoreGraphics,
                                      boolean isIgnorePageMargins)

Method Detail

isToExport

public boolean isToExport(JRPrintElement element)

isDeep

public boolean isDeep(JRPrintFrame frame)

Description copied from interface: ExporterNature

Specified whether to include in the grid sub elements of a given frame element.

isSpanCells

public boolean isSpanCells()

Description copied from interface: ExporterNature

Specifies whether the exporter handles cells span

isIgnoreLastRow

public boolean isIgnoreLastRow()

isHorizontallyMergeEmptyCells

public boolean isHorizontallyMergeEmptyCells()

Description copied from interface: ExporterNature

Flag that specifies that empty cells are to be horizontally merged.

If the flag is set and this nature is deep, the nature is required to export frames.

Returns:

whether empty cells are to be horizontally merged

isIgnorePageMargins

public boolean isIgnorePageMargins()

Specifies whether empty page margins should be ignored

isBreakBeforeRow

public boolean isBreakBeforeRow(JRPrintElement element)

isBreakAfterRow

public boolean isBreakAfterRow(JRPrintElement element)

getRowAutoFit

public Boolean getRowAutoFit(JRPrintElement element)

getIgnoreRowHeight

public Boolean getIgnoreRowHeight(JRPrintElement element)

getColumnAutoFit

public Boolean getColumnAutoFit(JRPrintElement element)

getShowGridlines

public Boolean getShowGridlines(JRPrintElement element)

getIgnoreCellBackground

public Boolean getIgnoreCellBackground(JRPrintElement element)

getIgnoreCellBorder

public Boolean getIgnoreCellBorder(JRPrintElement element)

getWhitePageBackground

public Boolean getWhitePageBackground(JRPrintElement element)

getColumnWidth

public Integer getColumnWidth(JRPrintElement element,
                              boolean columnAutoFit)

getColumnWidthRatio

public Float getColumnWidthRatio(JRPrintElement element)

getRowLevelSuffixes

public List<JRPropertiesUtil.PropertySuffix> getRowLevelSuffixes(JRPrintElement element)

getSheetName

public String getSheetName(JRPrintElement element)

getFreezeRowEdge

public CellEdgeEnum getFreezeRowEdge(JRPrintElement element)

getFreezeColumnEdge

public CellEdgeEnum getFreezeColumnEdge(JRPrintElement element)

getSheetTabColor

public String getSheetTabColor(JRPrintElement element)

getPageScale

public Integer getPageScale(JRPrintElement element)

getFirstPageNumber

public Integer getFirstPageNumber(JRPrintElement element)

getDefinedNames

public JRPropertiesUtil.PropertySuffix[] getDefinedNames(JRPrintElement element)

setXProperties

public void setXProperties(CutsInfo xCuts,
                           JRPrintElement element,
                           int row1,
                           int col1,
                           int row2,
                           int col2)

Specified by:

setXProperties in interface ExporterNature

Overrides:

setXProperties in class AbstractExporterNature

setXProperties

public void setXProperties(Map<String,Object> xCutsProperties,
                           JRPrintElement element)

Specified by:

setXProperties in interface ExporterNature

Overrides:

setXProperties in class AbstractExporterNature

setYProperties

public void setYProperties(CutsInfo yCuts,
                           JRPrintElement element,
                           int row1,
                           int col1,
                           int row2,
                           int col2)

Specified by:

setYProperties in interface ExporterNature

Overrides:

setYProperties in class AbstractExporterNature

setYProperties

public void setYProperties(Map<String,Object> yCutsProperties,
                           JRPrintElement element)

Specified by:

setYProperties in interface ExporterNature

Overrides:

setYProperties in class AbstractExporterNature

getPrintPageTopMargin

public Integer getPrintPageTopMargin(JRPrintElement element)

getPrintPageLeftMargin

public Integer getPrintPageLeftMargin(JRPrintElement element)

getPrintPageBottomMargin

public Integer getPrintPageBottomMargin(JRPrintElement element)

getPrintPageRightMargin

public Integer getPrintPageRightMargin(JRPrintElement element)

getPrintPageHeight

public Integer getPrintPageHeight(JRPrintElement element)

getPrintPageWidth

public Integer getPrintPageWidth(JRPrintElement element)

getPrintHeaderMargin

public Integer getPrintHeaderMargin(JRPrintElement element)

getPrintFooterMargin

public Integer getPrintFooterMargin(JRPrintElement element)

getSheetHeaderLeft

public String getSheetHeaderLeft(JRPrintElement element)

getSheetHeaderCenter

public String getSheetHeaderCenter(JRPrintElement element)

getSheetHeaderRight

public String getSheetHeaderRight(JRPrintElement element)

getSheetFooterLeft

public String getSheetFooterLeft(JRPrintElement element)

getSheetFooterCenter

public String getSheetFooterCenter(JRPrintElement element)

getSheetFooterRight

public String getSheetFooterRight(JRPrintElement element)