com.businessobjects.enterprise.crystalreport
Interface ExcelFormat

All Superinterfaces:

FormatInterface, PageFormat

public interface ExcelFormat
extends PageFormat

Allows you to set the options for a report that is to be scheduled as an Excel spreadsheet. You can customize cell and column formats as well as how worksheet functions are used.

Nested Class Summary

static class

ExcelFormat.Factory A class with methods for creating instances of the ExcelFormat type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

int	getBaseAreaGroupNum() Returns which group section to base the column width on.
SectionTypeEnum.Enum	getBaseAreaType() Returns which section to base the column width on.
boolean	getColumnHeadingAvailable() Returns whether or not to use column headings.
double	getConstantColWidth() Returns the size of the constant column width.
boolean	getConstantColWidthUsed() Returns whether or not to use constant column widths.
boolean	getDateConvertedToString() Returns whether or not to convert the date to a string value.
boolean	getExportPageheader() Internal Use Only.
HeaderFooterOptionEnum.Enum	getExportPageHeaderFooter() Returns the way page header and footer are exported.
boolean	getGridlineShown() Returns whether or not to include gridlines during exporting.
boolean	getPageBreakCreated() Returns whether or not to create page breaks.
boolean	getTabularFormat() Returns whether or not to use a tabular format.
boolean	isSetBaseAreaGroupNum() Checks if the BaseAreaGroupNum element has been set.
boolean	isSetBaseAreaType() Checks if the BaseAreaType element has been set.
boolean	isSetColumnHeadingAvailable() Checks if the ColumnHeadingAvailable element has been set.
boolean	isSetConstantColWidth() Checks if the ConstantColWidth element has been set.
boolean	isSetConstantColWidthUsed() Checks if the ConstantColWidthUsed element has been set.
boolean	isSetDateConvertedToString() Checks if the convert the date element has been set.
boolean	isSetExportPageheader() Internal Use Only.
boolean	isSetExportPageHeaderFooter() Checks if the page header and footer are exported has been set.
boolean	isSetGridlineShown() Checks if the GridlineShown element has been set.
boolean	isSetPageBreakCreated() Checks if the PageBreakCreated element has been set.
boolean	isSetTabularFormat() Checks if the TabularFormat element has been set.
void	setBaseAreaGroupNum(int baseAreaGroupNum) Sets which section to base the column width on.
void	setBaseAreaType(SectionTypeEnum.Enum baseAreaType) Sets which section to base the column width on.
void	setColumnHeadingAvailable(boolean columnHeadingAvailable) Sets whether or not to use column headings.
void	setConstantColWidth(double constantColWidth) Sets the size of the constant column width.
void	setConstantColWidthUsed(boolean constantColWidthUsed) Returns whether or not to use constant column widths.
void	setDateConvertedToString(boolean dateConvertedToString) Sets whether or not to convert the date to a string value.
void	setExportPageheader(boolean exportPageheader) Internal Use Only.
void	setExportPageHeaderFooter(HeaderFooterOptionEnum.Enum exportPageHeaderFooter) Sets the way page header and footer are exported.
void	setGridlineShown(boolean gridlineShown) Sets whether or not to include gridlines during exporting.
void	setPageBreakCreated(boolean pageBreakCreated) Sets whether or not to create page breaks.
void	setTabularFormat(boolean tabularFormat) Sets whether or not to use a tabular format.
void	unsetBaseAreaGroupNum() Deletes or unsets the BaseAreaGroupNum element.
void	unsetBaseAreaType() Deletes or unsets the BaseAreaType element.
void	unsetColumnHeadingAvailable() Deletes or unsets the ColumnHeadingAvailable element.
void	unsetConstantColWidth() Deletes or unsets the ConstantColWidth element.
void	unsetConstantColWidthUsed() Deletes or unsets the ConstantColWidthUsed element.
void	unsetDateConvertedToString() Deletes or unsets the GridlineShown element.
void	unsetExportPageheader() Internal Use Only.
void	unsetExportPageHeaderFooter() Deletes or unsets the ExportPageHeaderFooter element.
void	unsetGridlineShown() Deletes or unsets the GridlineShown element.
void	unsetPageBreakCreated() Deletes or unsets the BaseAreaGroupNum element.
void	unsetTabularFormat() Deletes or unsets the TabularFormat element.
org.apache.xmlbeans.XmlInt	xgetBaseAreaGroupNum() Internal Use Only.
SectionTypeEnum	xgetBaseAreaType() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetColumnHeadingAvailable() Internal Use Only.
org.apache.xmlbeans.XmlDouble	xgetConstantColWidth() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetConstantColWidthUsed() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetDateConvertedToString() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetExportPageheader() Internal Use Only.
HeaderFooterOptionEnum	xgetExportPageHeaderFooter() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetGridlineShown() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetPageBreakCreated() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetTabularFormat() Internal Use Only.
void	xsetBaseAreaGroupNum(org.apache.xmlbeans.XmlInt baseAreaGroupNum) Internal Use Only.
void	xsetBaseAreaType(SectionTypeEnum baseAreaType) Internal Use Only.
void	xsetColumnHeadingAvailable(org.apache.xmlbeans.XmlBoolean columnHeadingAvailable) Internal Use Only.
void	xsetConstantColWidth(org.apache.xmlbeans.XmlDouble constantColWidth) Internal Use Only.
void	xsetConstantColWidthUsed(org.apache.xmlbeans.XmlBoolean constantColWidthUsed) Internal Use Only.
void	xsetDateConvertedToString(org.apache.xmlbeans.XmlBoolean dateConvertedToString) Internal Use Only.
void	xsetExportPageheader(org.apache.xmlbeans.XmlBoolean exportPageheader) Internal Use Only.
void	xsetExportPageHeaderFooter(HeaderFooterOptionEnum exportPageHeaderFooter) Internal Use Only.
void	xsetGridlineShown(org.apache.xmlbeans.XmlBoolean gridlineShown) Internal Use Only.
void	xsetPageBreakCreated(org.apache.xmlbeans.XmlBoolean pageBreakCreated) Internal Use Only.
void	xsetTabularFormat(org.apache.xmlbeans.XmlBoolean tabularFormat) Internal Use Only.

