ReportProperties (Windward Studios 21.2 API)

java.lang.Object
- PropertiesBase
- - net.windward.xmlreport.ReportProperties

```
public class ReportProperties
extends PropertiesBase
```
Collection of per report properties.
An instance of this object provides access to values stored in the properties file. Each report object maintains its own set of properties. So, it is possible to use properties in the WindwardReports.properties file as global defaults and override them as needed per report.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ASIAN_SUPPORT` Sets if the server has asian fonts available for output.
`static java.lang.String`	`BASE_DIRECTORY` Set the base directory used for imported filesyss that have a relative path.
`static java.lang.String`	`CHECK_FOR_GLYPH_FONTNAMES` The list of fonts to consider when the specified font does not have the glyphs needed.
`static java.lang.String`	`CHECK_FOR_GLYPHS` Checks the font specified for text from an out tag and changes the font if it does not have glyphs for some of the text.
`static java.lang.String`	`CHECK_FOR_OLE_IMAGES` If true will check all images brought in via the out tag for an OLE header (used in Northwind & Access databases) and will strip it off.
`static java.lang.String`	`CSV_CELL_SEPARATOR` The character used to seperate cells.
`static java.lang.String`	`CSV_NEWLINE` The string used to create a newline.
`static java.lang.String`	`CSV_QUOTE_CHAR` The character used to quote a cell.
`static java.lang.String`	`CSV_TRIM_WHITESPACE` Set to "true" if cells should have whitespace trimmed from beginning and end.
`static java.lang.String`	`DEFAULT_CHART_DPI` When charts are rendered, they are rendered at this resolution.
`static java.lang.String`	`DEFAULT_DRAWING_DPI` When rendering a drawing (Shape or SmartArt) or the output format is a bitmap, it is done at this resolution.
`static java.lang.String`	`DEFAULT_IMAGE_DPI` If a bitmap does not have it's DPI set, this is the value used.
`static java.lang.String`	`EXPAND_OUT_TEXT` What the engine will do when it has a CR or TAB in the text returned by an out tag.
`static java.lang.String`	`FORCE_BITMAP_FORMAT` This will force all bitmaps in the created report to be of the requested format.
`static java.lang.String`	`HIDE_CHART_WORKSHEET_DATA` Every chart object in DOCX, PPTX, & XLSX output has an Excel worksheet behind it with the data.
`static java.lang.String`	`HTML_CSS_FILENAME` Set to the CSS filename if the CSS file is distinct (note part of the html body.
`static java.lang.String`	`HTML_CSS_TYPE` Sets if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists).
`static java.lang.String`	`HTML_EMBED_IMAGES` Set to "true" to have the engine to embed all images in the HTML file instead of using separate image files.
`static java.lang.String`	`HTML_FULL_FILE` The report can be generated as either a complete html file, or as just the body.
`static java.lang.String`	`HTML_SET_XHTML` Set to "true" to create a HTML file that conforms to the XHTML spec.
`static java.lang.String`	`HTML_SPLIT_PAGES` Set to "true" to have the engine to split HTML output into multiple documents, one for each page of the document.
`static java.lang.String`	`IGNORE_TAG_COLORS` If true then do not add color formatting before tags (if it is the tag's color).
`static java.lang.String`	`IMAGE_DPI` The Dots Per Inch to render the bitmaps at.
`static java.lang.String`	`IMAGE_FORMAT` The format to render in for ProcessImage.
`static java.lang.String`	`IMPORT_USE_CHILD_STYLES` When an imported template's style settings don't match the master document this determines if default settings in the imported document will match the imported style (true) or the master style (false).
`static java.lang.String`	`LAYOUT_DOCUMENT` If set to "off", then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report.
`static java.lang.String`	`OFFICE_VERSION` The template will be parsed using the default values for that version of Word.
`static java.lang.String`	`OPENXML_COPY_DRAWINGS` Set to "true" if drawings are to be copied to output, set to "false" to drop them.
`static java.lang.String`	`OPENXML_COPY_METADATA` Set if the Windward metadata will be copied to the generated report.
`static java.lang.String`	`OPENXML_COPY_SHAPES` Set to "true" if shapes are to be copied to output, set to "false" to drop them.
`static java.lang.String`	`OPENXML_RECALCULATE` Set to "true" if the generated document is to perform recalculation when first opened.
`static java.lang.String`	`OUTPUT_BUILDER` The class to load and call to generate output for the engine.
`static java.lang.String`	`PDF_ARCHIVE` Set to "true" to build a PDF/A-1b file.
`static java.lang.String`	`PDF_COMPRESSION_LEVEL` et the compression level.
`static java.lang.String`	`PDF_FONT_LEVEL` Set the font level.
`static java.lang.String`	`PDF_KEY_LENGTH` The password licenseKey length.
`static java.lang.String`	`PDF_OWNER_PASSWORD` The owner password for the PDF generated report.
`static java.lang.String`	`PDF_RGB_TRANSPARENCY_BLENDING_SPACE` Set to false to turn of using the RGB space for image color blending in the PDF.
`static java.lang.String`	`PDF_SECURITY` The security for the PDF generated report.
`static java.lang.String`	`PDF_USER_PASSWORD` The user password for the PDF generated report.
`static java.lang.String`	`PDF_VERSION` the PDF version number used to create the file.
`static java.lang.String`	`REPORT_CHARSET` Html and txt files are generated using a charset (the rest use unicode).
`static java.lang.String`	`REPORT_DESCRIPTION` Written to the description for output formats that have this meta key.
`static java.lang.String`	`REPORT_HIDDEN_MODE` Set to select what hidden parts of a spreadsheet, if any, to render in the output.
`static java.lang.String`	`REPORT_HYPHENATE` Sets if hyphenation is to be used in rendered output.
`static java.lang.String`	`REPORT_KEYWORDS` The keywords of the document.
`static java.lang.String`	`REPORT_LOCALE` This call returns the locale used in creating a report for output other than Asian & bi-directional.
`static java.lang.String`	`REPORT_LOCALE_ASIAN` This call returns the locale used in creating a report for Asian output.
`static java.lang.String`	`REPORT_LOCALE_BIDI` This call returns the locale used in creating a report for bi-directional output.
`static java.lang.String`	`REPORT_MODE_PROCESS_EMBEDDED` What to do processing embedded objects.
`static java.lang.String`	`REPORT_REMOVE_UNUSED_FORMATS` Set to "true" if unused styles, fonts, etc.
`static java.lang.String`	`REPORT_RENDER_EXTENT` How the generated report will be cropped.
`static java.lang.String`	`REPORT_RENDER_PAGES` The pages that will be generated.
`static java.lang.String`	`REPORT_SUBJECT` The subject of the document.
`static java.lang.String`	`REPORT_TEMPLATE_VERSION` The verion of Windward/AutoTag this template was created for.
`static java.lang.String`	`REPORT_TITLE` The title of the document.
`static java.lang.String`	`REPORT_TRACK_IMPORTS` Set to "true" if you want to call getImports after processing datasources.
`static java.lang.String`	`REPORT_TRIM` Sets if the end of the generated document should be trimmed.
`static java.lang.String`	`REPORT_WRITE_FIELDS_AS_FIELDS` If true DOCX form fields and content controls are written to PDF and HTML reports as form fields.
`static java.lang.String`	`RESULT_SET_TYPE` Set the ResultSet type for JDBC (Java engine) result queries.
`static java.lang.String`	`RTF_COPY_UNKNOWN` Set copy unknown tags mode on or off.
`static java.lang.String`	`RTF_EXTRA_PICT` Sets if the engine writes each image twice.
`static java.lang.String`	`SQL_PARAMETERS` Sets the DataSourceProvider the parameter substitution mode.
`static java.lang.String`	`SQL_SMART_QUOTE` set to "true" to have a '${var}' will be changed to ? instead of the regular action of '?' (surrounded with quotes).
`static java.lang.String`	`TRIM_TABLES` When set, for XLSX templates, it will remove empty rows at the bottom of the table and empty columns on the right side of rows.
`static java.lang.String`	`TXT_BREAK_PAGE` Set to "true" for a Ctrl-L to be written to the report for each page break.
`static java.lang.String`	`TXT_FONT_NAME` Set the font used when formatting txt output.
`static java.lang.String`	`TXT_FONT_SIZE_TWIPS` Set the font size used when formatting txt output.
`static java.lang.String`	`TXT_USE_SOFT_EOLN` Set if soft line breaks will be inserted and paragraphs will wrap to the next line.
`static java.lang.String`	`USE_BIG_DECIMAL` Sets if the system should use BigDecimal/BigInteger when calculating values in equations.
`static java.lang.String`	`USE_EXTERNAL_OUTPUT_BUILDER` Set to "on" to use the external output builder if one is loaded for the output format.
`static java.lang.String`	`USE_PARENT_FORMAT` This is the default value for the Import tag use.parent.format property.
`static java.lang.String`	`WRITE_TAGS` When writing tags to a report (when the datasource for a tag was not applied) it will write the tags in the following format.

Constructor Summary

Constructors
Constructor and Description

ReportProperties()
No-arg constructor.

ReportProperties(ReportProperties src)
Copy constructor.

Constructors
Constructor and Description
`ReportProperties()` No-arg constructor.
`ReportProperties(ReportProperties src)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getApiInt(java.lang.String name)` Used to convert a property's value to the old API int value.
`boolean`	`isSet(java.lang.String name)` Tests if a property was set, either explicitly or via the properties file.
`void`	`set(java.lang.String name, boolean value)` A convenient way of setting boolean values.
`void`	`set(java.lang.String name, char value)` A convenient way of setting character values.
`void`	`set(java.lang.String name, int value)` A convenient way of setting integer values.
`void`	`set(java.lang.String name, java.lang.String value)` Sets a value for the given property.
`void`	`setApiInt(java.lang.String name, int num)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ASIAN_SUPPORT
```
public static final java.lang.String ASIAN_SUPPORT
```
    Sets if the server has asian fonts available for output. Allowable values are "on" (the server has Asian fonts installed) and "off (Asian fonts are not installed). Default is "on".
    
    See Also:
    
    Constant Field Values
  - BASE_DIRECTORY
