com.crystaldecisions.sdk.occa.report.exportoptions
Class ExcelExportFormatOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.exportoptions.PageBasedExportFormatOptions
      extended by com.crystaldecisions.sdk.occa.report.exportoptions.ExcelExportFormatOptions
All Implemented Interfaces:
IExcelExportFormatOptions, IExportFormatOptions, IPageBasedExportFormatOptions, IClone

public class ExcelExportFormatOptions
extends PageBasedExportFormatOptions
implements IExcelExportFormatOptions

This class is used to specify the format of a document that is exported with Microsoft Excel (97-2003) formatting. When possible, use the IExcelExportFormatOptions interface to manipulate this object.


Constructor Summary
ExcelExportFormatOptions()
           
ExcelExportFormatOptions(IExcelExportFormatOptions src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 int getBaseAreaGroupNumber()
           Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.
 AreaSectionKind getBaseAreaType()
           Returns the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) format.
 int getConstantColWidth()
           Returns the column width when exporting to Excel format.
 boolean getConvertDatesToStrings()
           Returns whether the dates are converted to strings in the exported report.
 boolean getExcelTabHasColumnHeadings()
           Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
 ExportPageAreaPairKind getExportPageAreaPairType()
          Returns the ExportPageAreaPairKind object.
 boolean getExportPageBreaks()
           Returns whether page breaks are exported.
 boolean getMaintainRelativeObjectPosition()
           Returns whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.
 boolean getShowGridlines()
           Returns whether the gridlines will show when exporting to Microsoft Excel (97-2003) format.
 boolean getUseConstantColWidth()
           Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
 boolean hasContent(java.lang.Object obj)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void setBaseAreaGroupNumber(int groupNumber)
           Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.
 void setBaseAreaType(AreaSectionKind areaType)
           Sets the AreaSectionKind, if constant column width is not used when exporting to Excel format.
 void setConstantColWidth(int colWidth)
           Sets the column width when exporting to Excel format.
 void setConvertDatesToStrings(boolean bConvertDatesToStrings)
           Sets whether the dates are converted to strings in the exported report.
 void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)
           Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
 void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)
          Sets the value of ExportPageAreaPairKind which defines how the page header and footer pair will be exported.
 void setExportPageBreaks(boolean bExportPageBreaks)
           Sets whether page breaks are exported.
 void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)
           Sets whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.
 void setShowGridlines(boolean showGridlines)
          Sets whether gridlines will show when exporting to Microsoft Excel (97-2003) format.
 void setUseConstantColWidth(boolean useContantColWidth)
           Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.exportoptions.PageBasedExportFormatOptions
checkValidity, getEndPageNumber, getStartPageNumber, setEndPageNumber, setStartPageNumber
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.exportoptions.IPageBasedExportFormatOptions
getEndPageNumber, getStartPageNumber, setEndPageNumber, setStartPageNumber
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.exportoptions.IExportFormatOptions
checkValidity
 

Constructor Detail

ExcelExportFormatOptions

public ExcelExportFormatOptions(IExcelExportFormatOptions src)

ExcelExportFormatOptions

public ExcelExportFormatOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class PageBasedExportFormatOptions

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class PageBasedExportFormatOptions

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
createMember in class PageBasedExportFormatOptions

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
endElement in class PageBasedExportFormatOptions

getBaseAreaGroupNumber

public int getBaseAreaGroupNumber()
Description copied from interface: IExcelExportFormatOptions

Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.

Specified by:
getBaseAreaGroupNumber in interface IExcelExportFormatOptions
Returns:
The base area group number as an int.

getBaseAreaType

public AreaSectionKind getBaseAreaType()
Description copied from interface: IExcelExportFormatOptions

Returns the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) format.

Specified by:
getBaseAreaType in interface IExcelExportFormatOptions
Returns:
The AreaSectionKind, if constant column width is not used.

getConstantColWidth

public int getConstantColWidth()
Description copied from interface: IExcelExportFormatOptions

Returns the column width when exporting to Excel format.

Specified by:
getConstantColWidth in interface IExcelExportFormatOptions
Returns:
The column width as an int.

getExcelTabHasColumnHeadings

public boolean getExcelTabHasColumnHeadings()
Description copied from interface: IExcelExportFormatOptions

Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.

Specified by:
getExcelTabHasColumnHeadings in interface IExcelExportFormatOptions
Returns:
true if the column headings option is used when exporting to Microsoft Excel (97-2003) format, and false otherwise.

getUseConstantColWidth

public boolean getUseConstantColWidth()
Description copied from interface: IExcelExportFormatOptions

Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.

Specified by:
getUseConstantColWidth in interface IExcelExportFormatOptions
Returns:
true if the constant column width option is used when exporting to Excel format, and false otherwise.

hasContent

public boolean hasContent(java.lang.Object obj)
Overrides:
hasContent in class PageBasedExportFormatOptions

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
readElement in class PageBasedExportFormatOptions

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
save in class PageBasedExportFormatOptions
Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
save in class PageBasedExportFormatOptions
Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
saveContents in class PageBasedExportFormatOptions
Throws:
java.io.IOException