Methods inherited from interface com.businessobjects.enterprise.crystalreport.PageFormat

getAllPageExported, getEndPageNumber, getStartPageNumber, isSetAllPageExported, isSetEndPageNumber, isSetStartPageNumber, setAllPageExported, setEndPageNumber, setStartPageNumber, unsetAllPageExported, unsetEndPageNumber, unsetStartPageNumber, xgetAllPageExported, xgetEndPageNumber, xgetStartPageNumber, xsetAllPageExported, xsetEndPageNumber, xsetStartPageNumber

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getColumnHeadingAvailable

boolean getColumnHeadingAvailable()

Returns whether or not to use column headings.

Returns:

true if column headings will be used, otherwise false.

xgetColumnHeadingAvailable

org.apache.xmlbeans.XmlBoolean xgetColumnHeadingAvailable()

Internal Use Only.

isSetColumnHeadingAvailable

boolean isSetColumnHeadingAvailable()

Checks if the ColumnHeadingAvailable element has been set.

Returns:

true if the ColumnHeadingAvailable element has been set, otherwise false.

setColumnHeadingAvailable

void setColumnHeadingAvailable(boolean columnHeadingAvailable)

Sets whether or not to use column headings.

Parameters:

columnHeadingAvailable - true if column headings will be used, otherwise false.

xsetColumnHeadingAvailable

void xsetColumnHeadingAvailable(org.apache.xmlbeans.XmlBoolean columnHeadingAvailable)

Internal Use Only.

unsetColumnHeadingAvailable

void unsetColumnHeadingAvailable()

Deletes or unsets the ColumnHeadingAvailable element.

getTabularFormat

boolean getTabularFormat()

Returns whether or not to use a tabular format.

Returns:

true if tabular format will be used, otherwise false.

xgetTabularFormat

org.apache.xmlbeans.XmlBoolean xgetTabularFormat()

Internal Use Only.

isSetTabularFormat

boolean isSetTabularFormat()

Checks if the TabularFormat element has been set.

Returns:

true if the TabularFormat element has been set, otherwise false.

setTabularFormat

void setTabularFormat(boolean tabularFormat)

Sets whether or not to use a tabular format.

Parameters:

tabularFormat - true if tabular format will be used, otherwise false.

xsetTabularFormat

void xsetTabularFormat(org.apache.xmlbeans.XmlBoolean tabularFormat)

Internal Use Only.

