ag.ion.bion.officelayer.filter
Class PDFFilterProperties

java.lang.Object
  ag.ion.bion.officelayer.filter.PDFFilterProperties

public class PDFFilterProperties
extends java.lang.Object

Contains PDF properties for exporting an OpenOffice.org document to PDF.

Constructor Summary

PDFFilterProperties()

Method Summary

com.sun.star.beans.PropertyValue[]	getAdditionalPropertyValues() Returns the additional property values.
boolean	getCenterWindow() Returns if the PDF viewer window is centered to the screen when the PDF document is opened.
int	getChangesMode() Returns the changes mode allowed to the document: 0: PDF document cannot be changed 1: Inserting, deleting and rotating pages is allowed 2: Filling of form field is allowed 3: Filling of form field and commenting is allowed 4: All the changes of the previous selections are permitted, with the only exclusion of page extraction
java.lang.String	getDocumentOpenPassword() Returns the password you must know to open the PDF document, or null if no document open password is set.
boolean	getEnableCopyingOfContent() Returns if the pages and the PDF document content can be extracted to be used in other documents: Copy from the PDF document and paste eleswhere.
boolean	getEnableTextAccessForAccessibilityTools() Returns if the PDF document content can be extracted to be used in accessibility applications.
boolean	getExportFormFields() Returns whether form fields are exported as widgets or only their fixed print representation is exported.
int	getMagnificationMode() Returns the magnification to be performed when the PDF document is opened: 0: Opens with default zoom magnification 1: Opens magnified to fit the entire page within the window 2: Opens magnified to fit the entire page width within the window 3: Opens magnified to fit the entire width of its boundig box within the window (cuts out margins) 4: Opens with a zoom level given in the ueZoomue property.
int	getMaxImageResolution() Returns the DPI to reduce images to.
java.lang.String	getPageRange() Returns which pages are exported to the PDF document.
int	getPdfVersion() Returns the PDF version that should be generated: 0: PDF 1.4 (default selection) 1: PDF/A-1 (ISO 19005-1:2005).
java.lang.String	getPermissionPassword() Returns the password that a user will need to change the permissions of the exported PDF, or null if no permission password is set.
int	getPictureQuality() Returns the quality of the JPG export in a range from 0 to 100.
int	getPrintingMode() Returns the printing mode of the document: 0: PDF document cannot be printed 1: PDF document can be printed at low resolution only 2: PDF document can be printed at maximum resolution
boolean	getSkipEmptyPages() Returns if automatically inserted empty pages are suppressed.
int	getZoom() Returns the zoom level between 50 and 1600 a PDF document is opened with.
void	setAdditionalPropertyValues(com.sun.star.beans.PropertyValue[] additionalProps) Set the additional property values that can be used for properties not covered by this class.
void	setCenterWindow(boolean centerWindow) Set if the PDF viewer window is centered to the screen when the PDF document is opened.
void	setChangesMode(int changesMode) Set the changes mode allowed to the document: 0: PDF document cannot be changed 1: Inserting, deleting and rotating pages is allowed 2: Filling of form field is allowed 3: Filling of form field and commenting is allowed 4: All the changes of the previous selections are permitted, with the only exclusion of page extraction
void	setDocumentOpenPassword(java.lang.String documentOpenPassword) Set the password you must know to open the PDF document.
void	setEnableCopyingOfContent(boolean enableCopyingOfContent) Set if the pages and the PDF document content can be extracted to be used in other documents: Copy from the PDF document and paste eleswhere.
void	setEnableTextAccessForAccessibilityTools(boolean enableTextAccessForAccessibilityTools) Set if the PDF document content can be extracted to be used in accessibility applications.
void	setExportFormFields(boolean exportFormFields) Set whether form fields are exported as widgets or only their fixed print representation is exported.
void	setMagnificationMode(int magnificationMode) Set the magnification to be performed when the PDF document is opened: 0: Opens with default zoom magnification 1: Opens magnified to fit the entire page within the window 2: Opens magnified to fit the entire page width within the window 3: Opens magnified to fit the entire width of its boundig box within the window (cuts out margins) 4: Opens with a zoom level given in the ueZoomue property.
void	setMaxImageResolution(int maxImageResolution) Set the DPI to reduce images to.
void	setPageRange(java.lang.String pageRange) Set which pages are exported to the PDF document.
void	setPdfVersion(int pdfVersion) Set the PDF version that should be generated: 0: PDF 1.4 (default selection) 1: PDF/A-1 (ISO 19005-1:2005).
void	setPermissionPassword(java.lang.String permissionPassword) Set the password that a user will need to change the permissions of the exported PDF.
void	setPictureQuality(int quality) Set the quality of the JPG export in a range from 0 to 100.
void	setPrintingMode(int printingMode) Set the printing mode of the document: 0: PDF document cannot be printed 1: PDF document can be printed at low resolution only 2: PDF document can be printed at maximum resolution
void	setSkipEmptyPages(boolean skipEmptyPages) Set if automatically inserted empty pages are suppressed.
void	setZoom(int zoom) Set the zoom level between 50 and 1600 a PDF document is opened with.
com.sun.star.beans.PropertyValue[]	toPropertyValues() Returns the property values of this properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFFilterProperties

