oracle.dss.util.xdo.common.config
Class PropertyConstants

java.lang.Object
  oracle.dss.util.xdo.common.config.PropertyConstants

public class PropertyConstants
extends java.lang.Object

XML Publisher properties

Field Summary

static java.lang.String	BIDI_CHARTYPE_PREFIX DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM
static java.lang.String	CSV_DELIMITER Specifies the csv delimiter.
static java.lang.String	CURRENCY_FORMAT_PREFIX Defines a currency format for the specific code.
static java.lang.String	DIGIT_SUBSTITUTION Set the digit formatting in bidi languages.
static java.lang.String	FLASH_HEIGHT Specifies the height of Flash area.
static java.lang.String	FLASH_PAGE_HEIGHT Specifies the wrapper document's page height Unit is point.
static java.lang.String	FLASH_PAGE_WIDTH Specifies the wrapper document's page width Unit is point.
static java.lang.String	FLASH_STARTX Specifies the start x position of flash area in the final output.
static java.lang.String	FLASH_STARTY Specifies the start y position of flash area in the final output.
static java.lang.String	FLASH_WIDTH Specifies the width of Flash area.
static java.lang.String	FO_CHUNK_SIZE DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM
static java.lang.String	FO_CORRECT_INDENT_INH #(6159831) Inheritance and calculation of indentation (start-indent and end-indent) is corrected if this property is set to true.
static java.lang.String	FO_EXTERNAL_LINK_BASE_URL Specifies the default base url for all external links.
static java.lang.String	FO_EXTERNAL_LINK_TARGET Specifies the default target for all external links.
static java.lang.String	FO_FIXED_LINEHEIGHT DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM
static java.lang.String	FO_IMAGE_HANDLING_VERSION DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM
static java.lang.String	FO_KEEP_EMPTY_INLINE (#5717283) If this property is true, FOProcessor keeps empty inlines and generates empty glyphs for them in order to pass the font information to RTFProcessor.
static java.lang.String	FO_MERGE_CONFLICT_RESOLUTION Controls FOProcessor multiple XSL-FO file merging behavior.
static java.lang.String	FO_MULTI_THREADS FOProcessor will run XSL-T processor in a new threads to utilize multiple CPUs/Cores when this value is set to true.
static java.lang.String	FO_PRESERVE_WHITESPACE Controls XSL-FO Parser behavior.
static java.lang.String	FO_PREVENT_VAR_HEADER Flag to prevent variable header support.
static java.lang.String	FO_SPACE_HANDLING_VERSION DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM
static java.lang.String	FO_TRIM_LEADING_WHITESPACES Controls XSL-FO Parser behavior.
static java.lang.String	FO_USER_VARIABLE_PREFIX Can define variable name and its value mapping.
static java.lang.String	HTML_CSS_BASE_URI Base uri which is inserted into html header to specify css file.
static java.lang.String	HTML_CSS_DIR The CSS directory where XML Publisher stores the css file.
static java.lang.String	HTML_CSS_EMBEDDING Internal property - Do not use.
static java.lang.String	HTML_IMAGE_BASE_URI Base uri which is inserted into src attribute of image tag before the image file name.
static java.lang.String	HTML_IMAGE_DIR The image directory where XML Publisher stores the image file which is embedded in the template.
static java.lang.String	HTML_OUTPUT_BODY_ONLY Internal property - Do not use.
static java.lang.String	HTML_OUTPUT_CHARSET Specify the html output charset.
static java.lang.String	HTML_OUTPUT_WIDTH_IN_PERCENTAGE Specify true if you want to set table columns unit to "%" instead of "pt".
static java.lang.String	HTML_OUTPUTTYPE Internal property - Do not use.
static java.lang.String	HTML_REPLACE_SMARTQUOTES Do the reverse conversion of MS-Word's auto correct.
static java.lang.String	HTML_SHOW_FOOTER Shows a footer at the end of the page if this is set to true.
static java.lang.String	HTML_SHOW_HEADER Shows a header at the beginning of the page if this is set to true.
static java.lang.String	HTML_SUPPRESSED_LINE_HEIGHT Internal property - Do not use.
static java.lang.String	MAKE_ACCESSIBLE Specify true if you want to make HTML output accessible.
static java.lang.String	PAGINATED_HTML_PATH This property and value is required when generating a paginated HTML.
static java.lang.String	PDF_CHANGES_ALLOWED Permission when pdf-encryption-level is 1 ( 128bit ).
static java.lang.String	PDF_COMPRESSION Specify true or false to control the output PDF's compression.
static java.lang.String	PDF_ENABLE_ACCESSIBILITY Permission when pdf-encryption-level is 1 ( 128bit ).
static java.lang.String	PDF_ENABLE_COPYING Permission when pdf-encryption-level is 1 ( 128bit ).
static java.lang.String	PDF_ENCRYPTION_LEVEL Specify the encryption level for the output PDF.
static java.lang.String	PDF_FILEID Internal property - Do not use.
static java.lang.String	PDF_FONT_EMBEDDING TrueType font embedding option.
static java.lang.String	PDF_FONTDEF_PREFIX Defines a font for XML Publisher. font.<family>.<style>.<weight> <family> is case insensitive.
static java.lang.String	PDF_HIDE_MENUBAR Specify true if you want to hide the viewer application's menu bars when the document is active.
static java.lang.String	PDF_HIDE_TOOLBAR Specify true if you want to hide the viewer application's tool bars when the document is active.
static java.lang.String	PDF_MAP_TO_SINGLE_BYTE Deprecated.
static java.lang.String	PDF_NO_ACCFF Permission when pdf-encryption-level is 0 ( 40bit ).
static java.lang.String	PDF_NO_CCEDA Permission when pdf-encryption-level is 0 ( 40bit ).
static java.lang.String	PDF_NO_CHANGING_THE_DOCUMENT Permission when pdf-encryption-level is 0 ( 40bit ).
static java.lang.String	PDF_NO_PRINTING Permission when pdf-encryption-level is 0 ( 40bit ).
static java.lang.String	PDF_NUM_COPIES Specify the number of copies to be printed when the print dialog is opened for this file.
static java.lang.String	PDF_OPEN_PASSWORD Specify the password to open the output PDF.
static java.lang.String	PDF_PERMISSIONS Internal property - Do not use.
static java.lang.String	PDF_PERMISSIONS_PASSWORD Specify the permissions password for the output PDF.
static java.lang.String	PDF_PRINT_DUPLEX Specify the paper handling option to use when printing the file from the print dialog.
static java.lang.String	PDF_PRINT_SCALING Specify the Print Scaling preference The following values are valid: "AppDefault" - applications should use the current print scaling "None" - print dialog should reflect no page scaling
static java.lang.String	PDF_PRINTING_ALLOWED Permission when pdf-encryption-level is 1 ( 128bit ).
static java.lang.String	PDF_REPLACE_SMARTQUOTES Do the reverse conversion of MS-Word's auto correct.
static java.lang.String	PDF_SECURITY Specify true or false to control the output PDF's security.
static java.lang.String	PDF2X_COPIES Specifies the number of copies to be printed.
static java.lang.String	PDF2X_MEDIA_SIZE_NAME Specifies the media for a print job by name.
static java.lang.String	PDF2X_MEDIA_TRAY Specifies the media tray or bin for the print job.
static java.lang.String	PDF2X_PAGE_HEIGHT Specifies the media height for a print job in point (1/72 inch).
static java.lang.String	PDF2X_PAGE_ORIENTATION Indicates the desired orientation for printed pages.
static java.lang.String	PDF2X_PAGE_RANGES Identifies the range(s) of PDF pages to be printed.
static java.lang.String	PDF2X_PAGE_WIDTH Specifies the media width for a print job in point (1/72 inch).
static java.lang.String	PDF2X_PS_CID_FONT_CONVTYPE When converting to Postscript and the PDF has embedded CID Font Type 2, this property determines whether converting the font to Postscript Type0 +Type42 fonts or Type0+Type3 fonts.
static java.lang.String	PDF2X_SHEET_COLLATE Specifies whether or not the media sheets of each copy of each printed document in a job are to be in sequence, when multiple copies of the document are specified by "pdf2x-copies".
static java.lang.String	PDF2X_SIDES Specifies how print-stream pages are to be imposed upon the sides of an instance of a selected medium.
static java.lang.String	PDFFORM_FONTDEF_PREFIX Defines a font substitution.
static java.lang.String	RTF_ADJACENT_TABLE_BORDER_OVERLAP Set the behavior of adjacent table's border to be as same as XDO Version 5.5 or older, i.e.
static java.lang.String	RTF_CHECKBOX_GLYPH The property specifies two customer font's glyphs to represent RTF template's checkbox's true and false value, i.e.
static java.lang.String	RTF_EXTRACT_ATTRIBUTE_SETS Deprecated. after 5.6.3, new optimization algorithm introduced.
static java.lang.String	RTF_OUTPUT_DEFAULT_FONT Allow overwrite of default document font-family name and font size.
static java.lang.String	RTF_PROTECT_DOCUMENT_FOR_TRACKED_CHANGES Protects a document for tracked changes.
static java.lang.String	RTF_PROTECT_FORMS Protects form fields, If you set this property to true, pull down lists and check boxes will be activated.
static java.lang.String	RTF_REWRITE_PATH Enable XPath rewriting.
static java.lang.String	RTF_TRACK_CHANGES Turns on the track changes.
static java.lang.String	RTF_XSLFO_VERSION Set the XSL's version generated by RTF parser <p> Defalut value: 2.0 <p> Set to this config to be "1.0" if user needs to use XSLT 1.0's behavior for transforming this XSL/FO file
static java.lang.String	SIGNATURE_ENABLE PDF Digital Signature Properties The following properties are used with the PDFSignatureUtil.applySignature() method only.
static java.lang.String	SIGNATURE_FIELD_HEIGHT
static java.lang.String	SIGNATURE_FIELD_LOCATION
static java.lang.String	SIGNATURE_FIELD_NAME
static java.lang.String	SIGNATURE_FIELD_POS_X
static java.lang.String	SIGNATURE_FIELD_POS_Y
static java.lang.String	SIGNATURE_FIELD_WIDTH
static java.lang.String	SIGNATURE_PKCS12_PASSWORD
static java.lang.String	SIGNATURE_PKCS12_PATH
static java.lang.String	SYS_COMPRESSED_TMP_FILE Use compression when saving and reading temp file.
static java.lang.String	SYSTEM_CACHE_PAGE_SIZE FOProcessor keeps page image to process the table of contents stuff and FOProcessor writes them down into the one file when the number of page exceeds this size.
static java.lang.String	SYSTEM_TEMP_DIR Temporary directory for XML Publisher.
static java.lang.String	XDK_SECURE_ALLOW_ACCESS Add allow access url.
static java.lang.String	XDK_SECURE_IO_MODE Controls whether to use secure file I/O mode for XSLProcessor and XMLParser.
static java.lang.String	XDK_SECURE_PROHIBIT_ACCESS Add prohibit access url.
static java.lang.String	XLIFF_TRANS_EXPANSION value for maxwidth attribute of trans-unit element.
static java.lang.String	XLIFF_TRANS_KEYWORD If to extract keyword.
static java.lang.String	XLIFF_TRANS_MAX_LENGTH When the calculated maxwidth value is more than xliff-trans-max-length, use this value instead.
static java.lang.String	XLIFF_TRANS_MIN_LENGTH When the calculated maxwidth value is less than xliff-trans-min-length, use this value instead.
static java.lang.String	XLIFF_TRANS_NULL To produce trans-unit even the record has only a space(s).
static java.lang.String	XLIFF_TRANS_SYMBOL If to extract the symbol characters.
static java.lang.String	XML_IGNORE_DOCTYPE Controls XML Parser behavior to ignore doctype.
static java.lang.String	XML_PRESERVE_WHITESPACE Controls XML Parser behavior.
static java.lang.String	XSLT_LOCALE Internal Property
static java.lang.String	XSLT_PROPERTY_PREFIX Internal Property
static java.lang.String	XSLT_RUNTIME_OPTIMIZATION Controls XSLT Runtime Optimization behavior.
static java.lang.String	XSLT_SCALABLE Controls scalable feature of xdoparser.
static java.lang.String	XSLT_XDOPARSER Controls xdoparser usage.

Constructor Summary

PropertyConstants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM_TEMP_DIR

public static final java.lang.String SYSTEM_TEMP_DIR

Temporary directory for XML Publisher.

Default value: N/A

Since:

3.5

See Also:

Constant Field Values

SYS_COMPRESSED_TMP_FILE

public static final java.lang.String SYS_COMPRESSED_TMP_FILE

Use compression when saving and reading temp file. This is to reduce tmp disk usage by 25% of original. It also provide faster performance if disk I/O is slow.

Default value: false

Since:

5.6.3

See Also:

Constant Field Values

SYSTEM_CACHE_PAGE_SIZE

public static final java.lang.String SYSTEM_CACHE_PAGE_SIZE

FOProcessor keeps page image to process the table of contents stuff and FOProcessor writes them down into the one file when the number of page exceeds this size. Default size is 50 and it is available only temporary directory property is specified.

Default value: 50

Since:

3.5

See Also:

Constant Field Values

FO_MULTI_THREADS

public static final java.lang.String FO_MULTI_THREADS

FOProcessor will run XSL-T processor in a new threads to utilize multiple CPUs/Cores when this value is set to true. On a single core/CPU machine, this flag is best set to false. When it is set to true, two threads will run in parallel, thus memory consumption is a combined of the two threads.

Default value: false

Since:

6.0

See Also:

Constant Field Values

FO_PREVENT_VAR_HEADER

public static final java.lang.String FO_PREVENT_VAR_HEADER

Flag to prevent variable header support.

Default value: false

Since:

4.5

See Also:

Constant Field Values

FO_CHUNK_SIZE

public static final java.lang.String FO_CHUNK_SIZE

DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM

Changes FOProcessor's processing chunk size. If this size is smaller, FOProcessor works with less memory consumption

Default value: 1000000

Since:

4.5

See Also:

Constant Field Values

FO_USER_VARIABLE_PREFIX

public static final java.lang.String FO_USER_VARIABLE_PREFIX

Can define variable name and its value mapping. This variable can be used in the URL text for external link or external image link. ($[VARNAME] style can be used to embed in the link URL.)

Default value: N/A

Since:

4.5

See Also:

Constant Field Values

FO_FIXED_LINEHEIGHT

public static final java.lang.String FO_FIXED_LINEHEIGHT

DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM

Flag for compatiblity mode. Decides whether line height is always maximum line height of single byte font height and multi byte font height or different font height.

Default value: true, it always keeps same line height

Since:

5.0

See Also:

Constant Field Values

FO_MERGE_CONFLICT_RESOLUTION

public static final java.lang.String FO_MERGE_CONFLICT_RESOLUTION

Controls FOProcessor multiple XSL-FO file merging behavior. FOProcessor automatically adds randam prefix to resolve conflicted ids in the multiple xsl-fo inputs. If this property is false, stops adding random prefix.

Default value: true

Since:

5.0

See Also:

Constant Field Values

XSLT_PROPERTY_PREFIX

public static final java.lang.String XSLT_PROPERTY_PREFIX

Internal Property

Controls XSLT behavior. User can set any parameter for XSLT after this prefix.

Default value: N/A

Since:

5.0

See Also:

Constant Field Values

BIDI_CHARTYPE_PREFIX

public static final java.lang.String BIDI_CHARTYPE_PREFIX

DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM

To override bidi character type definition. This change affects bidi algorithm behavior.

Default value: none

Since:

5.0

See Also:

Constant Field Values

DIGIT_SUBSTITUTION

public static final java.lang.String DIGIT_SUBSTITUTION

Set the digit formatting in bidi languages.

Possible values are:

none : Do nothing (Use arabic numbers)
locale-dependent : Use Arabic or Hindi numbers according to the locale
national : Same as locale-dependent, only for backward compatibility
hindi : Use Hindi numbers

Default value: locale-dependent

Since:

5.0

See Also:

Constant Field Values

FO_IMAGE_HANDLING_VERSION

public static final java.lang.String FO_IMAGE_HANDLING_VERSION

DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM

In 5.5, the behavior of image size handling without width/height properties has been modified. if "5.0" is specified, XDO acts same as 5.0 or earlier.

Default value: N/A

Since:

5.5

See Also:

Constant Field Values

FO_SPACE_HANDLING_VERSION

public static final java.lang.String FO_SPACE_HANDLING_VERSION

DO NOT OPEN UNTIL CUSTOMER HIT THE PROBLEM

In 5.5, the behavior of space handling has been modified. (Before 5.5, FOProcessor's behavior is different from other XSL-FO products.) If "5.0" is specified, XDO acts same as 5.0 or earlier. Default value: N/A

Since:

5.5

See Also:

Constant Field Values

FO_CORRECT_INDENT_INH

public static final java.lang.String FO_CORRECT_INDENT_INH

#(6159831) Inheritance and calculation of indentation (start-indent and end-indent) is corrected if this property is set to true. If it is set to false, old indentation behavior is used. Default value: false

Since:

10.1.3.4

See Also:

Constant Field Values

FO_KEEP_EMPTY_INLINE

public static final java.lang.String FO_KEEP_EMPTY_INLINE

(#5717283) If this property is true, FOProcessor keeps empty inlines and generates empty glyphs for them in order to pass the font information to RTFProcessor. Default value: false

Since:

11.1.1

See Also:

Constant Field Values

FO_PRESERVE_WHITESPACE

public static final java.lang.String FO_PRESERVE_WHITESPACE

Controls XSL-FO Parser behavior. If true, unnecessary whitespace will be preserved.

Default value: false

Since:

See Also:

Constant Field Values

XSLT_RUNTIME_OPTIMIZATION

public static final java.lang.String XSLT_RUNTIME_OPTIMIZATION

Controls XSLT Runtime Optimization behavior. If false, disable the runtime optimization.

Default value: true

Since:

5.6.3

See Also:

Constant Field Values

XSLT_LOCALE

public static final java.lang.String XSLT_LOCALE

Internal Property

Locale setting for XSLT processor. This will be used number formatting.

Default value:

Since:

See Also:

Constant Field Values

XML_PRESERVE_WHITESPACE

public static final java.lang.String XML_PRESERVE_WHITESPACE

Controls XML Parser behavior. Unlike fo-preserve-whitespace, true is default. If it is false, unnecessary whitespace will be truncated.

Default value: true

Since:

See Also:

Constant Field Values

XML_IGNORE_DOCTYPE

public static final java.lang.String XML_IGNORE_DOCTYPE

Controls XML Parser behavior to ignore doctype.

Default value: false

Since:

See Also:

Constant Field Values

FO_TRIM_LEADING_WHITESPACES

public static final java.lang.String FO_TRIM_LEADING_WHITESPACES

Controls XSL-FO Parser behavior. If true, leading whitespaces of CDATA (text) in fo:block are trimmed. If false, there is no change of behavior.

Default value: false

Since:

5.6.1

See Also:

Constant Field Values

XSLT_XDOPARSER

public static final java.lang.String XSLT_XDOPARSER

Controls xdoparser usage. If it is false, xdoparser will not be used for XSLT.

Default value: true

Since:

See Also:

Constant Field Values

XSLT_SCALABLE

public static final java.lang.String XSLT_SCALABLE

Controls scalable feature of xdoparser. Valid with xslt-xdoparser="true" or scalable xdk (xmlparserv2.jar) is available

Default value: false

Since:

See Also:

Constant Field Values

XDK_SECURE_IO_MODE

public static final java.lang.String XDK_SECURE_IO_MODE

Controls whether to use secure file I/O mode for XSLProcessor and XMLParser. when it is set to true, no file I/O is allowed from XDK

Default value: false

Since:

See Also:

Constant Field Values

XDK_SECURE_ALLOW_ACCESS

public static final java.lang.String XDK_SECURE_ALLOW_ACCESS

Add allow access url. This is only used when XDK_SECURE_IO_MODE is set to true

Default value: n/a

Since:

11.1.1.0

See Also:

Constant Field Values

XDK_SECURE_PROHIBIT_ACCESS

public static final java.lang.String XDK_SECURE_PROHIBIT_ACCESS

Add prohibit access url. This is only used when XDK_SECURE_IO_MODE is set to true

Default value: n/a

Since:

11.1.1.0

See Also:

Constant Field Values

CURRENCY_FORMAT_PREFIX

public static final java.lang.String CURRENCY_FORMAT_PREFIX

Defines a currency format for the specific code.

e.g) currency-format.USD=999D99

Default value: N/A

Since:

5.6

See Also:

Constant Field Values

PDF_COMPRESSION

public static final java.lang.String PDF_COMPRESSION

Specify true or false to control the output PDF's compression. If you specify true, the output PDF file will be compressed.

Default value: true

Since:

3.5

See Also:

Constant Field Values

PDF_HIDE_TOOLBAR

public static final java.lang.String PDF_HIDE_TOOLBAR

Specify true if you want to hide the viewer application's tool bars when the document is active.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_HIDE_MENUBAR

public static final java.lang.String PDF_HIDE_MENUBAR

Specify true if you want to hide the viewer application's menu bars when the document is active.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_PRINT_SCALING

public static final java.lang.String PDF_PRINT_SCALING

Specify the Print Scaling preference
The following values are valid:
"AppDefault" - applications should use the current print scaling
"None" - print dialog should reflect no page scaling

Default value: "AppDefault"

Since:

11.1.1.0 (See ER6808335 for detail)

See Also:

Constant Field Values

PDF_PRINT_DUPLEX

public static final java.lang.String PDF_PRINT_DUPLEX

Specify the paper handling option to use when printing the file from the print dialog. The following values are valid:
"None" - Not specified
"Simplex" - Print single-sided
"DuplexFlipShortEdge" - Duplex and flip on the short edge of the sheet
"DuplexFlipLongEdge" - Duplex and flip on the long edge of the sheet
Note: this feature might not work in some environment.

Default value: "None"

Since:

11.1.1.0 (See ER6808335 for detail)

See Also:

Constant Field Values

PDF_NUM_COPIES

public static final java.lang.String PDF_NUM_COPIES

Specify the number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored.

Default value: 1

Since:

11.1.1.0 (See ER6808335 for detail)

See Also:

Constant Field Values

PDF_SECURITY

public static final java.lang.String PDF_SECURITY

Specify true or false to control the output PDF's security. If you specify true, the output PDF file will be encrypted.

You have to specify a set of properties as well if you want to control PDF security ( pdf-user-pass, pdf-owner-pass, pdf-encryption-level and permissions properties).

Example:

<property name="pdf-security">true</property>
<property name="pdf-open-password">user</property>
<property name="pdf-permissions-password">owner</property>
<property name="pdf-encryption-level">1</property>
<property name="pdf-enable-copying">false</property>

Available permissions properties:

When pdf-encryption-level is 0 ( 40bit, Acrobat 3.x, 4.x)

- pdf-no-printing
- pdf-no-changing-the-document
- pdf-no-cceda
- pdf-no-accff

When pdf-encryption-level is 1 128bit, Acrobat 5.0 or later )

- pdf-enable-accessibility
- pdf-enable-copying
- pdf-changes-allowed
- pdf-printing-allowed

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_OPEN_PASSWORD

public static final java.lang.String PDF_OPEN_PASSWORD

Specify the password to open the output PDF. This property is effective only when the pdf-security property is set to true. To specify this property in the configuration file is not recommended because the configuration file itself is not encrypted and everyone can know the password easily.

Default value: ""(null string)

Since:

4.3

See Also:

Constant Field Values

PDF_PERMISSIONS_PASSWORD

public static final java.lang.String PDF_PERMISSIONS_PASSWORD

Specify the permissions password for the output PDF. The permissions password is required to modify the security setting. This property is effective only when the pdf-security property is set to true. To specify this property in the configuration file is not recommended because the configuration file itself is not encrypted and everyone can know the password easily.

Default value: ""(null string)

Since:

4.3

See Also:

Constant Field Values

PDF_PERMISSIONS

public static final java.lang.String PDF_PERMISSIONS

Internal property - Do not use.

Specify the permissions for the output PDF. This property is effective only when the pdf-security property is set to true. User access permissions of section 3.5 of PDF reference manual for details.

If this property is not set, each permissions properties like pdf-no-printing are used instead.

Default value: 0 (Not set)

Since:

4.3

See Also:

Constant Field Values

PDF_ENCRYPTION_LEVEL

public static final java.lang.String PDF_ENCRYPTION_LEVEL

Specify the encryption level for the output PDF.

0: Low ( 40bit RC4, Acrobat 3.0 or later )
1: Medium ( 128bit RC4, Acrobat 5.0 or later )
2: High ( 128bit AES, Acrobat 7.0 or later )
This property is effective only when the pdf-security property is set to true.

Default value: 0

Since:

4.3

See Also:

Constant Field Values

PDF_NO_PRINTING

public static final java.lang.String PDF_NO_PRINTING

Permission when pdf-encryption-level is 0 ( 40bit ). No Printing.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_NO_CHANGING_THE_DOCUMENT

public static final java.lang.String PDF_NO_CHANGING_THE_DOCUMENT

Permission when pdf-encryption-level is 0 ( 40bit ). No Changing the Document.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_NO_CCEDA

public static final java.lang.String PDF_NO_CCEDA

Permission when pdf-encryption-level is 0 ( 40bit ). No Content Copying or Extraction, Disable Accessibility.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_NO_ACCFF

public static final java.lang.String PDF_NO_ACCFF

Permission when pdf-encryption-level is 0 ( 40bit ). No Adding or Changing Comments and Form Fields.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_ENABLE_ACCESSIBILITY

public static final java.lang.String PDF_ENABLE_ACCESSIBILITY

Permission when pdf-encryption-level is 1 ( 128bit ). Enable text access for screen reader devices for the visually impaired.

Default value: true

Since:

4.3

See Also:

Constant Field Values

PDF_ENABLE_COPYING

public static final java.lang.String PDF_ENABLE_COPYING

Permission when pdf-encryption-level is 1 ( 128bit ). Enable copying of text, images, and other content.

Default value: false

Since:

4.3

See Also:

Constant Field Values

PDF_CHANGES_ALLOWED

public static final java.lang.String PDF_CHANGES_ALLOWED

Permission when pdf-encryption-level is 1 ( 128bit ).

0: None
1: Inserting, deleting, and rotating pages
2: Filling in form fields and signing
3: Commenting, filling in form fields, and signing
4: Any except extracting pages

Default value: 0

Since:

4.3

See Also:

Constant Field Values

PDF_PRINTING_ALLOWED

public static final java.lang.String PDF_PRINTING_ALLOWED

Permission when pdf-encryption-level is 1 ( 128bit ).

0: None
1: Low Resolution (150dpi)
2: High Resolution

Default value: 0

Since:

4.3

See Also:

Constant Field Values

PDF_MAP_TO_SINGLE_BYTE

public static final java.lang.String PDF_MAP_TO_SINGLE_BYTE

Deprecated. Use pdf-replace-smartquotes instead

See Also:

Constant Field Values

PDF_REPLACE_SMARTQUOTES

public static final java.lang.String PDF_REPLACE_SMARTQUOTES

Do the reverse conversion of MS-Word's auto correct.

quoteleft (0x2018) -> single quote (0x27)
quoteright (0x2019) -> single quote (0x27)
left double quote (0x201C) -> double quote (0x22)
right double quote (0x201D) -> double quote (0x22)

Default value: true

Since:

5.5

See Also:

Constant Field Values

PDF_FONTDEF_PREFIX

public static final java.lang.String PDF_FONTDEF_PREFIX

Defines a font for XML Publisher.

font.<family>.<style>.<weight>

<family> is case insensitive. <style> must be one of "italic" or "normal".
<weight> must be one of "bold" or "normal".

The value of this property is one of the followings:

type1.<fontname>

Or

truetype.<path>

Or

truetype.<path>(<ttcno>)


Example 1

<font family="Courier" style="italic" weight="bold">
<type1 name="Courier-BoldOblique" />
</font>

is same as:

font.Courier.italic.bold = type1.Courier-BoldOblique

Example 2

<font family="Arial" style="normal" weight="normal">
<truetype path="C:\fonts\Arial.ttf" />
</font>

is same as:

font.Arial.normal.normal = truetype.C:\fonts\Arial.ttf

Example 3

<font family="MSGothic" style="normal" weight="normal">
<truetype path="C:\fonts\msgothic.ttc" ttcno="0" />
</font>

is same as:

font.MSGothic.normal.normal = truetype.C:\fonts\msgothic.ttc(0)

Default value: N/A

Since:

4.3

See Also:

Constant Field Values

PDF_FILEID

public static final java.lang.String PDF_FILEID

Internal property - Do not use.

For testing purpose only.

Default value: N/A

Since:

3.5

See Also:

Constant Field Values

PDF_FONT_EMBEDDING

public static final java.lang.String PDF_FONT_EMBEDDING

TrueType font embedding option. Setting this option to false is not recommended. This option should be used carefully. If this option is false, TrueType font won't be embedded for the latin1 characters. Default value: true

Since:

5.7

See Also:

Constant Field Values

RTF_TRACK_CHANGES

public static final java.lang.String RTF_TRACK_CHANGES

Turns on the track changes.

Default value: false

Since:

5.0

See Also:

Constant Field Values

RTF_PROTECT_DOCUMENT_FOR_TRACKED_CHANGES

public static final java.lang.String RTF_PROTECT_DOCUMENT_FOR_TRACKED_CHANGES

Protects a document for tracked changes.

Default value: false

Since:

5.0

See Also:

Constant Field Values

RTF_OUTPUT_DEFAULT_FONT

public static final java.lang.String RTF_OUTPUT_DEFAULT_FONT

Allow overwrite of default document font-family name and font size.

Default value: null

Examples: "Arial:12", "Times New Roman:9", "Times".

Since:

5.6.3

See Also:

Constant Field Values

RTF_PROTECT_FORMS

public static final java.lang.String RTF_PROTECT_FORMS

Protects form fields, If you set this property to true, pull down lists and check boxes will be activated.

Default value: false

Since:

11.0

See Also:

Constant Field Values

HTML_IMAGE_BASE_URI

public static final java.lang.String HTML_IMAGE_BASE_URI

Base uri which is inserted into src attribute of image tag before the image file name. This works only when the image is embedded in the template.

Default value: N/A

Since:

5.0

See Also:

Constant Field Values

HTML_IMAGE_DIR

public static final java.lang.String HTML_IMAGE_DIR

The image directory where XML Publisher stores the image file which is embedded in the template.

Default value: N/A

Since:

5.0

See Also:

Constant Field Values

HTML_CSS_BASE_URI

public static final java.lang.String HTML_CSS_BASE_URI

Base uri which is inserted into html header to specify css file. You must set this property when make-accessible is true.

Default value: N/A

Since:

5.0

See Also:

Constant Field Values

HTML_CSS_DIR

public static final java.lang.String HTML_CSS_DIR

The CSS directory where XML Publisher stores the css file. You must set this property when make-accessible is true.

Default value: N/A

Since:

5.0

See Also:

Constant Field Values

HTML_SHOW_HEADER

public static final java.lang.String HTML_SHOW_HEADER

Shows a header at the beginning of the page if this is set to true.

Default value: true

Since:

5.0

See Also:

Constant Field Values

HTML_SHOW_FOOTER

public static final java.lang.String HTML_SHOW_FOOTER

Shows a footer at the end of the page if this is set to true.

Default value: true

Since:

5.0

See Also:

Constant Field Values

HTML_REPLACE_SMARTQUOTES

public static final java.lang.String HTML_REPLACE_SMARTQUOTES

Do the reverse conversion of MS-Word's auto correct.

quoteleft (0x2018) -> single quote (0x27)
quoteright (0x2019) -> single quote (0x27)
left double quote (0x201C) -> double quote (0x22)
right double quote (0x201D) -> double quote (0x22)

Default value: true

Since:

5.5

See Also:

Constant Field Values

HTML_OUTPUT_CHARSET

public static final java.lang.String HTML_OUTPUT_CHARSET

Specify the html output charset.

Default value: UTF-8

Since:

5.6

See Also:

Constant Field Values

MAKE_ACCESSIBLE

public static final java.lang.String MAKE_ACCESSIBLE

Specify true if you want to make HTML output accessible.

Default value: false

Since:

5.0

See Also:

Constant Field Values

HTML_OUTPUT_WIDTH_IN_PERCENTAGE

public static final java.lang.String HTML_OUTPUT_WIDTH_IN_PERCENTAGE

Specify true if you want to set table columns unit to "%" instead of "pt". This resolves IE or FireFox's column width problem.

Default value: true

Since:

10.1.3.3

See Also:

Constant Field Values

HTML_OUTPUTTYPE

public static final java.lang.String HTML_OUTPUTTYPE

Internal property - Do not use.

Hidden property for pesudo excel output.
Can be set to: "xhtml"
"pseudo-excel"

Default value: "xhtml"

Since:

5.5

See Also:

Constant Field Values

HTML_CSS_EMBEDDING

public static final java.lang.String HTML_CSS_EMBEDDING

Internal property - Do not use.

Controls the css embedding.
Can be set to:
"embed-to-element"
"embed-to-header"
"externalize"

Default value: "embed-to-header"

Since:

5.6.3

See Also:

Constant Field Values

HTML_OUTPUT_BODY_ONLY

public static final java.lang.String HTML_OUTPUT_BODY_ONLY

Internal property - Do not use.

Controls the output of html header and trailer. If this option is true, HTMLGenerator outputs only elements between and ( element is excluded). This option can be true only with html-css-embedding=embed-to-element property. Other conbinations are not recommended.

Default value: false

Since:

5.6.3

See Also:

Constant Field Values

HTML_SUPPRESSED_LINE_HEIGHT

public static final java.lang.String HTML_SUPPRESSED_LINE_HEIGHT

Internal property - Do not use.

Controls the output of html line-height CSS property. If this option is true, HTMLGenerator suppressed line-height CSS property. This option can be true for FO code generated from XPT.

Default value: false

Since:

11.1.1.0

See Also:

Constant Field Values

PDFFORM_FONTDEF_PREFIX

public static final java.lang.String PDFFORM_FONTDEF_PREFIX

Defines a font substitution.

font.<family>.<style>.<weight>

This property Maps font name in the PDF to the actual font file for I18N support.

The value of this property is one of the followings:

truetype.<path>

Or

truetype.<path>.(<ttcno>)

Example 1

<font-substitute name="Courier">
<truetype path="C:\fonts\Arial.ttf" />
</font-substitute>

is same as:

font-substitute.Courier = truetype.C:\fonts\Arial.ttf

Example 2

<font-substitutename="Courier">
<truetype path="C:\fonts\msgothic.ttc" ttcno="0" />
</font-substitute>

is same as:

font-substitute.Courier = truetype.C:\fonts\msgothic.ttc(0)

Default value: N/A

Since:

4.3

See Also:

Constant Field Values

RTF_EXTRACT_ATTRIBUTE_SETS

public static final java.lang.String RTF_EXTRACT_ATTRIBUTE_SETS

Deprecated. after 5.6.3, new optimization algorithm introduced.

Extract attribute sets. <p> Default value: auto

Since:

4.5

See Also:

Constant Field Values

RTF_REWRITE_PATH

public static final java.lang.String RTF_REWRITE_PATH

Enable XPath rewriting. Rewrite path to match multiple level's elements. <p> Default value: true

Since:

4.5

See Also:

Constant Field Values

RTF_CHECKBOX_GLYPH

public static final java.lang.String RTF_CHECKBOX_GLYPH

The property specifies two customer font's glyphs to represent RTF template's checkbox's true and false value, i.e. glyph for "[X]" and glyph for "[ ]". The format of this property is as following: first comes the font's name, and then the Unicode number of the true value's glyph and then Unicode number of the false value's glyph. Use only ";" to separate these 3 values. PLEASE REMEMBER to add a font property so that xdo engine can find your own TTF font file. <p> Default value: Albany WT J;9746;9747

Since:

5.6

See Also:

Constant Field Values

RTF_XSLFO_VERSION

public static final java.lang.String RTF_XSLFO_VERSION

Set the XSL's version generated by RTF parser <p> Defalut value: 2.0 <p> Set to this config to be "1.0" if user needs to use XSLT 1.0's behavior for transforming this XSL/FO file

Since:

5.6

See Also:

Constant Field Values

RTF_ADJACENT_TABLE_BORDER_OVERLAP

public static final java.lang.String RTF_ADJACENT_TABLE_BORDER_OVERLAP

Set the behavior of adjacent table's border to be as same as XDO Version 5.5 or older, i.e. overlapped to each other. <p> Default value: false <p> Set this config to be "true" if user needs to use old behavior to handle adjacent table's up/bottom table border, especially when user wants to repent a table multiple times and make the whole repeating area look like single table

Since:

5.6.1

See Also:

Constant Field Values

XLIFF_TRANS_EXPANSION

public static final java.lang.String XLIFF_TRANS_EXPANSION

value for maxwidth attribute of trans-unit element. When it is set to 200, XLIFF Extractor will expand 200%. i.e. a trans-unit with 10 characters will have maxwidth="30". <p> Default value: 150

Since:

5.5

See Also:

Constant Field Values

XLIFF_TRANS_MAX_LENGTH

public static final java.lang.String XLIFF_TRANS_MAX_LENGTH

When the calculated maxwidth value is more than xliff-trans-max-length, use this value instead. e.x. maxwidth for 100 characters is 250 by default. if xliff-trans-max-length is set to 200, maxwidth="200" will be set. <p> Default value: 4000

Since:

5.5

See Also:

Constant Field Values

XLIFF_TRANS_MIN_LENGTH

public static final java.lang.String XLIFF_TRANS_MIN_LENGTH

When the calculated maxwidth value is less than xliff-trans-min-length, use this value instead. e.x. maxwidth for a trans-unit with 10 characters is 25 by default. if xliff-trans-min-length is set to 20, maxwidth="20" will be set. <p> Default value: 15

Since:

5.5

See Also:

Constant Field Values

XLIFF_TRANS_NULL

public static final java.lang.String XLIFF_TRANS_NULL

To produce trans-unit even the record has only a space(s). <p> Default value: false

Since:

5.5

See Also:

Constant Field Values

XLIFF_TRANS_SYMBOL

public static final java.lang.String XLIFF_TRANS_SYMBOL

If to extract the symbol characters. until 0420's build: A-Z | a-z are the non-symbol characters. Other characters are considered as symbol characters. 0421's build: checks if it's letter or not(symbol) with java.lang.Character.isLetter() Confirmed that isLetter() returns true for A-Z, a-z within ASCII characters in 1.4.2. <p> Default value: false

Since:

5.5

See Also:

Constant Field Values

XLIFF_TRANS_KEYWORD

public static final java.lang.String XLIFF_TRANS_KEYWORD

If to extract keyword. Keyword means any word containing an underscore, "_" such as "A_B", "_ B" or "_B". <p> Default value: true

Since:

5.5

See Also:

Constant Field Values

SIGNATURE_ENABLE

public static final java.lang.String SIGNATURE_ENABLE

PDF Digital Signature Properties The following properties are used with the PDFSignatureUtil.applySignature() method only. They should NOT affect the core engine's output otherwise.

See Also:

Constant Field Values

SIGNATURE_FIELD_LOCATION

public static final java.lang.String SIGNATURE_FIELD_LOCATION

See Also:

Constant Field Values

SIGNATURE_FIELD_NAME

public static final java.lang.String SIGNATURE_FIELD_NAME

See Also:

Constant Field Values

SIGNATURE_FIELD_POS_X

public static final java.lang.String SIGNATURE_FIELD_POS_X

See Also:

Constant Field Values

SIGNATURE_FIELD_POS_Y

public static final java.lang.String SIGNATURE_FIELD_POS_Y

See Also:

Constant Field Values

SIGNATURE_FIELD_WIDTH

public static final java.lang.String SIGNATURE_FIELD_WIDTH

See Also:

Constant Field Values

SIGNATURE_FIELD_HEIGHT

public static final java.lang.String SIGNATURE_FIELD_HEIGHT

See Also:

Constant Field Values

SIGNATURE_PKCS12_PATH

public static final java.lang.String SIGNATURE_PKCS12_PATH

See Also:

Constant Field Values

SIGNATURE_PKCS12_PASSWORD

public static final java.lang.String SIGNATURE_PKCS12_PASSWORD

See Also:

Constant Field Values

PDF2X_COPIES

public static final java.lang.String PDF2X_COPIES

Specifies the number of copies to be printed.

Default value: 1

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_MEDIA_SIZE_NAME

public static final java.lang.String PDF2X_MEDIA_SIZE_NAME

Specifies the media for a print job by name. Valid values are "a4", "letter", and "legal". When this property is not specified, the output media size is determined by the page definitions in the input PDF file. When this property is specified, a PDF page is scaled and rotated to fit to the specified media size.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_MEDIA_TRAY

public static final java.lang.String PDF2X_MEDIA_TRAY

Specifies the media tray or bin for the print job. Valid values are "manual" and "auto". Converter ignores this property when "pdf2x-media-size-name" is specified. When this property is not specified, printer selects appropriate tray based on page size.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_PAGE_ORIENTATION

public static final java.lang.String PDF2X_PAGE_ORIENTATION

Indicates the desired orientation for printed pages. Valid values are "portrait", "landscape", "reverse-portrait" and "reverse-landscape". This property is used to rotate media as desired when media size name is specified by user, therefore affects the output only when "pdf2x-media-size-name" is specified.

Default value: portrait

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_PAGE_RANGES

public static final java.lang.String PDF2X_PAGE_RANGES

Identifies the range(s) of PDF pages to be printed. Valid value is a string consists of zero or more comma-separated integer groups. Each integer group consists of either one integer, two integers separated by a hyphen (-), or two integers separated by a colon (:). Each integer consists of one or more decimal digits (0 through 9). For example: 1,5-10,1:2,4.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_SHEET_COLLATE

public static final java.lang.String PDF2X_SHEET_COLLATE

Specifies whether or not the media sheets of each copy of each printed document in a job are to be in sequence, when multiple copies of the document are specified by "pdf2x-copies". Printer determines collation when this property is not specfied and number of copies is > 1.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_SIDES

public static final java.lang.String PDF2X_SIDES

Specifies how print-stream pages are to be imposed upon the sides of an instance of a selected medium. Valid values are "one-sided", "duplex", and "tumble". When this property is not specified, printer determines whether using duplex mode or not. This property only indicates printing mode to be used by printers, and actual result may be different depending on printer's ability (printers may need duplex unit to be able to print on two sides of paper).

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_PS_CID_FONT_CONVTYPE

public static final java.lang.String PDF2X_PS_CID_FONT_CONVTYPE

When converting to Postscript and the PDF has embedded CID Font Type 2, this property determines whether converting the font to Postscript Type0 +Type42 fonts or Type0+Type3 fonts. Valid values are 42 or 3. Type42 is normally renders faster and produces better quality output. However, because of Postscript's internal limitation, error may occur when the font has large number of glyphs (> 32768). Type3 font does not have the limitation, but it is slower on most printers. Type3 font may still hit memory limitation when font has large number of glyphs.

Default value: 42

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_PAGE_WIDTH

public static final java.lang.String PDF2X_PAGE_WIDTH

Specifies the media width for a print job in point (1/72 inch). When this property is used, "pdf2x-media-height" also need to be set. Converter ignores this property when "pdf2x-media-size-name" is specified and does not work with "pdf2x-page-orientation". To make a landscape page, specify longer edge as page width.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

PDF2X_PAGE_HEIGHT

public static final java.lang.String PDF2X_PAGE_HEIGHT

Specifies the media height for a print job in point (1/72 inch). When this property is used, "pdf2x-page-width" also need to be set. Converter ignores this property when "pdf2x-media-name" is specified.

Default value: N/A

See Also:

Constant Field Values

FLASH_PAGE_WIDTH

public static final java.lang.String FLASH_PAGE_WIDTH

Specifies the wrapper document's page width Unit is point.

Default value: 792(Letter landscape)

Since:

10.1.3.3

See Also:

Constant Field Values

FLASH_PAGE_HEIGHT

public static final java.lang.String FLASH_PAGE_HEIGHT

Specifies the wrapper document's page height Unit is point.

Default value: 612(Letter landscape)

Since:

10.1.3.3

See Also:

Constant Field Values

FLASH_STARTX

public static final java.lang.String FLASH_STARTX

Specifies the start x position of flash area in the final output. Unit is point.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

FLASH_STARTY

public static final java.lang.String FLASH_STARTY

Specifies the start y position of flash area in the final output. Unit is point.

Default value: N/A

Since:

10.1.3.3

See Also:

Constant Field Values

FLASH_WIDTH

public static final java.lang.String FLASH_WIDTH

Specifies the width of Flash area. Unit is point.

Default value: 1

Since:

10.1.3.3

See Also:

Constant Field Values

FLASH_HEIGHT

public static final java.lang.String FLASH_HEIGHT

Specifies the height of Flash area. Unit is point.

Default value: 1

Since:

10.1.3.3

See Also:

Constant Field Values

CSV_DELIMITER

public static final java.lang.String CSV_DELIMITER

Specifies the csv delimiter.

Default value: 1

Since:

11.1.1.0

See Also:

Constant Field Values

PAGINATED_HTML_PATH

public static final java.lang.String PAGINATED_HTML_PATH

This property and value is required when generating a paginated HTML.

Default value: N/A

See Also:

Constant Field Values

FO_EXTERNAL_LINK_BASE_URL

public static final java.lang.String FO_EXTERNAL_LINK_BASE_URL

Specifies the default base url for all external links.

Default value: none

Since:

10.1.3.4

See Also:

Constant Field Values

FO_EXTERNAL_LINK_TARGET

public static final java.lang.String FO_EXTERNAL_LINK_TARGET

Specifies the default target for all external links.

Default value: none

Since:

10.1.3.4

See Also:

Constant Field Values

Constructor Detail

PropertyConstants

public PropertyConstants()