com.qoppa.pdfWeb

Class SVGOptions

java.lang.Object

com.qoppa.pdfWeb.SVGOptions

public class SVGOptions
extends Object

The SVGOptions class holds settings to control SVG output from a PDF file.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SVGOptions.FontFormat Font format options
static class	SVGOptions.FontPlan Font conversion options
static class	SVGOptions.ImagePlan Image conversion options
static class	SVGOptions.ZoomMode Zoom mode options

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATION_TYPE_AREA
static String	ANNOTATION_TYPE_ARROW
static String	ANNOTATION_TYPE_CALLOUT
static String	ANNOTATION_TYPE_CARET
static String	ANNOTATION_TYPE_CIRCLE
static String	ANNOTATION_TYPE_CLOUD
static String	ANNOTATION_TYPE_CROSSOUT
static String	ANNOTATION_TYPE_DISTANCE
static String	ANNOTATION_TYPE_FILEATTACHMENT
static String	ANNOTATION_TYPE_FREETEXT
static String	ANNOTATION_TYPE_HIGHLIGHT
static String	ANNOTATION_TYPE_INK
static String	ANNOTATION_TYPE_LINE
static String	ANNOTATION_TYPE_LINK
static String	ANNOTATION_TYPE_PERIMETER
static String	ANNOTATION_TYPE_POLYGON
static String	ANNOTATION_TYPE_POLYLINE
static String	ANNOTATION_TYPE_REDACTION
static String	ANNOTATION_TYPE_REPLACE
static String	ANNOTATION_TYPE_RUBBERSTAMP
static String	ANNOTATION_TYPE_SHAPE ANNOTATION_TYPE_SHAPE can be used to indicate allowing all of the following types: ANNOTATION_TYPE_CIRCLE ANNOTATION_TYPE_ARROW ANNOTATION_TYPE_DISTANCE ANNOTATION_TYPE_LINE ANNOTATION_TYPE_SQUARE ANNOTATION_TYPE_INK ANNOTATION_TYPE_AREA ANNOTATION_TYPE_CLOUD ANNOTATION_TYPE_POLYGON ANNOTATION_TYPE_PERIMETER ANNOTATION_TYPE_POLYLINE ANNOTATION_TYPE_REDACTION ANNOTATION_TYPE_FREETEXT ANNOTATION_TYPE_CALLOUT ANNOTATION_TYPE_TYPEWRITER
static String	ANNOTATION_TYPE_SOUND
static String	ANNOTATION_TYPE_SQUARE
static String	ANNOTATION_TYPE_SQUIGGLY
static String	ANNOTATION_TYPE_TEXT
static String	ANNOTATION_TYPE_TEXTMARKUP ANNOTATION_TYPE_TEXTMARKUP can be used to indicate allowing all of the following types: ANNOTATION_TYPE_HIGHLIGHT ANNOTATION_TYPE_UNDERLINE ANNOTATION_TYPE_SQUIGGLY ANNOTATION_TYPE_CROSSOUT ANNOTATION_TYPE_REPLACE
static String	ANNOTATION_TYPE_TYPEWRITER
static String	ANNOTATION_TYPE_UNDERLINE
static String	FIELD_TYPE_CHECKBOX
static String	FIELD_TYPE_COMBOBOX
static String	FIELD_TYPE_LIST
static String	FIELD_TYPE_PUSHBUTTON
static String	FIELD_TYPE_RADIOBUTTON
static String	FIELD_TYPE_SIGNATURE
static String	FIELD_TYPE_TEXTFIELD

Constructor Summary

Constructors

Constructor and Description
SVGOptions() SVGOptions - default constructor

Method Summary