public PDFFilterProperties()

Method Detail

getPermissionPassword

public java.lang.String getPermissionPassword()

Returns the password that a user will need to change the permissions of the exported PDF, or null if no permission password is set. The password is in clear text.

Returns:

the password that a user will need to change the permissions of the exported PDF, or null if no permission password is set

setPermissionPassword

public void setPermissionPassword(java.lang.String permissionPassword)

Set the password that a user will need to change the permissions of the exported PDF. The password should be in clear text.

Parameters:

permissionPassword - the clear test password to be used, or null to not use a permission password

getDocumentOpenPassword

public java.lang.String getDocumentOpenPassword()

Returns the password you must know to open the PDF document, or null if no document open password is set. The password is in clear text.

Returns:

the password you must know to open the PDF document, or null if no document open password is set

setDocumentOpenPassword

public void setDocumentOpenPassword(java.lang.String documentOpenPassword)

Set the password you must know to open the PDF document. The password should be in clear text.

Parameters:

documentOpenPassword - the clear test password to be used, or null to not use a document open password

getPrintingMode

public int getPrintingMode()

Returns the printing mode of the document: 0: PDF document cannot be printed 1: PDF document can be printed at low resolution only 2: PDF document can be printed at maximum resolution

Returns:

the printing mode

setPrintingMode

public void setPrintingMode(int printingMode)

Set the printing mode of the document: 0: PDF document cannot be printed 1: PDF document can be printed at low resolution only 2: PDF document can be printed at maximum resolution

Parameters:

printingMode - the printing mode to be set

getChangesMode

public int getChangesMode()

Returns the changes mode allowed to the document: 0: PDF document cannot be changed 1: Inserting, deleting and rotating pages is allowed 2: Filling of form field is allowed 3: Filling of form field and commenting is allowed 4: All the changes of the previous selections are permitted, with the only exclusion of page extraction

Returns:

the changes mode

setChangesMode

public void setChangesMode(int changesMode)

Set the changes mode allowed to the document: 0: PDF document cannot be changed 1: Inserting, deleting and rotating pages is allowed 2: Filling of form field is allowed 3: Filling of form field and commenting is allowed 4: All the changes of the previous selections are permitted, with the only exclusion of page extraction

Parameters:

changesMode - the changes mode to be set

getEnableCopyingOfContent

public boolean getEnableCopyingOfContent()

Returns if the pages and the PDF document content can be extracted to be used in other documents: Copy from the PDF document and paste eleswhere.

Returns:

if the pages and the PDF document content can be extracted to be used in other documents: Copy from the PDF document and paste eleswhere

setEnableCopyingOfContent

public void setEnableCopyingOfContent(boolean enableCopyingOfContent)

Set if the pages and the PDF document content can be extracted to be used in other documents: Copy from the PDF document and paste eleswhere.

Parameters:

enableCopyingOfContent - if the pages and the PDF document content can be extracted to be used in other documents

getEnableTextAccessForAccessibilityTools

public boolean getEnableTextAccessForAccessibilityTools()

Returns if the PDF document content can be extracted to be used in accessibility applications.

Returns:

if the PDF document content can be extracted to be used in accessibility applications

setEnableTextAccessForAccessibilityTools

public void setEnableTextAccessForAccessibilityTools(boolean enableTextAccessForAccessibilityTools)

Set if the PDF document content can be extracted to be used in accessibility applications.

Parameters:

enableTextAccessForAccessibilityTools - if the PDF document content can be extracted to be used in accessibility applications

getPageRange

public java.lang.String getPageRange()

Returns which pages are exported to the PDF document. To export a range of pages, use the format 3-6. To export single pages, use the format 7;9;11. Specify a combination of page ranges and single pages by using a format like 2-4;6. If the document has less pages than defined in the range, the result might be the exception "com.sun.star.task.ErrorCodeIOException". This exception occured for example by using an ODT file with only one page and a page range of "2-4;6;8-10". Changing the page range to "1" prevented this exception. For no apparent reason the exception didn't occure by using an ODT file with two pages and a page range of "2-4;6;8-10". Can return null if no range is specified.

Returns:

which pages are exported to the PDF document, or null

setPageRange

public void setPageRange(java.lang.String pageRange)

Set which pages are exported to the PDF document. To export a range of pages, use the format 3-6. To export single pages, use the format 7;9;11. Specify a combination of page ranges and single pages by using a format like 2-4;6. If the document has less pages than defined in the range, the result might be the exception "com.sun.star.task.ErrorCodeIOException". This exception occured for example by using an ODT file with only one page and a page range of "2-4;6;8-10". Changing the page range to "1" prevented this exception. For no apparent reason the exception didn't occure by using an ODT file with two pages and a page range of "2-4;6;8-10". Can be set to null to not specify a range and print all pages.

Parameters:

enableTextAccessForAccessibilityTools - if the PDF document content can be extracted to be used in accessibility applications