unsetTabularFormat

void unsetTabularFormat()

Deletes or unsets the TabularFormat element.

getExportPageheader

boolean getExportPageheader()

Internal Use Only.

xgetExportPageheader

org.apache.xmlbeans.XmlBoolean xgetExportPageheader()

Internal Use Only.

isSetExportPageheader

boolean isSetExportPageheader()

Internal Use Only.

setExportPageheader

void setExportPageheader(boolean exportPageheader)

Internal Use Only.

xsetExportPageheader

void xsetExportPageheader(org.apache.xmlbeans.XmlBoolean exportPageheader)

Internal Use Only.

unsetExportPageheader

void unsetExportPageheader()

Internal Use Only.

getGridlineShown

boolean getGridlineShown()

Returns whether or not to include gridlines during exporting.

Returns:

true if export include gridlines, otherwise false.

xgetGridlineShown

org.apache.xmlbeans.XmlBoolean xgetGridlineShown()

Internal Use Only.

isSetGridlineShown

boolean isSetGridlineShown()

Checks if the GridlineShown element has been set.

Returns:

true if the GridlineShown element has been set, otherwise false.

setGridlineShown

void setGridlineShown(boolean gridlineShown)

Sets whether or not to include gridlines during exporting.

Parameters:

gridlineShown - true if export include gridlines, otherwise false.

xsetGridlineShown

void xsetGridlineShown(org.apache.xmlbeans.XmlBoolean gridlineShown)

Internal Use Only.

unsetGridlineShown

void unsetGridlineShown()

Deletes or unsets the GridlineShown element.

getDateConvertedToString

boolean getDateConvertedToString()

Returns whether or not to convert the date to a string value.

Returns:

true if date will be converted to string, and false otherwise.

xgetDateConvertedToString

org.apache.xmlbeans.XmlBoolean xgetDateConvertedToString()

Internal Use Only.

isSetDateConvertedToString

boolean isSetDateConvertedToString()

Checks if the convert the date element has been set.

Returns:

true if the DateConvertedToString element has been set, otherwise false.

setDateConvertedToString

void setDateConvertedToString(boolean dateConvertedToString)

Sets whether or not to convert the date to a string value.

Parameters:

dateConvertedToString - true if date will be converted to string, and false otherwise.

xsetDateConvertedToString

void xsetDateConvertedToString(org.apache.xmlbeans.XmlBoolean dateConvertedToString)

Internal Use Only.

unsetDateConvertedToString

void unsetDateConvertedToString()

Deletes or unsets the GridlineShown element.

getExportPageHeaderFooter

HeaderFooterOptionEnum.Enum getExportPageHeaderFooter()

Returns the way page header and footer are exported.

Returns:

Specifies the way page header and footer are exported.

xgetExportPageHeaderFooter

HeaderFooterOptionEnum xgetExportPageHeaderFooter()

Internal Use Only.

isSetExportPageHeaderFooter

boolean isSetExportPageHeaderFooter()

Checks if the page header and footer are exported has been set.

Returns:

true if the ExportPageHeaderFooter element has been set, otherwise false.

setExportPageHeaderFooter

void setExportPageHeaderFooter(HeaderFooterOptionEnum.Enum exportPageHeaderFooter)

Sets the way page header and footer are exported.

Parameters:

exportPageHeaderFooter - Specifies the way page header and footer are exported.

xsetExportPageHeaderFooter

void xsetExportPageHeaderFooter(HeaderFooterOptionEnum exportPageHeaderFooter)

Internal Use Only.

unsetExportPageHeaderFooter

void unsetExportPageHeaderFooter()

Deletes or unsets the ExportPageHeaderFooter element.

getConstantColWidthUsed

boolean getConstantColWidthUsed()

Returns whether or not to use constant column widths.

Note: The value for this property must be within the range 10-288.

Returns:

true if constant column widths will be used, , otherwise false.

xgetConstantColWidthUsed

org.apache.xmlbeans.XmlBoolean xgetConstantColWidthUsed()

Internal Use Only.

isSetConstantColWidthUsed

boolean isSetConstantColWidthUsed()

Checks if the ConstantColWidthUsed element has been set.

Returns:

true if the ConstantColWidthUsed element has been set, otherwise false.

setConstantColWidthUsed

void setConstantColWidthUsed(boolean constantColWidthUsed)