Modifier and Type	Method and Description
boolean	getDisplayAnnotations() Returns flag for whether to display PDF annotations in generated SVG.
Vector<String>	getDisplayAnnotationTypes() Returns a vector of the current subset of annotation types to display.
boolean	getDisplayFields() Returns flag for whether to display PDF fields in generated SVG.
Vector<String>	getDisplayFieldTypes() Returns a vector of the current subset of field types to display.
String	getExtraOption(String key) Returns value string for a specific "extra option"
SVGOptions.FontFormat	getFontFormat() Returns current setting for font format in generated SVG.
SVGOptions.FontPlan	getFontPlan() Returns current font plan setting.
SVGOptions.ImagePlan	getImagePlan() Returns current setting for image generation in generated SVG.
boolean	getJPEGCompression() Returns current JPEG compression flag setting.
double	getJPEGQuality() Returns current JPEG compression quality value See setJPEGQuality method for discussion of values.
float	getMinStrokeWidth() Returns the minimum stroke width used when converting to SVG.
boolean	getPageBorder()
SVGOptions.ZoomMode	getZoomMode() Gets the zoom mode for single pages.
boolean	isEnforceExtractPermission() Returns true if permission to extract text and graphics will be enforced when converting from PDF to SVG.
boolean	isRenderSignatureVerify() This method returns the value of the flag that controls whether signature verification will be rendered.
void	setDisplayAnnotations(boolean value) Sets flag to control if PDF annotations are converted and displayed in generated SVG.
void	setDisplayAnnotationTypes(Vector<String> displaySubset) Set a subset of annotation types that should be displayed when getDisplayAnnotations() is set to true.
void	setDisplayFields(boolean value) Sets flag to control if PDF fields are converted and displayed in generated SVG.
void	setDisplayFieldTypes(Vector<String> displaySubset) Set a subset of field types that should be displayed when getDisplayFields() is set to true.
void	setEnforceExtractPermission(boolean enforceExtractPermission) By default, permission to extract text and graphics will not be enforced when converting from PDF to SVG.
void	setExtraOption(String key, String value) Sets "extra" option value.
void	setFontFormat(SVGOptions.FontFormat value) Sets value to control how fonts are formatted for SVG.
void	setFontPlan(SVGOptions.FontPlan value) Sets value to control how fonts are handled for generated SVG.
void	setImagePlan(SVGOptions.ImagePlan value) Sets value to control how images are generated for SVG.
void	setJPEGCompression(boolean value) Sets flag to control if JPEG compression will be used for images where possible.
void	setJPEGQuality(double value) Sets a numeric (0.0 - 1.0) value that controls JPEG compression operation.
void	setMinStrokeWidth(float minWidth) Sets the minimum stroke width for shapes when converting to SVG.
void	setPageBorder(boolean value) Sets flag to control if a thin black page border graphic line is generated in SVG output.
void	setRenderSignatureVerification(boolean renderSignatureVerify) This method sets the value of the flag that controls whether signature verification will be rendered.
void	setZoomMode(SVGOptions.ZoomMode value) Sets the zoom mode for single pages.

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATION_TYPE_CIRCLE

public static final String ANNOTATION_TYPE_CIRCLE

See Also:

Constant Field Values

ANNOTATION_TYPE_ARROW

public static final String ANNOTATION_TYPE_ARROW

See Also:

Constant Field Values

ANNOTATION_TYPE_DISTANCE

public static final String ANNOTATION_TYPE_DISTANCE

See Also:

Constant Field Values

ANNOTATION_TYPE_LINE

public static final String ANNOTATION_TYPE_LINE

See Also:

Constant Field Values

ANNOTATION_TYPE_SQUARE

public static final String ANNOTATION_TYPE_SQUARE

See Also:

Constant Field Values

ANNOTATION_TYPE_INK

public static final String ANNOTATION_TYPE_INK

See Also:

Constant Field Values

ANNOTATION_TYPE_AREA

public static final String ANNOTATION_TYPE_AREA

See Also:

Constant Field Values

ANNOTATION_TYPE_CLOUD

public static final String ANNOTATION_TYPE_CLOUD

See Also:

Constant Field Values

ANNOTATION_TYPE_POLYGON

public static final String ANNOTATION_TYPE_POLYGON

See Also:

Constant Field Values

ANNOTATION_TYPE_PERIMETER

public static final String ANNOTATION_TYPE_PERIMETER

See Also:

Constant Field Values

ANNOTATION_TYPE_POLYLINE

public static final String ANNOTATION_TYPE_POLYLINE

See Also:

Constant Field Values

ANNOTATION_TYPE_REDACTION

public static final String ANNOTATION_TYPE_REDACTION

See Also:

Constant Field Values

ANNOTATION_TYPE_FREETEXT

public static final String ANNOTATION_TYPE_FREETEXT

See Also:

Constant Field Values

ANNOTATION_TYPE_CALLOUT

public static final String ANNOTATION_TYPE_CALLOUT

See Also:

Constant Field Values

ANNOTATION_TYPE_TYPEWRITER

public static final String ANNOTATION_TYPE_TYPEWRITER

See Also:

Constant Field Values

ANNOTATION_TYPE_SHAPE

public static final String ANNOTATION_TYPE_SHAPE