setBaseAreaGroupNumber

public void setBaseAreaGroupNumber(int groupNumber)
Description copied from interface: IExcelExportFormatOptions

Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.

Specified by:
setBaseAreaGroupNumber in interface IExcelExportFormatOptions
Parameters:
groupNumber - The base area group number as an int.

setBaseAreaType

public void setBaseAreaType(AreaSectionKind areaType)
Description copied from interface: IExcelExportFormatOptions

Sets the AreaSectionKind, if constant column width is not used when exporting to Excel format.

Specified by:
setBaseAreaType in interface IExcelExportFormatOptions
Parameters:
areaType - The AreaSectionKind, if constant column width is not used when exporting to Excel format.

setConstantColWidth

public void setConstantColWidth(int colWidth)
Description copied from interface: IExcelExportFormatOptions

Sets the column width when exporting to Excel format.

Specified by:
setConstantColWidth in interface IExcelExportFormatOptions
Parameters:
colWidth - The column width when exporting to Excel format as an int.

setExcelTabHasColumnHeadings

public void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)
Description copied from interface: IExcelExportFormatOptions

Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.

Specified by:
setExcelTabHasColumnHeadings in interface IExcelExportFormatOptions
Parameters:
hasColumnHeadings - true if the column headings option is used when exporting to Excel format, and false otherwise.

setUseConstantColWidth

public void setUseConstantColWidth(boolean useContantColWidth)
Description copied from interface: IExcelExportFormatOptions

Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.

Specified by:
setUseConstantColWidth in interface IExcelExportFormatOptions
Parameters:
useContantColWidth - true if the constant column width option is used when exporting to Excel format, and false otherwise.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: PageBasedExportFormatOptions

For internal use only.

Overrides:
startElement in class PageBasedExportFormatOptions

getExportPageAreaPairType

public ExportPageAreaPairKind getExportPageAreaPairType()

Returns the ExportPageAreaPairKind object.

Specified by:
getExportPageAreaPairType in interface IExcelExportFormatOptions
Returns:
a reference to the ExportPageAreaPairKind object

getShowGridlines

public boolean getShowGridlines()

Returns whether the gridlines will show when exporting to Microsoft Excel (97-2003) format.

Specified by:
getShowGridlines in interface IExcelExportFormatOptions
Returns:
true if the gridlines will show when exporting to Microsoft Excel (97-2003) format, and false otherwise.

getMaintainRelativeObjectPosition

public boolean getMaintainRelativeObjectPosition()

Returns whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.

Specified by:
getMaintainRelativeObjectPosition in interface IExcelExportFormatOptions
Returns:
true if the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format, and false otherwise.

setExportPageAreaPairType

public void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)

Sets the value of ExportPageAreaPairKind which defines how the page header and footer pair will be exported.

Specified by:
setExportPageAreaPairType in interface IExcelExportFormatOptions
Parameters:
exportPageAreaType - will be a value defined by the ExportPageAreaPairKind object

setShowGridlines

public void setShowGridlines(boolean showGridlines)

Sets whether gridlines will show when exporting to Microsoft Excel (97-2003) format.

Specified by:
setShowGridlines in interface IExcelExportFormatOptions
Parameters:
showGridlines - true if the gridlines will show when exporting to Microsoft Excel (97-2003) format, and false otherwise.

setMaintainRelativeObjectPosition

public void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)

Sets whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.

Specified by:
setMaintainRelativeObjectPosition in interface IExcelExportFormatOptions
Parameters:
maintainRelativeObjectPosition - true if the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format, and false otherwise.

getConvertDatesToStrings

public boolean getConvertDatesToStrings()
Description copied from interface: IExcelExportFormatOptions

Returns whether the dates are converted to strings in the exported report.

Specified by:
getConvertDatesToStrings in interface IExcelExportFormatOptions
Returns:
true if the dates are converted to strings in the exported report, and false otherwise.

getExportPageBreaks

public boolean getExportPageBreaks()
Description copied from interface: IExcelExportFormatOptions

Returns whether page breaks are exported.

Specified by:
getExportPageBreaks in interface IExcelExportFormatOptions
Returns:
true if page breaks are exported, and false otherwise.

setConvertDatesToStrings

public void setConvertDatesToStrings(boolean bConvertDatesToStrings)
Description copied from interface: IExcelExportFormatOptions

Sets whether the dates are converted to strings in the exported report.

Specified by:
setConvertDatesToStrings in interface IExcelExportFormatOptions
Parameters:
bConvertDatesToStrings - true if the dates are converted to strings in the exported report, and false otherwise.

setExportPageBreaks

public void setExportPageBreaks(boolean bExportPageBreaks)
Description copied from interface: IExcelExportFormatOptions

Sets whether page breaks are exported.

Specified by:
setExportPageBreaks in interface IExcelExportFormatOptions
Parameters:
bExportPageBreaks - true if page breaks are exported, and false otherwise.