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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.exportoptions.ExportOptions
All Implemented Interfaces:
IExportOptions, IClone

public class ExportOptions
extends java.lang.Object
implements IExportOptions, IClone

This object provides properties and methods for retrieving information and setting options for exporting your report (such as export format and destination). When possible, use the IExportOptions interface for manipulating this object.


Constructor Summary
ExportOptions()
           
ExportOptions(IExportOptions 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, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 ReportExportFormat getExportFormatType()
           Returns the format type for the exported report (for example, text, Microsoft Excel (97-2003), etc.).
 java.lang.Object getFormatOptions()
           Returns the formatting options specified for the export format type.
 boolean getUseDefault()
          For internal use only.
 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)
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 void setExportFormatType(ReportExportFormat exportFormatType)
           Sets the format type for the exported report (for example, text, Microsoft Excel (97-2003), etc.).
 void setFormatOptions(IExportFormatOptions formatOptions)
           Sets the formatting options specified for the export format type.
 void setFormatOptions(java.lang.Object formatOptions)
          Deprecated. - use setFormatOptions(IExportFormatOptions)
 void setUseDefault(boolean isUseDefault)
          For internal use only.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExportOptions

public ExportOptions(IExportOptions src)

ExportOptions

public ExportOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

getExportFormatType

public ReportExportFormat getExportFormatType()
Description copied from interface: IExportOptions

Returns the format type for the exported report (for example, text, Microsoft Excel (97-2003), etc.).

Specified by:
getExportFormatType in interface IExportOptions
Returns:
A ReportExportFormat object that specifies the format type of the exported report.

getFormatOptions

public java.lang.Object getFormatOptions()
Description copied from interface: IExportOptions

Returns the formatting options specified for the export format type.

Specified by:
getFormatOptions in interface IExportOptions
Returns:
An IExportFormatOptions that specifies the formatting options specified for the export format type.

hasContent

public boolean hasContent(java.lang.Object obj)

setExportFormatType

public void setExportFormatType(ReportExportFormat exportFormatType)
Description copied from interface: IExportOptions

Sets the format type for the exported report (for example, text, Microsoft Excel (97-2003), etc.).

Specified by:
setExportFormatType in interface IExportOptions
Parameters:
exportFormatType - A ReportExportFormat object that specifies the format type of the exported report.

setFormatOptions

public void setFormatOptions(java.lang.Object formatOptions)
Deprecated. - use setFormatOptions(IExportFormatOptions)

Specified by:
setFormatOptions in interface IExportOptions

setFormatOptions

public void setFormatOptions(IExportFormatOptions formatOptions)
Description copied from interface: IExportOptions

Sets the formatting options specified for the export format type.

Specified by:
setFormatOptions in interface IExportOptions
Parameters:
formatOptions - An IExportFormatOptions that specifies the formatting options specified for the export format type.

getUseDefault

public boolean getUseDefault()

For internal use only.


setUseDefault

public void setUseDefault(boolean isUseDefault)

For internal use only.


createMember

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

readElement

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

save

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

save

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

saveContents

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

startElement

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

endElement

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