Package com.inet.pdfc.config

Enum Settings.EXPORT

java.lang.Object

java.lang.Enum<Settings.EXPORT>

com.inet.pdfc.config.Settings.EXPORT

All Implemented Interfaces:

VisibilitySetting, java.io.Serializable, java.lang.Comparable<Settings.EXPORT>

Enclosing interface:

Settings

public static enum Settings.EXPORT
extends java.lang.Enum<Settings.EXPORT>
implements VisibilitySetting

Settings to configure the export to PDF or image format. By default, all of these settings are enabled.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOPAGESSIZE	This option will cause the export pages to be automatically fitted to the content in width and height with a scale of 100%. It furthermore ignores the SCALETOPAGEHEIGHT setting and implies a 'scale to page' rendering result.
COMMENTS	Show the annotable in export
CREATE_DIFFIMAGES_FIRST	Specifies if a PNG image with the marked difference will be created.
CREATE_DIFFIMAGES_SECOND	Specifies if a PNG image with the marked difference will be created.
CREATE_ORIGIMAGES	Specifies if a PNG image with the original content will be created for each compared page.
CREATE_XORIMAGES	Creates an (negated) XOR image for any pair of pages with differences.
FOOTER	Add a footer per page
HEADER	Add a header per page
ONLY_ON_DIFFERENCES	Export the document if contain difference, all other didn't export
SCALETOPAGEHEIGHT	Fit first page to the PDFs to first exported page

Method Summary

Modifier and Type	Method	Description
java.lang.String	getTyp()	Return the enum typ for this setting/s
static Settings.EXPORT	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Settings.EXPORT[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inet.pdfc.config.VisibilitySetting

getTranslationKey, name

Enum Constant Detail

COMMENTS

public static final Settings.EXPORT COMMENTS

Show the annotable in export

HEADER

public static final Settings.EXPORT HEADER

Add a header per page

FOOTER

public static final Settings.EXPORT FOOTER

Add a footer per page

SCALETOPAGEHEIGHT

public static final Settings.EXPORT SCALETOPAGEHEIGHT

Fit first page to the PDFs to first exported page

AUTOPAGESSIZE

public static final Settings.EXPORT AUTOPAGESSIZE

This option will cause the export pages to be automatically fitted to the content in width and height with a scale of 100%.
It furthermore ignores the SCALETOPAGEHEIGHT setting and implies a 'scale to page' rendering result. This option will completely ignore the page size set to the export.

ONLY_ON_DIFFERENCES

public static final Settings.EXPORT ONLY_ON_DIFFERENCES

Export the document if contain difference, all other didn't export

CREATE_DIFFIMAGES_FIRST

public static final Settings.EXPORT CREATE_DIFFIMAGES_FIRST

Specifies if a PNG image with the marked difference will be created. Such a image will be created for for each pair of pages if there are differences in elements, contained in these pages. If this enabled to paint the original page (first document). If this enabled and CREATE_DIFFIMAGES_SECOND enable both pages will be paint

Since:

i-net PDFC 5.0

CREATE_DIFFIMAGES_SECOND

public static final Settings.EXPORT CREATE_DIFFIMAGES_SECOND

Specifies if a PNG image with the marked difference will be created. Such a image will be created for for each pair of pages if there are differences in elements, contained in these pages. If this enabled to paint the new page (second document). If this enabled and CREATE_DIFFIMAGES_FIRST enable both pages will be paint

Since:

i-net PDFC 5.0

CREATE_XORIMAGES

public static final Settings.EXPORT CREATE_XORIMAGES

Creates an (negated) XOR image for any pair of pages with differences. The image will be stored as an PNG in the differences directory of the current comparison. If CREATE_DIFFIMAGES_FIRST and CREATE_DIFFIMAGES_SECOND is enabled, the XOR image will be drawn onto the image created by CREATE_DIFFIMAGES between the two actual page images.

Since:

i-net PDFC 5.0

CREATE_ORIGIMAGES

public static final Settings.EXPORT CREATE_ORIGIMAGES

Specifies if a PNG image with the original content will be created for each compared page. The default value is: false.

Since:

i-net PDFC 5.0

Method Detail

values

public static Settings.EXPORT[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Settings.EXPORT c : Settings.EXPORT.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Settings.EXPORT valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getTyp

public java.lang.String getTyp()

Return the enum typ for this setting/s

Specified by:

getTyp in interface VisibilitySetting

Returns:

enum typ for this setting/s