ANNOTATION_TYPE_SHAPE can be used to indicate allowing all of the following types: ANNOTATION_TYPE_CIRCLE ANNOTATION_TYPE_ARROW ANNOTATION_TYPE_DISTANCE ANNOTATION_TYPE_LINE ANNOTATION_TYPE_SQUARE ANNOTATION_TYPE_INK ANNOTATION_TYPE_AREA ANNOTATION_TYPE_CLOUD ANNOTATION_TYPE_POLYGON ANNOTATION_TYPE_PERIMETER ANNOTATION_TYPE_POLYLINE ANNOTATION_TYPE_REDACTION ANNOTATION_TYPE_FREETEXT ANNOTATION_TYPE_CALLOUT ANNOTATION_TYPE_TYPEWRITER

See Also:

Constant Field Values

ANNOTATION_TYPE_RUBBERSTAMP

public static final String ANNOTATION_TYPE_RUBBERSTAMP

See Also:

Constant Field Values

ANNOTATION_TYPE_TEXT

public static final String ANNOTATION_TYPE_TEXT

See Also:

Constant Field Values

ANNOTATION_TYPE_HIGHLIGHT

public static final String ANNOTATION_TYPE_HIGHLIGHT

See Also:

Constant Field Values

ANNOTATION_TYPE_UNDERLINE

public static final String ANNOTATION_TYPE_UNDERLINE

See Also:

Constant Field Values

ANNOTATION_TYPE_SQUIGGLY

public static final String ANNOTATION_TYPE_SQUIGGLY

See Also:

Constant Field Values

ANNOTATION_TYPE_CROSSOUT

public static final String ANNOTATION_TYPE_CROSSOUT

See Also:

Constant Field Values

ANNOTATION_TYPE_REPLACE

public static final String ANNOTATION_TYPE_REPLACE

See Also:

Constant Field Values

ANNOTATION_TYPE_TEXTMARKUP

public static final String ANNOTATION_TYPE_TEXTMARKUP

ANNOTATION_TYPE_TEXTMARKUP can be used to indicate allowing all of the following types: ANNOTATION_TYPE_HIGHLIGHT ANNOTATION_TYPE_UNDERLINE ANNOTATION_TYPE_SQUIGGLY ANNOTATION_TYPE_CROSSOUT ANNOTATION_TYPE_REPLACE

See Also:

Constant Field Values

ANNOTATION_TYPE_FILEATTACHMENT

public static final String ANNOTATION_TYPE_FILEATTACHMENT

See Also:

Constant Field Values

ANNOTATION_TYPE_LINK

public static final String ANNOTATION_TYPE_LINK

See Also:

Constant Field Values

ANNOTATION_TYPE_SOUND

public static final String ANNOTATION_TYPE_SOUND

See Also:

Constant Field Values

ANNOTATION_TYPE_CARET

public static final String ANNOTATION_TYPE_CARET

See Also:

Constant Field Values

FIELD_TYPE_CHECKBOX

public static final String FIELD_TYPE_CHECKBOX

See Also:

Constant Field Values

FIELD_TYPE_COMBOBOX

public static final String FIELD_TYPE_COMBOBOX

See Also:

Constant Field Values

FIELD_TYPE_LIST

public static final String FIELD_TYPE_LIST

See Also:

Constant Field Values

FIELD_TYPE_PUSHBUTTON

public static final String FIELD_TYPE_PUSHBUTTON

See Also:

Constant Field Values

FIELD_TYPE_RADIOBUTTON

public static final String FIELD_TYPE_RADIOBUTTON

See Also:

Constant Field Values

FIELD_TYPE_SIGNATURE

public static final String FIELD_TYPE_SIGNATURE

See Also:

Constant Field Values

FIELD_TYPE_TEXTFIELD

public static final String FIELD_TYPE_TEXTFIELD

See Also:

Constant Field Values

Constructor Detail

SVGOptions

public SVGOptions()

SVGOptions - default constructor

Method Detail

setExtraOption

public void setExtraOption(String key,
                           String value)

Sets "extra" option value. Extra options are options without a specific API set via a key=value mechanism. Current extra options:

Key	Values	Description
Readable	"true", "false"	Enables or disables adding tab and end-of-line characters in generated SVG. Default = "false"
TextFidelity	"Display", "TextExtract"	"Display" is the default text fidelity - text is converted so that it will display with fidelity to the original PDF file. "TextExtract" fidelity will convert text so that it can be extracted (by copying) as best possible, but it may not display correctly.
TextCombining	"true", "false"	Controls whether SVG text elements are combined to reduce SVG file size when text lines are broken into multiple text objects. "false" disables text element combining. Default = "true" (added v2016R2.02)

