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

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.exportoptions.PageBasedExportFormatOptions
All Implemented Interfaces:
IExportFormatOptions, IPageBasedExportFormatOptions, IClone
Direct Known Subclasses:
EditableRTFExportFormatOptions, ExcelExportFormatOptions, PDFExportFormatOptions, RTFWordExportFormatOptions

public abstract class PageBasedExportFormatOptions
extends java.lang.Object
implements IPageBasedExportFormatOptions

This abstract object defines export options when exporting to a page based export format. This includes specifying a range of pages to be exported. Page based export formats include Microsoft Excel (97-2003), PDF, Rich Text Format (RTF), and Microsoft Word (97-2003).


Constructor Summary
PageBasedExportFormatOptions()
           
 
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, 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 getEndPageNumber()
           Returns the end page, of a page export range, when exporting to a page based format.
 int getStartPageNumber()
           Returns the start page, of a page export range, when exporting to a page based 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 setEndPageNumber(int pageNumber)
           Sets the end page of a page export range, when exporting to a page-based format.
 void setStartPageNumber(int pageNumber)
           Sets the start page of a page export range, when exporting to a page-based 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

PageBasedExportFormatOptions

public PageBasedExportFormatOptions()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

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)

For internal use only.


endElement

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

For internal use only.


getEndPageNumber

public int getEndPageNumber()
Description copied from interface: IPageBasedExportFormatOptions

Returns the end page, of a page export range, when exporting to a page based format. By default, all pages in the report are exported.

Specified by:
getEndPageNumber in interface IPageBasedExportFormatOptions
Returns:
An int that specifies the end page.

getStartPageNumber

public int getStartPageNumber()
Description copied from interface: IPageBasedExportFormatOptions

Returns the start page, of a page export range, when exporting to a page based format. By default, all pages in the report are exported.

Specified by:
getStartPageNumber in interface IPageBasedExportFormatOptions
Returns:
An int that specifies the start page.

hasContent

public boolean hasContent(java.lang.Object obj)

checkValidity

public void checkValidity(java.util.Locale locale)
                   throws ReportSDKException
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
Throws:
ReportSDKException - if the options are not valid

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(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

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

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setEndPageNumber

public void setEndPageNumber(int pageNumber)
Description copied from interface: IPageBasedExportFormatOptions

Sets the end page of a page export range, when exporting to a page-based format. By default, all pages in the report are exported.

Specified by:
setEndPageNumber in interface IPageBasedExportFormatOptions
Parameters:
pageNumber - An int that specifies the end page.

setStartPageNumber

public void setStartPageNumber(int pageNumber)
Description copied from interface: IPageBasedExportFormatOptions

Sets the start page of a page export range, when exporting to a page-based format. By default, all pages in the report are exported.

Specified by:
setStartPageNumber in interface IPageBasedExportFormatOptions
Parameters:
pageNumber - An int that specifies the start page.

startElement

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

For internal use only.