Returns whether or not to use constant column widths.

Note: The value for this property must be within the range 10-288.

Parameters:

constantColWidthUsed - true if constant column widths will be used, otherwise false.

xsetConstantColWidthUsed

void xsetConstantColWidthUsed(org.apache.xmlbeans.XmlBoolean constantColWidthUsed)

Internal Use Only.

unsetConstantColWidthUsed

void unsetConstantColWidthUsed()

Deletes or unsets the ConstantColWidthUsed element.

getConstantColWidth

double getConstantColWidth()

Returns the size of the constant column width.

Returns:

A Double specifying the size of the constant column width.

xgetConstantColWidth

org.apache.xmlbeans.XmlDouble xgetConstantColWidth()

Internal Use Only.

isSetConstantColWidth

boolean isSetConstantColWidth()

Checks if the ConstantColWidth element has been set.

Returns:

true if the ConstantColWidth element has been set, otherwise false.

setConstantColWidth

void setConstantColWidth(double constantColWidth)

Sets the size of the constant column width.

Parameters:

constantColWidth - A Double specifying the size of the constant column width.

xsetConstantColWidth

void xsetConstantColWidth(org.apache.xmlbeans.XmlDouble constantColWidth)

Internal Use Only.

unsetConstantColWidth

void unsetConstantColWidth()

Deletes or unsets the ConstantColWidth element.

getBaseAreaType

SectionTypeEnum.Enum getBaseAreaType()

Returns which section to base the column width on.

Returns:

Specifies the section to base the column width on when exporting to Excel.

xgetBaseAreaType

SectionTypeEnum xgetBaseAreaType()

Internal Use Only.

isSetBaseAreaType

boolean isSetBaseAreaType()

Checks if the BaseAreaType element has been set.

Returns:

true if the BaseAreaType element has been set, otherwise false.

setBaseAreaType

void setBaseAreaType(SectionTypeEnum.Enum baseAreaType)

Sets which section to base the column width on.

Parameters:

baseAreaType - Specifies the section to base the column width on when exporting to Excel.

xsetBaseAreaType

void xsetBaseAreaType(SectionTypeEnum baseAreaType)

Internal Use Only.

unsetBaseAreaType

void unsetBaseAreaType()

Deletes or unsets the BaseAreaType element.

getBaseAreaGroupNum

int getBaseAreaGroupNum()

Returns which group section to base the column width on.

Returns:

An Integer specifying the group section to base the column width on.

xgetBaseAreaGroupNum

org.apache.xmlbeans.XmlInt xgetBaseAreaGroupNum()

Internal Use Only.

isSetBaseAreaGroupNum

boolean isSetBaseAreaGroupNum()

Checks if the BaseAreaGroupNum element has been set.

Returns:

true if the BaseAreaGroupNum element has been set, otherwise false.

setBaseAreaGroupNum

void setBaseAreaGroupNum(int baseAreaGroupNum)

Sets which section to base the column width on.

Parameters:

baseAreaType - Specifies the section to base the column width on when exporting to Excel.

xsetBaseAreaGroupNum

void xsetBaseAreaGroupNum(org.apache.xmlbeans.XmlInt baseAreaGroupNum)

Internal Use Only.

unsetBaseAreaGroupNum

void unsetBaseAreaGroupNum()

Deletes or unsets the BaseAreaGroupNum element.

getPageBreakCreated

boolean getPageBreakCreated()

Returns whether or not to create page breaks.

Returns:

true if page breaks will be created, and false otherwise.

xgetPageBreakCreated

org.apache.xmlbeans.XmlBoolean xgetPageBreakCreated()

Internal Use Only.

isSetPageBreakCreated

boolean isSetPageBreakCreated()

Checks if the PageBreakCreated element has been set.

Returns:

true if the PageBreakCreated element has been set, otherwise false.

setPageBreakCreated

void setPageBreakCreated(boolean pageBreakCreated)

Sets whether or not to create page breaks.

Parameters:

pageBreakCreated - true if page breaks will be created, and false otherwise.

xsetPageBreakCreated

void xsetPageBreakCreated(org.apache.xmlbeans.XmlBoolean pageBreakCreated)

Internal Use Only.

unsetPageBreakCreated

void unsetPageBreakCreated()

Deletes or unsets the BaseAreaGroupNum element.