Parameters:

key - Extra option key name string.

value - Extra option value string.

getExtraOption

public String getExtraOption(String key)

Returns value string for a specific "extra option"

Parameters:

key - Extra option key name string.

Returns:

String Object containing value for extra option.

setFontPlan

public void setFontPlan(SVGOptions.FontPlan value)

Sets value to control how fonts are handled for generated SVG. See FontPlan for font plan value descriptions. Default: FontPlan.EmbedSubset - to embed subset for each used font

Parameters:

value - FontPlan enum value

getFontPlan

public SVGOptions.FontPlan getFontPlan()

Returns current font plan setting. See FontPlan for font plan value descriptions.

Returns:

FontPlan Object with current font plan value.

setFontFormat

public void setFontFormat(SVGOptions.FontFormat value)

Sets value to control how fonts are formatted for SVG. See FontFormat for font format value descriptions. Default: FontPlan.WOFF1 - for WOFF v1 format TrueType fonts

Parameters:

value - FontFormat enum value

getFontFormat

public SVGOptions.FontFormat getFontFormat()

Returns current setting for font format in generated SVG. See FontFormat for font format value descriptions.

Returns:

FontFormat Object with current font format value.

setPageBorder

public void setPageBorder(boolean value)

Sets flag to control if a thin black page border graphic line is generated in SVG output. Default: false

Parameters:

value - Page border draw setting flag

getPageBorder

public boolean getPageBorder()

setImagePlan

public void setImagePlan(SVGOptions.ImagePlan value)

Sets value to control how images are generated for SVG. See ImagePlan for image plan value descriptions. Default: ImagePlan.Embed - convert images and embed in SVG output stream

Parameters:

value - ImagePlan enum value

getImagePlan

public SVGOptions.ImagePlan getImagePlan()

Returns current setting for image generation in generated SVG. See ImagePlan for image plan value descriptions.

Returns:

ImagePlan Object with current image plan value.

setJPEGCompression

public void setJPEGCompression(boolean value)

Sets flag to control if JPEG compression will be used for images where possible. If not set then all images will be generated using PNG compression. Using JPEG compression can reduce the size of image data in SVG by using lossy compression. The JPEGQuality methods in this object can be used to control quality -vs- compression for JPEG compression. NOTE: Bitonal (1-bit) images and images using transparency cannot be represented using JPEG compression and will always be generated using PNG compression. Default: true

Parameters:

value - JPEG compression flag

getJPEGCompression

public boolean getJPEGCompression()

Returns current JPEG compression flag setting. See setJPEGCompression method for discussion of this flag.

Returns:

JPEG compression flag

setJPEGQuality

public void setJPEGQuality(double value)

Sets a numeric (0.0 - 1.0) value that controls JPEG compression operation. Lower values (closer to 0.0) will result in higher fidelity to the original image and less image compression (larger data size). Higher values (closer to 1.0) will result in lower fidelity to the original image and more image compression (smaller data size). Default: 0.5

Parameters:

value - JPEG quality value

getJPEGQuality

public double getJPEGQuality()

Returns current JPEG compression quality value See setJPEGQuality method for discussion of values.

Returns:

JPEG quality value

setDisplayAnnotations

public void setDisplayAnnotations(boolean value)

Sets flag to control if PDF annotations are converted and displayed in generated SVG. Default: true

Parameters:

value - Display annotations flag

getDisplayAnnotations

public boolean getDisplayAnnotations()

Returns flag for whether to display PDF annotations in generated SVG. See setDisplayAnnotations method for discussion of this flag.

Returns:

Display annotations flag

setDisplayAnnotationTypes

public void setDisplayAnnotationTypes(Vector<String> displaySubset)