getPictureQuality

public int getPictureQuality()

Returns the quality of the JPG export in a range from 0 to 100. A higher value results in higher quality and file size. The value 100 results in a lossless compression.

Returns:

the quality of the JPG export in a range from 0 to 100

setPictureQuality

public void setPictureQuality(int quality)

Set the quality of the JPG export in a range from 0 to 100. A higher value results in higher quality and file size. The value 100 results in a lossless compression.

Parameters:

quality - the quality of the JPG export in a range from 0 to 100

getMaxImageResolution

public int getMaxImageResolution()

Returns the DPI to reduce images to. If not -1 then all images will be reduced to the given value in DPI. If -1 then no reduction will be used. Allowed values are -1, 75, 150, 300, 600, 1200 return the DPI to reduce images to, or -1 to not reduce

setMaxImageResolution

public void setMaxImageResolution(int maxImageResolution)

Set the DPI to reduce images to. If not -1 then all images will be reduced to the given value in DPI. If -1 then no reduction will be used. Allowed values are -1, 75, 150, 300, 600, 1200

Parameters:

maxImageResolution - the DPI to reduce images to, or -1 to not reduce

getExportFormFields

public boolean getExportFormFields()

Returns whether form fields are exported as widgets or only their fixed print representation is exported.

Returns:

whether form fields are exported as widgets or only their fixed print representation is exported

setExportFormFields

public void setExportFormFields(boolean exportFormFields)

Set whether form fields are exported as widgets or only their fixed print representation is exported.

Parameters:

exportFormFields - whether form fields are exported as widgets or only their fixed print representation is exported

getCenterWindow

public boolean getCenterWindow()

Returns if the PDF viewer window is centered to the screen when the PDF document is opened.

Returns:

if the PDF viewer window is centered to the screen when the PDF document is opened

setCenterWindow

public void setCenterWindow(boolean centerWindow)

Set if the PDF viewer window is centered to the screen when the PDF document is opened.

Parameters:

centerWindow - if the PDF viewer window is centered to the screen when the PDF document is opened

getMagnificationMode

public int getMagnificationMode()

Returns the magnification to be performed when the PDF document is opened: 0: Opens with default zoom magnification 1: Opens magnified to fit the entire page within the window 2: Opens magnified to fit the entire page width within the window 3: Opens magnified to fit the entire width of its boundig box within the window (cuts out margins) 4: Opens with a zoom level given in the ueZoomue property.

Returns:

the magnification to be performed when the PDF document is opened

setMagnificationMode

public void setMagnificationMode(int magnificationMode)

Set the magnification to be performed when the PDF document is opened: 0: Opens with default zoom magnification 1: Opens magnified to fit the entire page within the window 2: Opens magnified to fit the entire page width within the window 3: Opens magnified to fit the entire width of its boundig box within the window (cuts out margins) 4: Opens with a zoom level given in the ueZoomue property.

Parameters:

magnificationMode - the magnification to be performed when the PDF document is opened

getZoom

public int getZoom()

Returns the zoom level between 50 and 1600 a PDF document is opened with. Only valid if the magnification mode is set to 4.

Returns:

the zoom level between 50 and 1600 a PDF document is opened with. Only valid if the magnification mode is set to 4

setZoom

public void setZoom(int zoom)

Set the zoom level between 50 and 1600 a PDF document is opened with. Only valid if the magnification mode is set to 4.

Parameters:

zoom - the zoom level between 50 and 1600 a PDF document is opened with

getSkipEmptyPages

public boolean getSkipEmptyPages()

Returns if automatically inserted empty pages are suppressed. This option only applies for storing Writer documents.

Returns:

if automatically inserted empty pages are suppressed. This option only applies for storing Writer documents

setSkipEmptyPages

public void setSkipEmptyPages(boolean skipEmptyPages)

Set if automatically inserted empty pages are suppressed. This option only applies for storing Writer documents.

Parameters:

skipEmptyPages - if automatically inserted empty pages are suppressed

getPdfVersion

public int getPdfVersion()

Returns the PDF version that should be generated: 0: PDF 1.4 (default selection) 1: PDF/A-1 (ISO 19005-1:2005).

Returns:

the PDF version that should be generated

setPdfVersion

public void setPdfVersion(int pdfVersion)

Set the PDF version that should be generated: 0: PDF 1.4 (default selection) 1: PDF/A-1 (ISO 19005-1:2005).

Parameters:

pdfVersion - the PDF version that should be generated

getAdditionalPropertyValues

public com.sun.star.beans.PropertyValue[] getAdditionalPropertyValues()

Returns the additional property values.

Returns:

the additional property values

setAdditionalPropertyValues

public void setAdditionalPropertyValues(com.sun.star.beans.PropertyValue[] additionalProps)

Set the additional property values that can be used for properties not covered by this class.

Parameters:

additionalProps - the additional property values that are not covered by this class

toPropertyValues

public com.sun.star.beans.PropertyValue[] toPropertyValues()

Returns the property values of this properties.

Returns:

the property values of this properties