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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.exportoptions.DataOnlyExcelExportFormatOptions
All Implemented Interfaces:
IDataOnlyExcelExportFormatOptions, IExportFormatOptions, IClone

public class DataOnlyExcelExportFormatOptions
extends java.lang.Object
implements IDataOnlyExcelExportFormatOptions

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


Constructor Summary
DataOnlyExcelExportFormatOptions()
           
DataOnlyExcelExportFormatOptions(IDataOnlyExcelExportFormatOptions src)
           
 
Method Summary
 void checkValidity(java.util.Locale locale)
          Verifies that the export options are valid for a given locale.
 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, 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) Data-Only 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 Microsoft Excel (97-2003) Data-Only format.
 boolean getExportImages()
           Returns whether the images are exported.
 boolean getExportObjectFormatting()
           Returns whether the object formatting is exported.
 boolean getExportPageHeaderAndFooter()
           Returns whether the page header and footer are exported.
 boolean getMaintainColumnAlignment()
           Returns whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getMaintainRelativeObjectPosition()
           Returns whether the relative object position is maintained in the exported report.
 boolean getShowGroupOutlines()
           Returns whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getSimplifyPageHeaders()
           Returns whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getUseConstantColWidth()
           Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getUseWorksheetFunctionsForSummaries()
           Returns whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only 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(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, 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) Data-Only format.
 void setBaseAreaType(AreaSectionKind areaType)
           Sets the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setConstantColWidth(int colWidth)
           Sets the column width when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setExportImages(boolean bExportImages)
           Sets whether the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setExportObjectFormatting(boolean bExportObjectFormatting)
           Sets whether the object formatting is exported.
 void setExportPageHeaderAndFooter(boolean bExportPageHeaderAndFooter)
           Sets whether the page header and footer are exported.
 void setMaintainColumnAlignment(boolean bMaintainColumnAlignment)
           Sets whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setMaintainRelativeObjectPosition(boolean bMaintainRelativeObjectPosition)
           Sets whether the relative object position is maintained in the exported report.
 void setShowGroupOutlines(boolean showGroupOutlines)
           Sets whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setSimplifyPageHeaders(boolean bSimplifyPageHeaders)
           Sets whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setUseConstantColWidth(boolean bUseConstantColWidth)
           Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setUseWorksheetFunctionsForSummaries(boolean bUseWorksheetFunctionsForSummaries)
           Sets whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataOnlyExcelExportFormatOptions

public DataOnlyExcelExportFormatOptions()

DataOnlyExcelExportFormatOptions

public DataOnlyExcelExportFormatOptions(IDataOnlyExcelExportFormatOptions src)
Method Detail

getBaseAreaGroupNumber

public int getBaseAreaGroupNumber()
Description copied from interface: IDataOnlyExcelExportFormatOptions

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

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

getConstantColWidth

public int getConstantColWidth()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns the column width when exporting to Microsoft Excel (97-2003) Data-Only format.

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

getBaseAreaType

public AreaSectionKind getBaseAreaType()
Description copied from interface: IDataOnlyExcelExportFormatOptions

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

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

getExportObjectFormatting

public boolean getExportObjectFormatting()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether the object formatting is exported.

Specified by:
getExportObjectFormatting in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the object formatting is exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getUseConstantColWidth

public boolean getUseConstantColWidth()
Description copied from interface: IDataOnlyExcelExportFormatOptions

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

Specified by:
getUseConstantColWidth in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getExportPageHeaderAndFooter

public boolean getExportPageHeaderAndFooter()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether the page header and footer are exported.

Specified by:
getExportPageHeaderAndFooter in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getExportImages

public boolean getExportImages()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether the images are exported.

Specified by:
getExportImages in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getMaintainRelativeObjectPosition

public boolean getMaintainRelativeObjectPosition()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether the relative object position is maintained in the exported report.

Specified by:
getMaintainRelativeObjectPosition in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the relative object position is maintained in the exported report, and false otherwise.

getUseWorksheetFunctionsForSummaries

public boolean getUseWorksheetFunctionsForSummaries()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
getUseWorksheetFunctionsForSummaries in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the worksheet functions are to be used for summaries in the exported report, and false otherwise.

getMaintainColumnAlignment

public boolean getMaintainColumnAlignment()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
getMaintainColumnAlignment in interface IDataOnlyExcelExportFormatOptions
Returns:
true if column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getSimplifyPageHeaders

public boolean getSimplifyPageHeaders()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.

If this method returns true, the simplest version of your Crystal report's page headers are exported. For example, if your page header includes two or more rows of objects, the program exports only the bottom row. If this method returns false, the program exports all objects in the page header (to a single row in the spreadsheet).