Set a subset of annotation types that should be displayed when getDisplayAnnotations() is set to true. Set this to null to display all annotations (the default setting). The Strings in this Vector should be any number of the following: ANNOTATION_TYPE_CIRCLE ANNOTATION_TYPE_ARROW ANNOTATION_TYPE_DISTANCE ANNOTATION_TYPE_LINE ANNOTATION_TYPE_SQUARE ANNOTATION_TYPE_INK ANNOTATION_TYPE_AREA ANNOTATION_TYPE_CLOUD ANNOTATION_TYPE_POLYGON ANNOTATION_TYPE_PERIMETER ANNOTATION_TYPE_POLYLINE ANNOTATION_TYPE_REDACTION ANNOTATION_TYPE_FREETEXT ANNOTATION_TYPE_CALLOUT ANNOTATION_TYPE_TYPEWRITER ANNOTATION_TYPE_SHAPE ANNOTATION_TYPE_RUBBERSTAMP ANNOTATION_TYPE_TEXT ANNOTATION_TYPE_HIGHLIGHT ANNOTATION_TYPE_UNDERLINE ANNOTATION_TYPE_SQUIGGLY ANNOTATION_TYPE_CROSSOUT ANNOTATION_TYPE_REPLACE ANNOTATION_TYPE_TEXTMARKUP ANNOTATION_TYPE_FILEATTACHMENT ANNOTATION_TYPE_LINK ANNOTATION_TYPE_SOUND ANNOTATION_TYPE_CARET

Parameters:

displaySubset -

getDisplayAnnotationTypes

public Vector<String> getDisplayAnnotationTypes()

Returns a vector of the current subset of annotation types to display. If null, display all annotation types.

Returns:

vector of displayable annotation types

setDisplayFieldTypes

public void setDisplayFieldTypes(Vector<String> displaySubset)

Set a subset of field types that should be displayed when getDisplayFields() is set to true. Set this to null to display all fields (the default setting). The Strings in this Vector should be any number of the following: FIELD_TYPE_CHECKBOX FIELD_TYPE_COMBOBOX FIELD_TYPE_LIST FIELD_TYPE_PUSHBUTTON FIELD_TYPE_RADIOBUTTON FIELD_TYPE_SIGNATURE FIELD_TYPE_TEXTFIELD

Parameters:

displaySubset -

getDisplayFieldTypes

public Vector<String> getDisplayFieldTypes()

Returns a vector of the current subset of field types to display. If null, display all field types.

Returns:

vector of displayable field types

setDisplayFields

public void setDisplayFields(boolean value)

Sets flag to control if PDF fields are converted and displayed in generated SVG. Default: true

Parameters:

value - Display fields flag

getDisplayFields

public boolean getDisplayFields()

Returns flag for whether to display PDF fields in generated SVG. See setDisplayFields method for discussion of this flag.

Returns:

Display fields flag

setZoomMode

public void setZoomMode(SVGOptions.ZoomMode value)

Sets the zoom mode for single pages. See ZoomMode for zoom mode descriptions. Default: ZoomMode.Normal - the scale remains the same when the viewer is resized.

Parameters:

value - ZoomMode enum value

getZoomMode

public SVGOptions.ZoomMode getZoomMode()

Gets the zoom mode for single pages. See ZoomMode for zoom mode descriptions.

Returns:

ZoomMode enum value

setMinStrokeWidth

public void setMinStrokeWidth(float minWidth)

Sets the minimum stroke width for shapes when converting to SVG. In PDF, lines can have a width of 0, and most PDF viewers will display the lines anyways. However, if the lines are converted with 0 width, it seems that most browsers will not display them at all. This value sets the minimum width for lines, so that if the line has a width less than this value, it will be reset to this value.

Parameters:

minWidth -

getMinStrokeWidth

public float getMinStrokeWidth()

Returns the minimum stroke width used when converting to SVG.

Returns:

setRenderSignatureVerification

public void setRenderSignatureVerification(boolean renderSignatureVerify)

This method sets the value of the flag that controls whether signature verification will be rendered. When this flag is true, the renderer will show an icon on the signature field representing the results of the signature verification. The default value is true.

Parameters:

renderSignatureVerify - The new value of the flag

isRenderSignatureVerify

public boolean isRenderSignatureVerify()

This method returns the value of the flag that controls whether signature verification will be rendered. When this flag is true, the renderer will show an icon on the signature field representing the results of the signature verification. The default value is true.

Returns:

The value of the flag that controls rendering of signature verification

setEnforceExtractPermission

public void setEnforceExtractPermission(boolean enforceExtractPermission)

By default, permission to extract text and graphics will not be enforced when converting from PDF to SVG. Set this flag to true to enforce this permission so conversion will fail on documents that do not have this permission.

Parameters:

enforceExtractPermission - Set to true to enforce extract text and graphics permissions when converting from PDF to SVG.

isEnforceExtractPermission

public boolean isEnforceExtractPermission()

Returns true if permission to extract text and graphics will be enforced when converting from PDF to SVG.

Returns:

true if permission to extract text and graphics will be enforced when converting from PDF to SVG.