net.windward.xmlreport

Interface ProcessTxtAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessTxt

public interface ProcessTxtAPI
extends ProcessReportAPI

This class is a subclass of ProcessReportAPI specifically for creating an output in the ASCII text 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
java.lang.String	getFont() Get the font used when formatting txt output.
int	getFontSize() Get the font size used when formatting txt output.
int	getReportType() Get the report format of the output stream.
boolean	isBreakPage() Returns true if a Ctrl-L is in the report for each page break.
boolean	isShowHeaders() Returns true if the header and footers are printed in the report.
boolean	isUseMargins() If true, then the left page margin will be included in the output, creating leading spaces for each line.
boolean	isUseSoftEoln() If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line.
void	setBreakPage(boolean breakPage) Set true if a Ctrl-L is in the report for each page break.
void	setFont(java.lang.String font) Set the font used when formatting txt output.
void	setFontSize(int twips) Set the font size used when formatting txt output.
void	setShowHeaders(boolean showHeaders) Set if the header and footers are printed in the report.
void	setUseMargins(boolean useThem) If true, then the left page margin will be included in the output, creating leading spaces for each line.
void	setUseSoftEoln(boolean useThem) If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line.

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

isUseMargins

boolean isUseMargins()

If true, then the left page margin will be included in the output, creating leading spaces for each line. If false, the page margins will be ignored and any paragraph with no left indent will start at the begining of a line. The default is false.

Returns:

True if it will include the page margins, false otherwise.

setUseMargins

void setUseMargins(boolean useThem)

If true, then the left page margin will be included in the output, creating leading spaces for each line. If false, the page margins will be ignored and any paragraph with no left indent will start at the begining of a line. The default is false.

Parameters:

useThem - Set to true to include the page margins, false otherwise.

isUseSoftEoln

boolean isUseSoftEoln()

If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line. If false then all paragraphs will be placed on a single line of output. The default is true.

Returns:

True if it will include the page margins, false otherwise.

setUseSoftEoln

void setUseSoftEoln(boolean useThem)

If true, then then soft line breaks will be inserted and paragraphs will wrap to the next line. If false then all paragraphs will be placed on a single line of output. The default is true.

Parameters:

useThem - Set to true to line wrap paragraphs, false otherwise.

isShowHeaders

boolean isShowHeaders()

Returns true if the header and footers are printed in the report. False and they will not be printed. The default is false.

Returns:

true if the headers and footers are printed in the final report.

setShowHeaders

void setShowHeaders(boolean showHeaders)

Set if the header and footers are printed in the report. True to print and false and they will not be printed. The default is false.

Parameters:

showHeaders - true if the headers and footers are printed in the final report.

isBreakPage

boolean isBreakPage()

Returns true if a Ctrl-L is in the report for each page break. The default is false.

Returns:

true if a Ctrl-L is in the report for each page break.

setBreakPage

void setBreakPage(boolean breakPage)

Set true if a Ctrl-L is in the report for each page break. The default is false.

Parameters:

breakPage - true if a Ctrl-L is in the report for each page break.

getFont

java.lang.String getFont()

Get the font used when formatting txt output. The default is Courier.

Returns:

The name of the font used to format txt output.

setFont

void setFont(java.lang.String font)

Set the font used when formatting txt output. The default is Courier.

Parameters:

font - The name of the font used to format txt output.

getFontSize

int getFontSize()

Get the font size used when formatting txt output. This is set in TWIPS or 20ths of a point. So a value of 240 (the default) is 12 points.

Returns:

The size of the font used to format txt output in twips.

setFontSize

void setFontSize(int twips)

Set the font size used when formatting txt output. This is set in TWIPS or 20ths of a point. So a value of 240 (the default) is 12 points.

Parameters:

twips - The size of the font used to format txt output in twips.