Class ContentOptions
-
Constructor Summary
ConstructorsConstructorDescriptionContentOptions
(String options) ContentOptions
(Map<String, String> jvmOptions) -
Method Summary
Modifier and TypeMethodDescriptionvoid
setCompleteDocument
(boolean value) Enabling this setting will output html, head and body tags.void
setContainerId
(String value) Set the id to use for the page container div.void
setFirstPageName
(String value) Deprecated.We do not recommend that this option be used.void
setGenerateSearchFile
(boolean value) Generates search.json.void
setOutputThumbnails
(boolean value) Output thumbnails of pages in /thumbnails/.void
setThumbnailMaxHeight
(int value) Sets the maximum height of the thumbnails.void
setThumbnailMaxWidth
(int value) Sets the maximum width of the thumbnails.Methods inherited from class org.jpedal.render.output.OutputModeOptions
getBooleanValue, getErrors, getStringValue
-
Constructor Details
-
ContentOptions
-
ContentOptions
public ContentOptions() -
ContentOptions
-
-
Method Details
-
setCompleteDocument
public void setCompleteDocument(boolean value) Enabling this setting will output html, head and body tags.This mode is recommended if content will be displayed within iframes.
This setting has no behavior in SVG conversion.
Possible value:
- true/false
Default: false
Also set with -Dorg.jpedal.pdf2html.completeDocument=
- Parameters:
value
- is of type boolean
-
setFirstPageName
Deprecated.We do not recommend that this option be used.Allows filename of the first page to be changed.Also set with -Dorg.jpedal.pdf2html.firstPageName=
- Parameters:
value
- is of type String
-
setOutputThumbnails
public void setOutputThumbnails(boolean value) Output thumbnails of pages in /thumbnails/.Possible value:
- true/false
Default: false
Thumnails are always generated if using the IDRViewer with ViewerUI Complete.
Also set with -Dorg.jpedal.pdf2html.outputThumbnails=
- Overrides:
setOutputThumbnails
in classOutputModeOptions
- Parameters:
value
- is of type boolean.
-
setContainerId
Set the id to use for the page container div.Default: jpedal
Also set with -Dorg.jpedal.pdf2html.containerId=
- Parameters:
value
- is of type String
-
setGenerateSearchFile
public void setGenerateSearchFile(boolean value) Generates search.json. This file contains an array (one element per page) containing the textual content from each page. It is used by idrviewer.search.js for page search.search.json is always generated in the IDRViewer Complete UI. Search is not supported as standard in other IDRViewer UI modes.
Possible value:
- true/false
Also set with -Dorg.jpedal.pdf2html.generateSearchFile=
- Overrides:
setGenerateSearchFile
in classOutputModeOptions
- Parameters:
value
- is of type boolean.
-
setThumbnailMaxWidth
public void setThumbnailMaxWidth(int value) Sets the maximum width of the thumbnails. Can be used in conjunction with setThumbnailMaxHeight. If both a width and height are given then the generated thumbnails will fit within the bounds given, maintaining the aspect ratio of the original page. If only a width or height is given then the size of the generated thumbnails will match the bound given, again maintaining the aspect ratio of the original page.Possible values:
- Any positive integer
- Overrides:
setThumbnailMaxWidth
in classOutputModeOptions
- Parameters:
value
- the maximum thumbnail width
-
setThumbnailMaxHeight
public void setThumbnailMaxHeight(int value) Sets the maximum height of the thumbnails. Can be used in conjunction with setThumbnailMaxWidth. If both a width and height are given then the generated thumbnails will fit within the bounds given, maintaining the aspect ratio of the original page. If only a width or height is given then the size of the generated thumbnails will match the bound given, again maintaining the aspect ratio of the original page.Possible values:
- Any positive integer
- Overrides:
setThumbnailMaxHeight
in classOutputModeOptions
- Parameters:
value
- the maximum thumbnail height
-