Specified by:
getSimplifyPageHeaders in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the page headers are to be simplified in the exported report, and false otherwise.

setBaseAreaGroupNumber

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

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

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

setConstantColWidth

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

Sets the column width when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
setConstantColWidth in interface IDataOnlyExcelExportFormatOptions
Parameters:
colWidth - The column width when exporting to Microsoft Excel (97-2003) Data-Only format as an int.

setBaseAreaType

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

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

Specified by:
setBaseAreaType in interface IDataOnlyExcelExportFormatOptions
Parameters:
areaType - The AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.

setExportObjectFormatting

public void setExportObjectFormatting(boolean bExportObjectFormatting)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether the object formatting is exported.

Specified by:
setExportObjectFormatting in interface IDataOnlyExcelExportFormatOptions
Parameters:
bExportObjectFormatting - true if the object formatting is exported, and false otherwise.

setUseConstantColWidth

public void setUseConstantColWidth(boolean bUseConstantColWidth)
Description copied from interface: IDataOnlyExcelExportFormatOptions

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

Specified by:
setUseConstantColWidth in interface IDataOnlyExcelExportFormatOptions

setExportPageHeaderAndFooter

public void setExportPageHeaderAndFooter(boolean bExportPageHeaderAndFooter)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether the page header and footer are exported.

Specified by:
setExportPageHeaderAndFooter in interface IDataOnlyExcelExportFormatOptions
Parameters:
bExportPageHeaderAndFooter - true if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setExportImages

public void setExportImages(boolean bExportImages)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
setExportImages in interface IDataOnlyExcelExportFormatOptions
Parameters:
bExportImages - true if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setMaintainRelativeObjectPosition

public void setMaintainRelativeObjectPosition(boolean bMaintainRelativeObjectPosition)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether the relative object position is maintained in the exported report.

Specified by:
setMaintainRelativeObjectPosition in interface IDataOnlyExcelExportFormatOptions
Parameters:
bMaintainRelativeObjectPosition - true if the relative object position is maintained in the exported report, and false otherwise.

setUseWorksheetFunctionsForSummaries

public void setUseWorksheetFunctionsForSummaries(boolean bUseWorksheetFunctionsForSummaries)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
setUseWorksheetFunctionsForSummaries in interface IDataOnlyExcelExportFormatOptions
Parameters:
bUseWorksheetFunctionsForSummaries - true if worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setMaintainColumnAlignment

public void setMaintainColumnAlignment(boolean bMaintainColumnAlignment)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.

Specified by:
setMaintainColumnAlignment in interface IDataOnlyExcelExportFormatOptions
Parameters:
bMaintainColumnAlignment - true if column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setSimplifyPageHeaders

public void setSimplifyPageHeaders(boolean bSimplifyPageHeaders)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.

Set this option to true to export the simplest version of your Crystal report's page headers. For example, if your page header includes two or more rows of objects, the program exports only the bottom row. If this option is not selected, the program exports all objects in the page header (to a single row in the spreadsheet).

Specified by:
setSimplifyPageHeaders in interface IDataOnlyExcelExportFormatOptions
Parameters:
bSimplifyPageHeaders - true page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

hasContent

public boolean hasContent(java.lang.Object obj)

checkValidity

public void checkValidity(java.util.Locale locale)
Description copied from interface: IExportFormatOptions
Verifies that the export options are valid for a given locale.

Specified by:
checkValidity in interface IExportFormatOptions
Parameters:
locale - the locale the options are being checked for

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


getShowGroupOutlines

public boolean getShowGroupOutlines()
Description copied from interface: IDataOnlyExcelExportFormatOptions

Returns whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.

Microsoft Excel (97-2003) supports eight levels of outline symbols. If the report has more than eight levels of group information, the entire report will be exported, but only eight levels of outline symbols will appear in the Microsoft Excel (97-2003) worksheet.

Specified by:
getShowGroupOutlines in interface IDataOnlyExcelExportFormatOptions
Returns:
true if the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setShowGroupOutlines

public void setShowGroupOutlines(boolean showGroupOutlines)
Description copied from interface: IDataOnlyExcelExportFormatOptions

Sets whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.

Microsoft Excel (97-2003) supports eight levels of outline symbols. If the report has more than eight levels of group information, the entire report will be exported, but only eight levels of outline symbols will appear in the Microsoft Excel (97-2003) worksheet.

Specified by:
setShowGroupOutlines in interface IDataOnlyExcelExportFormatOptions
Parameters:
showGroupOutlines - true if the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.