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

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

public class TextExportFormatOptions
extends java.lang.Object
implements ITextExportFormatOptions

This object is used to set the format options for a report that is to be exported as Text. When possible, use the ITextExportFormatOptions interface for manipulating this object.


Constructor Summary
TextExportFormatOptions()
           
TextExportFormatOptions(ITextExportFormatOptions 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, 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 getCharactersPerInch()
           Gets the number of characters per inch.
 int getLinesPerPage()
           Gets the number of lines per page.
 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 setCharactersPerInch(int CharactersPerInch)
           Sets the number of characters per inch.
 void setLinesPerPage(int LinesPerPage)
           Sets the number of lines per page.
 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

TextExportFormatOptions

public TextExportFormatOptions()

TextExportFormatOptions

public TextExportFormatOptions(ITextExportFormatOptions src)
Method Detail

setLinesPerPage

public void setLinesPerPage(int LinesPerPage)
Description copied from interface: ITextExportFormatOptions

Sets the number of lines per page.

Specified by:
setLinesPerPage in interface ITextExportFormatOptions
Parameters:
LinesPerPage - An int that specifies the number of lines per page.

getLinesPerPage

public int getLinesPerPage()
Description copied from interface: ITextExportFormatOptions

Gets the number of lines per page.

Specified by:
getLinesPerPage in interface ITextExportFormatOptions
Returns:
An int that specifies the number of lines per page.

getCharactersPerInch

public int getCharactersPerInch()
Description copied from interface: ITextExportFormatOptions

Gets the number of characters per inch.

Specified by:
getCharactersPerInch in interface ITextExportFormatOptions
Returns:
An int that specifies the number of characters per inch.

setCharactersPerInch

public void setCharactersPerInch(int CharactersPerInch)
Description copied from interface: ITextExportFormatOptions

Sets the number of characters per inch.

Specified by:
setCharactersPerInch in interface ITextExportFormatOptions
Parameters:
CharactersPerInch - An int that specifies the number of characters per inch.

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

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,
                                     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.


hasContent

public boolean hasContent(java.lang.Object obj)

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

startElement

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

For internal use only.