com.stimulsoft.report.export.settings
Class StiRtfExportSettings

java.lang.Object
  extended by com.stimulsoft.report.export.settings.StiExportSettings
      extended by com.stimulsoft.report.export.settings.StiPageRangeExportSettings
          extended by com.stimulsoft.report.export.settings.StiRtfExportSettings

public class StiRtfExportSettings
extends StiPageRangeExportSettings

RTF format export settings Copyright Stimulsoft


Constructor Summary
StiRtfExportSettings()
           
StiRtfExportSettings(StiExportSettings settings)
           
 
Method Summary
 int getCodePage()
          Gets code page of RTF file.
 StiExportFormat getExportFormat()
          Export format
 StiRtfExportMode getExportMode()
          Gets mode of RTF file creation.
 float getImageQuality()
          Gets image quality of images which will be exported to result file.
 float getImageResolution()
          Gets image resolution of images which will be exported to result file.
 boolean isRemoveEmptySpaceAtBottom()
          Gets a value indicating whether it is necessary to remove empty space at the bottom of the page
 boolean isStoreImagesAsPng()
          A value indicating whether it is necessary to store images in Png format
 boolean isUsePageHeadersAndFooters()
          Gets value which enables special mode of exporting page headers and page footers into result file.
 void setCodePage(int codePage)
          Sets code page of RTF file.
 void setExportMode(StiRtfExportMode exportMode)
          Sets mode of RTF file creation.
 void setImageQuality(float imageQuality)
          Sets image quality of images which will be exported to result file.
 void setImageResolution(float imageResolution)
          Sets image resolution of images which will be exported to result file.
 void setRemoveEmptySpaceAtBottom(boolean removeEmptySpaceAtBottom)
          Sets a value indicating whether it is necessary to remove empty space at the bottom of the page
 void setStoreImagesAsPng(boolean storeImagesAsPng)
          A value indicating whether it is necessary to store images in Png format
 void setUsePageHeadersAndFooters(boolean usePageHeadersAndFooters)
          Sets value which enables special mode of exporting page headers and page footers into result file.
 
Methods inherited from class com.stimulsoft.report.export.settings.StiPageRangeExportSettings
getPageRange, isOpenAfterExport, isSendEmail, setExportFormat, setOpenAfterExport, setPageRange, setSendEmail
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StiRtfExportSettings

public StiRtfExportSettings(StiExportSettings settings)

StiRtfExportSettings

public StiRtfExportSettings()
Method Detail

getExportFormat

public StiExportFormat getExportFormat()
Export format

Overrides:
getExportFormat in class StiPageRangeExportSettings
Returns:
the exportFormat

getCodePage

public int getCodePage()
Gets code page of RTF file.

Returns:
the codePage

setCodePage

public void setCodePage(int codePage)
Sets code page of RTF file.

Parameters:
codePage - the codePage to set

getExportMode

public StiRtfExportMode getExportMode()
Gets mode of RTF file creation.

Returns:
the exportMode

setExportMode

public void setExportMode(StiRtfExportMode exportMode)
Sets mode of RTF file creation.

Parameters:
exportMode - the exportMode to set

isUsePageHeadersAndFooters

public boolean isUsePageHeadersAndFooters()
Gets value which enables special mode of exporting page headers and page footers into result file. In this mode export engine try to insert all page headers and footers as RTF headers and footers.

Returns:
the usePageHeadersAndFooters

setUsePageHeadersAndFooters

public void setUsePageHeadersAndFooters(boolean usePageHeadersAndFooters)
Sets value which enables special mode of exporting page headers and page footers into result file. In this mode export engine try to insert all page headers and footers as RTF headers and footers.

Parameters:
usePageHeadersAndFooters - the usePageHeadersAndFooters to set

getImageQuality

public float getImageQuality()
Gets image quality of images which will be exported to result file.

Returns:
the imageQuality

setImageQuality

public void setImageQuality(float imageQuality)
Sets image quality of images which will be exported to result file.

Parameters:
imageQuality - the imageQuality to set

getImageResolution

public float getImageResolution()
Gets image resolution of images which will be exported to result file.

Returns:
the imageResolution

setImageResolution

public void setImageResolution(float imageResolution)
Sets image resolution of images which will be exported to result file.

Parameters:
imageResolution - the imageResolution to set

isRemoveEmptySpaceAtBottom

public boolean isRemoveEmptySpaceAtBottom()
Gets a value indicating whether it is necessary to remove empty space at the bottom of the page

Returns:
the removeEmptySpaceAtBottom

setRemoveEmptySpaceAtBottom

public void setRemoveEmptySpaceAtBottom(boolean removeEmptySpaceAtBottom)
Sets a value indicating whether it is necessary to remove empty space at the bottom of the page

Parameters:
removeEmptySpaceAtBottom - the removeEmptySpaceAtBottom to set

isStoreImagesAsPng

public boolean isStoreImagesAsPng()
A value indicating whether it is necessary to store images in Png format

Returns:
the storeImagesAsPng

setStoreImagesAsPng

public void setStoreImagesAsPng(boolean storeImagesAsPng)
A value indicating whether it is necessary to store images in Png format

Parameters:
storeImagesAsPng - the storeImagesAsPng to set