```
public static final java.lang.String BASE_DIRECTORY
```
    Set the base directory used for imported filesyss that have a relative path. The default is "". This needs to be a valid rooted full path to a directory.
    
    See Also:
    
    Constant Field Values
  - CHECK_FOR_GLYPHS
```
public static final java.lang.String CHECK_FOR_GLYPHS
```
    Checks the font specified for text from an out tag and changes the font if it does not have glyphs for some of the text. Allowed values are "on" (performs the check) and "off" (does not perform the check). The default is "on".
    
    See Also:
    
    Constant Field Values
  - CHECK_FOR_GLYPH_FONTNAMES
```
public static final java.lang.String CHECK_FOR_GLYPH_FONTNAMES
```
    The list of fonts to consider when the specified font does not have the glyphs needed. Will use the font with the largest number of needed glyphs. If a tie in the number, will use the earlier one in the list. Set to any number of fontnames, seperated by a ;. The default is "". If there is no set value, then an O/S specific list will be used (but will not be returned on a get for this property. For Windows 10 that list is "Yu Gothic;SimSun;MingLiU-ExtB;Malgun Gothic;Lucida Sans Unicode;".
    
    See Also:
    
    Constant Field Values
  - CHECK_FOR_OLE_IMAGES
```
public static final java.lang.String CHECK_FOR_OLE_IMAGES
```
    If true will check all images brought in via the out tag for an OLE header (used in Northwind & Access databases) and will strip it off. Allowable values are "on" (check for OLE headers) and "off (do not check). Default is "on".
    
    See Also:
    
    Constant Field Values
  - CSV_CELL_SEPARATOR
```
public static final java.lang.String CSV_CELL_SEPARATOR
```
    The character used to seperate cells. The default is a ,
    
    See Also:
    
    Constant Field Values
  - CSV_NEWLINE
```
public static final java.lang.String CSV_NEWLINE
```
    The string used to create a newline. The default is "\r\n".
    
    See Also:
    
    Constant Field Values
  - CSV_QUOTE_CHAR
```
public static final java.lang.String CSV_QUOTE_CHAR
```
    The character used to quote a cell. The default is "
    
    See Also:
    
    Constant Field Values
  - CSV_TRIM_WHITESPACE
```
public static final java.lang.String CSV_TRIM_WHITESPACE
```
    Set to "true" if cells should have whitespace trimmed from beginning and end. The default is "false".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHART_DPI
```
public static final java.lang.String DEFAULT_CHART_DPI
```
    When charts are rendered, they are rendered at this resolution. Can be set to values from 72 to 48,000. The default is 300 (and may be changed).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DRAWING_DPI
```
public static final java.lang.String DEFAULT_DRAWING_DPI
```
    When rendering a drawing (Shape or SmartArt) or the output format is a bitmap, it is done at this resolution. Can be set to values from 72 to 48,000. The default is 600 (and may be changed).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IMAGE_DPI
```
public static final java.lang.String DEFAULT_IMAGE_DPI
```
    If a bitmap does not have it's DPI set, this is the value used. Can be set to values from 72 to 48,000. The default is 96 (and may be changed).
    
    See Also:
    
    Constant Field Values
  - EXPAND_OUT_TEXT
```
public static final java.lang.String EXPAND_OUT_TEXT
```
    What the engine will do when it has a CR or TAB in the text returned by an out tag. Allowed values are "ignore" (leave it as is in the text), "newline" (replace it with a <br/>) & "paragraph" (replace it with a <p/>). The tab is replaced for "newline" and "paragraph" with an actual tab. The default value is "paragraph".
    
    See Also:
    
    Constant Field Values
  - FORCE_BITMAP_FORMAT
```
public static final java.lang.String FORCE_BITMAP_FORMAT
```
    This will force all bitmaps in the created report to be of the requested format. Options are "", "bmp", "gif", "jpeg", "png", & "tiff". The default is "" which is no conversion.
    
    See Also:
    
    Constant Field Values
  - REPORT_RENDER_EXTENT
```
public static final java.lang.String REPORT_RENDER_EXTENT
```
    How the generated report will be cropped. Allowed values are: "" (the extent will be the entire document, nothing is cropped), or any combination of "margins" (the margins will be cropped, even if that removes content), "header.and.footer" (The header and footer will not be rendered. This does not crop the header/footer area), and/or "content" (The smallest rectangle for each page that does not crop content. Each page can be a different size). To crop at the max set to "margins;header.and.footer;content". This is presently only supported by ProcessImage and ProcessTxt.The default is "e".
    
    See Also:
    
    Constant Field Values
  - REPORT_RENDER_PAGES
```
public static final java.lang.String REPORT_RENDER_PAGES
```
    The pages that will be generated. String is in the form "1, 4, 6-11, 15" The numbers most be increasing with no overlap. A value of "" means render all pages. This is presently only supported by ProcessImage and ProcessTxt.The default is "".
    
    See Also:
    
    Constant Field Values
  - HIDE_CHART_WORKSHEET_DATA
```
public static final java.lang.String HIDE_CHART_WORKSHEET_DATA
```
    Every chart object in DOCX, PPTX, & XLSX output has an Excel worksheet behind it with the data. Set this to "true" to hide the worksheet and to "false" to show the worksheet. The default value is "true".
    
    See Also:
    
    Constant Field Values
  - HTML_CSS_FILENAME
```
public static final java.lang.String HTML_CSS_FILENAME
```
    Set to the CSS filename if the CSS file is distinct (note part of the html body. Set to "" if the CSS file is a component in the html body. This is set for both the case of the engine creating a CSS file and for the engine using an existing CSS file. Default is "".
    
    See Also:
    
    Constant Field Values
  - HTML_CSS_TYPE
```
public static final java.lang.String HTML_CSS_TYPE
```
    Sets if the css information will be written to a separate file, as part of the html file, or skipped (because the file already exists). Allowed values are: "no" (no css), "include" (write the css contents to the output (html) file), "separate" (write the css contents to the css stream), & "exists" (assume they have the css file already, don't write it). The default is "include".
    
    See Also:
    
    Constant Field Values
  - HTML_EMBED_IMAGES
```
public static final java.lang.String HTML_EMBED_IMAGES
```
    Set to "true" to have the engine to embed all images in the HTML file instead of using separate image files. Set to "false" to have images written out as distinct files. More information found on Wikipedia: http://en.wikipedia.org/wiki/Data_URI_scheme Default is "true".
    
    See Also:
    
    Constant Field Values
  - HTML_FULL_FILE
```
public static final java.lang.String HTML_FULL_FILE
```
    The report can be generated as either a complete html file, or as just the body. If it is set to "true" (full file), the report will have everything from <html> to </html>. If set to "false", it will be a body, and can be included with additional html as just part of the body of a final html file. In this case the returned stream must be placed inside a <body>...</body>. Default is "true".
    
    See Also:
    
    Constant Field Values
  - HTML_SET_XHTML
```
public static final java.lang.String HTML_SET_XHTML
```
    Set to "true" to create a HTML file that conforms to the XHTML spec. Set to "false" for standard HTMl. Default is "false".
    
    See Also:
    
    Constant Field Values
  - HTML_SPLIT_PAGES
```
public static final java.lang.String HTML_SPLIT_PAGES
```
    Set to "true" to have the engine to split HTML output into multiple documents, one for each page of the document. Set to "false" to have it create a single output file. Default is "false".
    
    See Also:
    
    Constant Field Values
  - IGNORE_TAG_COLORS
```
public static final java.lang.String IGNORE_TAG_COLORS
```
    If true then do not add color formatting before tags (if it is the tag's color). Allowed values are "on" (do not add colors) and "off" (add colors). Default is "off"
    
    See Also:
    
    Constant Field Values
  - IMAGE_FORMAT
```
public static final java.lang.String IMAGE_FORMAT
```
    The format to render in for ProcessImage. Allowed values are: "bmp", "emf", "emz", "eps", "gif", "jpg", "png", "svg", "tif", "wmf", or "wmz". The default is "png".
    
    See Also:
    
    Constant Field Values
  - IMAGE_DPI
```
public static final java.lang.String IMAGE_DPI
```
    The Dots Per Inch to render the bitmaps at. Ignored for SVG. The default is 300 and can be increased without notice.
    
    See Also:
    
    Constant Field Values
  - IMPORT_USE_CHILD_STYLES
```
public static final java.lang.String IMPORT_USE_CHILD_STYLES
```
    When an imported template's style settings don't match the master document this determines if default settings in the imported document will match the imported style (true) or the master style (false). Default is "true".
    
    See Also:
    
    Constant Field Values
  - LAYOUT_DOCUMENT
```
public static final java.lang.String LAYOUT_DOCUMENT
```
    If set to "off", then for output we do not have to layout (DOCX, XLSX, PPTX, HTML in non-pages mode), the engine will not perform layout on the generated report. In this case the ProcessReport.getNumPages() will return an undefined value (usually 0) and any fields in DOCX that depend on page, section, num pages, etc. numbers will be wrong and the fields will need to be updated. The advantage of turning this off is document production will be faster. This setting is ignored for formats we need to layout (PDF, printer, text, etc.). The default is "on".
    
    See Also:
    
    Constant Field Values
  - OFFICE_VERSION
```
public static final java.lang.String OFFICE_VERSION
```
    The template will be parsed using the default values for that version of Word. Allowed values are "2007", "2010", "2013", & "2016". The default value is "2016" (and will increase when Microsoft releases a new version).
    
    See Also:
    
    Constant Field Values
  - OPENXML_COPY_DRAWINGS
```
public static final java.lang.String OPENXML_COPY_DRAWINGS
```
    Set to "true" if drawings are to be copied to output, set to "false" to drop them. Drawings are only copied for DOCX -> DOCX, PPTX -> PPTX (soon), and XLSX -> XLSX. Default is "true".
    
    See Also:
    
    Constant Field Values
  - OPENXML_COPY_METADATA
```
public static final java.lang.String OPENXML_COPY_METADATA
```
    Set if the Windward metadata will be copied to the generated report. This can only occur if the template and generated report are both the same type of OpenXML files. Allowed values are "no" (don't copy), "no-datasource" (copy if no datasources are applied), & "yes" (copy it). Default is "no-datasource".
    
    See Also:
    
    Constant Field Values
  - OPENXML_COPY_SHAPES
```
public static final java.lang.String OPENXML_COPY_SHAPES
```
    Set to "true" if shapes are to be copied to output, set to "false" to drop them. Shapes are only copied for DOCX -> DOCX, PPTX -> PPTX (soon), and XLSX -> XLSX. Default is "true".
    
    See Also:
    
    Constant Field Values
  - OPENXML_RECALCULATE
```
public static final java.lang.String OPENXML_RECALCULATE
```
    Set to "true" if the generated document is to perform recalculation when first opened. Presently only implemented for DOCX and XLSX. Default is "false".
    
    See Also:
    
    Constant Field Values
  - OUTPUT_BUILDER
```
public static final java.lang.String OUTPUT_BUILDER
```
    The class to load and call to generate output for the engine. Must implement IOutputBuilderEngine. Default is "".
    
    See Also:
    
    Constant Field Values
  - PDF_ARCHIVE
```
public static final java.lang.String PDF_ARCHIVE
```
    Set to "true" to build a PDF/A-1b file. This will force all fonts to be embedded. Set to "false" for standard PDF. Default is "false";
    
    See Also:
    
    Constant Field Values
  - PDF_COMPRESSION_LEVEL
```
public static final java.lang.String PDF_COMPRESSION_LEVEL
```
    et the compression level. Basically a higher compression level means a smaller final pdf file - but also a longer processing time. Allowed values are: "none" (don't use this), "fast" (will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size), or "maximum" (will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file). Default is "fast".
    
    See Also:
    
    Constant Field Values
  - PDF_FONT_LEVEL
```
public static final java.lang.String PDF_FONT_LEVEL
```
    Set the font level. A higher font level means a more accurate final pdf but also a large one. The allowed values are: "internal" (Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts), "specified" (Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file), or "embed" (Will use the font specified in the template and will embed the font in the pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger). The default is "embed".
    
    See Also:
    
    Constant Field Values
  - PDF_KEY_LENGTH
```
public static final java.lang.String PDF_KEY_LENGTH
```
    The password licenseKey length. Allowed values are "40" or "128". Default is "128".
    
    See Also:
    
    Constant Field Values
  - PDF_OWNER_PASSWORD
```
public static final java.lang.String PDF_OWNER_PASSWORD
```
    The owner password for the PDF generated report. Set to "" for no password. The default is "".
    
    See Also:
    
    Constant Field Values
  - PDF_RGB_TRANSPARENCY_BLENDING_SPACE
```
public static final java.lang.String PDF_RGB_TRANSPARENCY_BLENDING_SPACE
```
    Set to false to turn of using the RGB space for image color blending in the PDF. The default is true.
    
    See Also:
    
    Constant Field Values
  - PDF_SECURITY
```
public static final java.lang.String PDF_SECURITY
```
    The security for the PDF generated report. Allowed values can be any combination of: "none" (allow nothing), "assembly" (allow assembly of the pdf report), "copy" (allow copy (cut & paste) of the pdf report), "degraded-printing" (allow degraded printing of the pdf report), "fill-in" (allow fill-in of the pdf report), "mod-annotations" (allow modifications of annotations in the pdf report), "mod-contents" (allow modification of contents in the pdf report), "printing" (allow printing the pdf report), and/or "screen-readers" (allow screen capture of the pdf report). The default is "" (allow everything).
    
    See Also:
    
    Constant Field Values
  - PDF_USER_PASSWORD
```
public static final java.lang.String PDF_USER_PASSWORD
```
    The user password for the PDF generated report. Set to "" for no password. The default is "".
    
    See Also:
    
    Constant Field Values
  - PDF_VERSION
```
public static final java.lang.String PDF_VERSION
```
    the PDF version number used to create the file. Allowed values are: "1.2" ... "1.7". The default value is "1.4".
    
    See Also:
    
    Constant Field Values
  - REPORT_CHARSET
```
public static final java.lang.String REPORT_CHARSET
```
    Html and txt files are generated using a charset (the rest use unicode). Normally html files are generated using utf-8 (unicode). Txt files are normally generated using the native charset. The native charset is not the java native charset, it is the default charset set in the template. This setting allows you to force to charset the report is written in. The passed in value is the Windows codepage (Western Europe is 1252). This has nothing to do with reading in the template, it only affects the charset the output report is written in. This also has special values of "1" (default), & "2" (unicode). It used to also have "3" but that was for RTF templates which are no longer supported. Default value is "1".
    
    See Also:
    
    Constant Field Values
  - REPORT_DESCRIPTION
```
public static final java.lang.String REPORT_DESCRIPTION
```
    Written to the description for output formats that have this meta key. Also written as the document description in Hub listing of generated documents.
    
    See Also:
    
    Constant Field Values
  - REPORT_HIDDEN_MODE
```
public static final java.lang.String REPORT_HIDDEN_MODE
```
    Set to select what hidden parts of a spreadsheet, if any, to render in the output. Allowable values are flags that turn on displaying parts: "" (none), "no-print" (include worksheets set to not print in the output), "hidden-sheets" (include worksheets set to hidden in the output. This will not include the WR_DATA (Windward metadata) sheet, "all-rows-columns" (include hidden rows and columns in a worksheet), & "ignore-print-range" (ignore the print area set in the XLSX file. (ie, print the whole sheet.). Default is "".
    
    See Also:
    
    Constant Field Values
  - REPORT_HYPHENATE
```
public static final java.lang.String REPORT_HYPHENATE
```
    Sets if hyphenation is to be used in rendered output. Allowable settings are: "off" (do not hyphenate), "template" (hyphenate if turned on in template), & "on" (hyphenate the document). The default is "template".
    
    See Also:
    
    Constant Field Values
  - REPORT_KEYWORDS
```
public static final java.lang.String REPORT_KEYWORDS
```
    The keywords of the document. This are delimited by a ','. In html this will set the keywords meta-tag.
    
    See Also:
    
    Constant Field Values
  - REPORT_LOCALE
```
public static final java.lang.String REPORT_LOCALE
```
    This call returns the locale used in creating a report for output other than Asian & bi-directional. This method should not be called until after the report template has been parsed.. This is used by; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>. This will return "" if set to LOCALE_DEFAULT until after the template has been parsed. Once the template has been parsed it will return the locale of the template in that case.
    This is stored as the IETF BCP 47 representation of the locale. For the U.S. this is "en-US".
    
    See Also:
    
    Constant Field Values
  - REPORT_LOCALE_ASIAN
```
public static final java.lang.String REPORT_LOCALE_ASIAN
```
    This call returns the locale used in creating a report for Asian output. This method should not be called until after the report template has been parsed.. This is used by; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>. This will return "" if set to LOCALE_DEFAULT until after the template has been parsed. Once the template has been parsed it will return the locale of the template in that case.
    This is stored as the IETF BCP 47 representation of the locale. For the U.S. this is "en-US".
    
    See Also:
    
    Constant Field Values
  - REPORT_LOCALE_BIDI
```
public static final java.lang.String REPORT_LOCALE_BIDI
```
    This call returns the locale used in creating a report for bi-directional output. This method should not be called until after the report template has been parsed.. This is used by; 1) The output report locale for html and rtf reports, 2) The charset used for txt reports, 3) The rules used for soft line breaks (this mostly affects Thai), and 4) the locale used for <wr:out>. This will return "" if set to LOCALE_DEFAULT until after the template has been parsed. Once the template has been parsed it will return the locale of the template in that case.
    This is stored as the IETF BCP 47 representation of the locale. For the U.S. this is "en-US".
    
    See Also:
    
    Constant Field Values
  - REPORT_MODE_PROCESS_EMBEDDED
```
public static final java.lang.String REPORT_MODE_PROCESS_EMBEDDED
```
    What to do processing embedded objects. Writing an embedded object to the generated report can only be done for the case of DOCX -> DOCX and XLSX -> XLSX(and in the future, PPTX -> PPTX). But for any other case, the screenshot of the object can be written(except TXT and CSV obviously). So these settings are valid for all combinations, but implemented in the context of object -> bitmap. Allowed values are: "drop" (drop embedded objects, they are not included in the output), "copy" (copy embedded objects across as is), "if-data-applied" (process an embedded object applying the parent template datasources and variables. If any tags were processed write out the generated object and screenshot. If no tags were processed, copy across the embedded object as is), "always" (always process an embedded object and write out the generated object & screenshot, even if no tags were processed), & "keep-original-screenshot" (same as "if-data-applied" but the object is not re-rendered for a new screenshot. The default is "if-data-applied".
    
    See Also:
    
    Constant Field Values
  - REPORT_REMOVE_UNUSED_FORMATS
```
public static final java.lang.String REPORT_REMOVE_UNUSED_FORMATS
```
    Set to "true" if unused styles, fonts, etc. should not be written to the generated report. Default is "false".
    
    See Also:
    
    Constant Field Values
  - RESULT_SET_TYPE
```
public static final java.lang.String RESULT_SET_TYPE
```
    Set the ResultSet type for JDBC (Java engine) result queries. Allowable settings are: "TYPE_FORWARD_ONLY", "TYPE_SCROLL_SENSITIVE", "TYPE_FORWARD_ONLY". The default is "TYPE_FORWARD_ONLY".
    
    See Also:
    
    Constant Field Values
  - REPORT_SUBJECT
```
public static final java.lang.String REPORT_SUBJECT
```
    The subject of the document. In html this will set the description meta-tag.
    
    See Also:
    
    Constant Field Values
  - REPORT_TEMPLATE_VERSION
```
public static final java.lang.String REPORT_TEMPLATE_VERSION
```
    The verion of Windward/AutoTag this template was created for. The default is the latest Windward version major number ("20" at the time this was written).
    
    See Also:
    
    Constant Field Values
  - REPORT_TITLE
```
public static final java.lang.String REPORT_TITLE
```
    The title of the document. In html this will set both the TITLE tag and the title meta-tag.
    
    See Also:
    
    Constant Field Values
  - REPORT_TRACK_IMPORTS
```
public static final java.lang.String REPORT_TRACK_IMPORTS
```
    Set to "true" if you want to call getImports after processing datasources. Default is "false".
    
    See Also:
    
    Constant Field Values
  - REPORT_TRIM
```
public static final java.lang.String REPORT_TRIM
```
    Sets if the end of the generated document should be trimmed. Allowable settings are: "none" (no trim), "end.whitespace" (delete whitespace at the end of the final paragraph), and "end.blank" (remove all trailing empty paragraphs). The default is "none".
    
    See Also:
    
    Constant Field Values
  - REPORT_WRITE_FIELDS_AS_FIELDS
```
public static final java.lang.String REPORT_WRITE_FIELDS_AS_FIELDS
```
    If true DOCX form fields and content controls are written to PDF and HTML reports as form fields. If false they are written as text. Allowed values are "true" and "false". Default is "true".
    
    See Also:
    
    Constant Field Values
  - RTF_COPY_UNKNOWN
```
public static final java.lang.String RTF_COPY_UNKNOWN
```
    Set copy unknown tags mode on or off. Allowed values are: "on" (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), & "off" (so not copy tags the engine does not process). Default value is "off".
    
    See Also:
    
    Constant Field Values
  - RTF_EXTRA_PICT
```
public static final java.lang.String RTF_EXTRA_PICT
```
    Sets if the engine writes each image twice. The second time is the image that WordPad uses. Turning this on makes files a lot bigger. Allowed values are "on" and "off". Default value is "off".
    
    See Also:
    
    Constant Field Values
  - SQL_PARAMETERS
```
public static final java.lang.String SQL_PARAMETERS
```
    Sets the DataSourceProvider the parameter substitution mode. Allowed values are: "substitution" (All ${var...} is handled via string substitution. If the var does NOT start with an underscore, it will use escapes), "parameters" (All ${var...} is handled via setParameter() unless the var starts with an underscore like ${_var...} and then it uses substitution), & "parameters.always" (All ${var...} is handled via setParameter()). Default is "parameters".
    
    See Also:
    
    Constant Field Values
  - SQL_SMART_QUOTE
```
public static final java.lang.String SQL_SMART_QUOTE
```
    set to "true" to have a '${var}' will be changed to ? instead of the regular action of '?' (surrounded with quotes). Default is "false".
    
    See Also:
    
    Constant Field Values
  - TRIM_TABLES
```
public static final java.lang.String TRIM_TABLES
```
    When set, for XLSX templates, it will remove empty rows at the bottom of the table and empty columns on the right side of rows. It will remove formatted cells, but it will not remove cells with content or that are merged with other cells. Allowed values are "" (off) & "agressively". The default is "".
    
    See Also:
    
    Constant Field Values
  - TXT_BREAK_PAGE
```
public static final java.lang.String TXT_BREAK_PAGE
```
    Set to "true" for a Ctrl-L to be written to the report for each page break. The default is "false".
    
    See Also:
    
    Constant Field Values
  - TXT_FONT_NAME
```
public static final java.lang.String TXT_FONT_NAME
```
    Set the font used when formatting txt output. The default is "Courier New" on Windows and "Courier" otherwise.
    
    See Also:
    
    Constant Field Values
  - TXT_FONT_SIZE_TWIPS
```
public static final java.lang.String TXT_FONT_SIZE_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 is 12 points. Default is "240". Note: This used to be set as "txt.font_size=points" (not twips).
    
    See Also:
    
    Constant Field Values
  - TXT_USE_SOFT_EOLN
```
public static final java.lang.String TXT_USE_SOFT_EOLN
```
    Set if 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. Allowed values are: "on" (insert soft line breaks) & "off" (paragraphs are a single line). The default is "true".
    
    See Also:
    
    Constant Field Values
  - USE_BIG_DECIMAL
```
public static final java.lang.String USE_BIG_DECIMAL
```
    Sets if the system should use BigDecimal/BigInteger when calculating values in equations. Allowable settings are "on" (use BigInteger & BigDecimal) and "off" (use Long & Decimal). Default is "off".
    
    See Also:
    
    Constant Field Values
  - USE_EXTERNAL_OUTPUT_BUILDER
```
public static final java.lang.String USE_EXTERNAL_OUTPUT_BUILDER
```
    Set to "on" to use the external output builder if one is loaded for the output format. Default is "off".
    
    See Also:
    
    Constant Field Values
  - USE_PARENT_FORMAT
```
public static final java.lang.String USE_PARENT_FORMAT
```
    This is the default value for the Import tag use.parent.format property. If that is not set in the tag, then this property is used. Set to "true" to cause imported templates will have their first paragraph & character formatting set to that of the paragraph in the parent template where the import tag is located. Set to "false" to not blend the formatting. Default is false.
    
    See Also:
    
    Constant Field Values
  - WRITE_TAGS
```
public static final java.lang.String WRITE_TAGS
```
    When writing tags to a report (when the datasource for a tag was not applied) it will write the tags in the following format. Allowed values are "text" (write tags as text in the template), "field" (write tags as DOCX: field, XLSX: AutoTag() macro, & PPTX: hyperlink), & "field-plus" (same as "field" but charts & bitmaps are written as chart/bitmap objects). Default is "field-plus".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReportProperties
```
public ReportProperties()
```
    No-arg constructor.
  - ReportProperties
```
public ReportProperties(ReportProperties src)
```
    Copy constructor.
- Method Detail
  - set
```
public void set(java.lang.String name,
                java.lang.String value)
```
    Sets a value for the given property. This becomes the current value, overriding whatever value was set before.
  - set
```
public void set(java.lang.String name,
                int value)
```
    A convenient way of setting integer values.
  - set
```
public void set(java.lang.String name,
                boolean value)
```
    A convenient way of setting boolean values.
  - set
```
public void set(java.lang.String name,
                char value)
```
    A convenient way of setting character values.
  - isSet
```
public boolean isSet(java.lang.String name)
```
    Tests if a property was set, either explicitly or via the properties file.
  - getApiInt
```
public int getApiInt(java.lang.String name)
```
    Used to convert a property's value to the old API int value.
    
    Parameters:
    
    name - The property name;
    
    Returns:
    
    The int value for the old API.
  - setApiInt
```
public void setApiInt(java.lang.String name,
                      int num)
```

Class ReportProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASIAN_SUPPORT

BASE_DIRECTORY

CHECK_FOR_GLYPHS

CHECK_FOR_GLYPH_FONTNAMES

CHECK_FOR_OLE_IMAGES

CSV_CELL_SEPARATOR

CSV_NEWLINE

CSV_QUOTE_CHAR

CSV_TRIM_WHITESPACE

DEFAULT_CHART_DPI

DEFAULT_DRAWING_DPI

DEFAULT_IMAGE_DPI

EXPAND_OUT_TEXT

FORCE_BITMAP_FORMAT

REPORT_RENDER_EXTENT

REPORT_RENDER_PAGES

HIDE_CHART_WORKSHEET_DATA

HTML_CSS_FILENAME

HTML_CSS_TYPE

HTML_EMBED_IMAGES

HTML_FULL_FILE

HTML_SET_XHTML

HTML_SPLIT_PAGES

IGNORE_TAG_COLORS

IMAGE_FORMAT

IMAGE_DPI

IMPORT_USE_CHILD_STYLES

LAYOUT_DOCUMENT

OFFICE_VERSION

OPENXML_COPY_DRAWINGS

OPENXML_COPY_METADATA

OPENXML_COPY_SHAPES

OPENXML_RECALCULATE

OUTPUT_BUILDER

PDF_ARCHIVE

PDF_COMPRESSION_LEVEL

PDF_FONT_LEVEL

PDF_KEY_LENGTH

PDF_OWNER_PASSWORD

PDF_RGB_TRANSPARENCY_BLENDING_SPACE

PDF_SECURITY

PDF_USER_PASSWORD

PDF_VERSION

REPORT_CHARSET

REPORT_DESCRIPTION

REPORT_HIDDEN_MODE

REPORT_HYPHENATE

REPORT_KEYWORDS

REPORT_LOCALE

REPORT_LOCALE_ASIAN

REPORT_LOCALE_BIDI

REPORT_MODE_PROCESS_EMBEDDED

REPORT_REMOVE_UNUSED_FORMATS

RESULT_SET_TYPE

REPORT_SUBJECT

REPORT_TEMPLATE_VERSION

REPORT_TITLE

REPORT_TRACK_IMPORTS

REPORT_TRIM

REPORT_WRITE_FIELDS_AS_FIELDS

RTF_COPY_UNKNOWN

RTF_EXTRA_PICT

SQL_PARAMETERS

SQL_SMART_QUOTE

TRIM_TABLES

TXT_BREAK_PAGE

TXT_FONT_NAME

TXT_FONT_SIZE_TWIPS

TXT_USE_SOFT_EOLN

USE_BIG_DECIMAL

USE_EXTERNAL_OUTPUT_BUILDER

USE_PARENT_FORMAT

WRITE_TAGS

Constructor Detail