net.windward.xmlreport

Interface ProcessRtfAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessRtf

public interface ProcessRtfAPI
extends ProcessReportAPI

This class is a subclass of ProcessReportAPI specifically for creating an output in the rtf format.

Version:

2.0 2 January 2004

Field Summary

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Method Summary

Modifier and Type	Method and Description
int	getReportType() Get the report format of the output stream.
boolean	isCopyAllTags() Get if unknown rtf tags should be copied to the report.
boolean	isExtraPict() Get if writes each image twice.
void	setCopyAllTags(boolean copyAllTags) Set copy unknown tags mode on or off.
void	setExtraPict(boolean writeTwice) Set if writes each image twice.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, duplicate, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getNumPages, getOutputBuilderData, getParameters, getRenderExtent, getRenderPages, getReport, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, isCopyEmbeddedObjects, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLocale, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Method Detail

getReportType

int getReportType()

Get the report format of the output stream.

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

The type (format) of the output report. Will be TYP_RTF.

setCopyAllTags

void setCopyAllTags(boolean copyAllTags)

Set copy unknown tags mode on or off. If the copy mode is on, all rtf tags that are understood but not processed will be copied to the report. This will not copy tags that are not understood (or that are understood but cannot be copied stand-alone).

Parameters:

copyAllTags - Set to true to copy unknown tags.

isCopyAllTags

boolean isCopyAllTags()

Get if unknown rtf tags should be copied to the report.

Returns:

true if the unknown tags should be copied.

isExtraPict

boolean isExtraPict()

Get if writes each image twice. The second time is the image that WordPad uses. Turning this on makes files a lot bigger.

Returns:

true if writes the second image copy.

setExtraPict

void setExtraPict(boolean writeTwice)

Set if writes each image twice. The second time is the image that WordPad uses. Turning this on makes files a lot bigger.

Parameters:

writeTwice - true to writes the second image copy.