com.businessobjects.enterprise.crystalreport
Class ExcelFormat

java.lang.Object
  com.businessobjects.enterprise.crystalreport.FormatInterface
      com.businessobjects.enterprise.crystalreport.PageFormat
          com.businessobjects.enterprise.crystalreport.ExcelFormat

All Implemented Interfaces:

java.io.Serializable

public class ExcelFormat

extends PageFormat

implements java.io.Serializable

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.

See Also:

Serialized Form

Constructor Summary

ExcelFormat()

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
java.lang.Integer	getBaseAreaGroupNum() Returns which group section to base the column width on.
SectionTypeEnum	getBaseAreaType() Returns which section to base the column width on.
java.lang.Boolean	getColumnHeadingAvailable() Returns whether or not to use column headings.
java.lang.Double	getConstantColWidth() Returns the size of the constant column width.
java.lang.Boolean	getConstantColWidthUsed() Returns whether or not to use constant column widths.
java.lang.Boolean	getDateConvertedToString() Returns whether or not to convert the date to a string value.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.Boolean	getExportPageheader() Internal Use Only.
HeaderFooterOptionEnum	getExportPageHeaderFooter() Returns the way page header and footer are exported.
java.lang.Boolean	getGridlineShown() Returns whether or not to include gridlines during exporting.
java.lang.Boolean	getPageBreakCreated() Returns whether or not to create page breaks.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.Boolean	getTabularFormat() Returns whether or not to use a tabular format.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
void	setBaseAreaGroupNum(java.lang.Integer baseAreaGroupNum) Sets which group section to base the column width on.
void	setBaseAreaType(SectionTypeEnum baseAreaType) Sets which section to base the column width on.
void	setColumnHeadingAvailable(java.lang.Boolean columnHeadingAvailable) Sets whether or not to use column headings.
void	setConstantColWidth(java.lang.Double constantColWidth) Sets the size of the constant column width.
void	setConstantColWidthUsed(java.lang.Boolean constantColWidthUsed) Returns whether or not to use constant column widths.
void	setDateConvertedToString(java.lang.Boolean dateConvertedToString) Sets whether or not to convert the date to a string value.
void	setExportPageheader(java.lang.Boolean exportPageheader) Internal Use Only.
void	setExportPageHeaderFooter(HeaderFooterOptionEnum exportPageHeaderFooter) Sets the way page header and footer are exported.
void	setGridlineShown(java.lang.Boolean gridlineShown) Sets whether or not to include gridlines during exporting.
void	setPageBreakCreated(java.lang.Boolean pageBreakCreated) Sets whether or not to create page breaks.
void	setTabularFormat(java.lang.Boolean tabularFormat) Sets whether or not to use a tabular format.

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

getAllPageExported, getEndPageNumber, getStartPageNumber, setAllPageExported, setEndPageNumber, setStartPageNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExcelFormat

public ExcelFormat()

Method Detail

getColumnHeadingAvailable

public java.lang.Boolean getColumnHeadingAvailable()

Returns whether or not to use column headings.

Returns:

true if column headings will be used, false otherwise.

setColumnHeadingAvailable

public void setColumnHeadingAvailable(java.lang.Boolean columnHeadingAvailable)

Sets whether or not to use column headings.

Parameters:

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

getTabularFormat

public java.lang.Boolean getTabularFormat()

Returns whether or not to use a tabular format.

Returns:

true if tabular format will be used, false otherwise.

setTabularFormat

public void setTabularFormat(java.lang.Boolean tabularFormat)

Sets whether or not to use a tabular format.

Parameters:

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

getExportPageheader

public java.lang.Boolean getExportPageheader()

Internal Use Only.

setExportPageheader

public void setExportPageheader(java.lang.Boolean exportPageheader)

Internal Use Only.

getGridlineShown

public java.lang.Boolean getGridlineShown()

Returns whether or not to include gridlines during exporting.

Returns:

true if export include gridlines, false otherwise.

setGridlineShown

public void setGridlineShown(java.lang.Boolean gridlineShown)

Sets whether or not to include gridlines during exporting.

Parameters:

gridlineShown - true if export include gridlines, false otherwise.

getDateConvertedToString

public java.lang.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.

setDateConvertedToString

public void setDateConvertedToString(java.lang.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.

getExportPageHeaderFooter

public HeaderFooterOptionEnum getExportPageHeaderFooter()

Returns the way page header and footer are exported.

Returns:

Specifies the way page header and footer are exported.

setExportPageHeaderFooter

public void setExportPageHeaderFooter(HeaderFooterOptionEnum exportPageHeaderFooter)

Sets the way page header and footer are exported.

Parameters:

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

getConstantColWidthUsed

public java.lang.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, false otherwise.

setConstantColWidthUsed

public void setConstantColWidthUsed(java.lang.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, false otherwise.

getConstantColWidth

public java.lang.Double getConstantColWidth()

Returns the size of the constant column width.

Returns:

A Double specifying the size of the constant column width.

setConstantColWidth

public void setConstantColWidth(java.lang.Double constantColWidth)

Sets the size of the constant column width.

Parameters:

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

getBaseAreaType

public SectionTypeEnum getBaseAreaType()

Returns which section to base the column width on.

Returns:

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

setBaseAreaType

public void setBaseAreaType(SectionTypeEnum 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.

getBaseAreaGroupNum

public java.lang.Integer getBaseAreaGroupNum()

Returns which group section to base the column width on.

Returns:

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

setBaseAreaGroupNum

public void setBaseAreaGroupNum(java.lang.Integer baseAreaGroupNum)

Sets which group section to base the column width on.

Parameters:

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

getPageBreakCreated

public java.lang.Boolean getPageBreakCreated()

Returns whether or not to create page breaks.

Returns:

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

setPageBreakCreated

public void setPageBreakCreated(java.lang.Boolean pageBreakCreated)

Sets whether or not to create page breaks.

Parameters:

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

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

Overrides:

equals in class PageFormat

hashCode

public int hashCode()

Internal Use Only.

Overrides:

hashCode in class PageFormat

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.