|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.exportoptions.PageBasedExportFormatOptions
com.crystaldecisions.sdk.occa.report.exportoptions.ExcelExportFormatOptions
public class ExcelExportFormatOptions
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 |
---|
public ExcelExportFormatOptions(IExcelExportFormatOptions src)
public ExcelExportFormatOptions()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
clone
in class PageBasedExportFormatOptions
public void copyTo(java.lang.Object destObject, boolean deepCopy)
copyTo
in class PageBasedExportFormatOptions
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)
PageBasedExportFormatOptions
For internal use only.
createMember
in class PageBasedExportFormatOptions
public void endElement(java.lang.String eleName, java.util.Map objState)
PageBasedExportFormatOptions
For internal use only.
endElement
in class PageBasedExportFormatOptions
public int getBaseAreaGroupNumber()
IExcelExportFormatOptions
Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.
getBaseAreaGroupNumber
in interface IExcelExportFormatOptions
int
.public AreaSectionKind getBaseAreaType()
IExcelExportFormatOptions
Returns the AreaSectionKind
, if
constant column width is not used when exporting to Microsoft Excel (97-2003) format.
getBaseAreaType
in interface IExcelExportFormatOptions
AreaSectionKind
, if
constant column width is not used.public int getConstantColWidth()
IExcelExportFormatOptions
Returns the column width when exporting to Excel format.
getConstantColWidth
in interface IExcelExportFormatOptions
int
.public boolean getExcelTabHasColumnHeadings()
IExcelExportFormatOptions
Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
getExcelTabHasColumnHeadings
in interface IExcelExportFormatOptions
true
if the column headings option is used when exporting to Microsoft Excel (97-2003)
format, and false
otherwise.public boolean getUseConstantColWidth()
IExcelExportFormatOptions
Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
getUseConstantColWidth
in interface IExcelExportFormatOptions
true
if the constant column width option is used when exporting to
Excel format, and false
otherwise.public boolean hasContent(java.lang.Object obj)
hasContent
in class PageBasedExportFormatOptions
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
PageBasedExportFormatOptions
For internal use only.
readElement
in class PageBasedExportFormatOptions
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
PageBasedExportFormatOptions
For internal use only.
save
in class PageBasedExportFormatOptions
java.io.IOException
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
PageBasedExportFormatOptions
For internal use only.
save
in class PageBasedExportFormatOptions
java.io.IOException
public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
PageBasedExportFormatOptions
For internal use only.
saveContents
in class PageBasedExportFormatOptions
java.io.IOException
public void setBaseAreaGroupNumber(int groupNumber)
IExcelExportFormatOptions
Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.
setBaseAreaGroupNumber
in interface IExcelExportFormatOptions
groupNumber
- The base area group number as an int
.public void setBaseAreaType(AreaSectionKind areaType)
IExcelExportFormatOptions
Sets the AreaSectionKind
, if
constant column width is not used when exporting to Excel format.
setBaseAreaType
in interface IExcelExportFormatOptions
areaType
- The AreaSectionKind
,
if constant column width is not used when exporting to Excel format.public void setConstantColWidth(int colWidth)
IExcelExportFormatOptions
Sets the column width when exporting to Excel format.
setConstantColWidth
in interface IExcelExportFormatOptions
colWidth
- The column width when exporting to Excel format as an int
.public void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)
IExcelExportFormatOptions
Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
setExcelTabHasColumnHeadings
in interface IExcelExportFormatOptions
hasColumnHeadings
- true
if the column headings option is used when
exporting to Excel format, and false
otherwise.public void setUseConstantColWidth(boolean useContantColWidth)
IExcelExportFormatOptions
Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
setUseConstantColWidth
in interface IExcelExportFormatOptions
useContantColWidth
- true
if the constant column width option is used
when exporting to Excel format, and false
otherwise.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
PageBasedExportFormatOptions
For internal use only.
startElement
in class PageBasedExportFormatOptions
public ExportPageAreaPairKind getExportPageAreaPairType()
Returns the ExportPageAreaPairKind
object.
getExportPageAreaPairType
in interface IExcelExportFormatOptions
ExportPageAreaPairKind
objectpublic boolean getShowGridlines()
Returns whether the gridlines will show when exporting to Microsoft Excel (97-2003) format.
getShowGridlines
in interface IExcelExportFormatOptions
true
if the gridlines will show when exporting to Microsoft Excel (97-2003) format,
and false
otherwise.public boolean getMaintainRelativeObjectPosition()
Returns whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.
getMaintainRelativeObjectPosition
in interface IExcelExportFormatOptions
true
if the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format,
and false
otherwise.public void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)
Sets the value of ExportPageAreaPairKind
which defines how the page header and footer pair will be exported.
setExportPageAreaPairType
in interface IExcelExportFormatOptions
exportPageAreaType
- will be a value defined by the ExportPageAreaPairKind
objectpublic void setShowGridlines(boolean showGridlines)
Sets whether gridlines will show when exporting to Microsoft Excel (97-2003) format.
setShowGridlines
in interface IExcelExportFormatOptions
showGridlines
- true
if the gridlines will show when exporting to Microsoft Excel (97-2003) format,
and false
otherwise.public void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)
Sets whether the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format.
setMaintainRelativeObjectPosition
in interface IExcelExportFormatOptions
maintainRelativeObjectPosition
- true
if the relative object position will be maintained when exporting to Microsoft Excel (97-2003) format,
and false
otherwise.public boolean getConvertDatesToStrings()
IExcelExportFormatOptions
Returns whether the dates are converted to strings in the exported report.
getConvertDatesToStrings
in interface IExcelExportFormatOptions
true
if the dates are converted to strings in the exported report, and
false
otherwise.public boolean getExportPageBreaks()
IExcelExportFormatOptions
Returns whether page breaks are exported.
getExportPageBreaks
in interface IExcelExportFormatOptions
true
if page breaks are exported, and false
otherwise.public void setConvertDatesToStrings(boolean bConvertDatesToStrings)
IExcelExportFormatOptions
Sets whether the dates are converted to strings in the exported report.
setConvertDatesToStrings
in interface IExcelExportFormatOptions
bConvertDatesToStrings
- true
if the dates are converted to strings in the
exported report, and false
otherwise.public void setExportPageBreaks(boolean bExportPageBreaks)
IExcelExportFormatOptions
Sets whether page breaks are exported.
setExportPageBreaks
in interface IExcelExportFormatOptions
bExportPageBreaks
- true
if page breaks are exported, and
false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |