Package org.jpedal.render.output

Class OutputModeOptions

java.lang.Object
org.jpedal.render.output.OutputModeOptions
Direct Known Subclasses:
ContentOptions, IDRViewerOptions
public abstract class OutputModeOptions extends Object
The parent abstract class for IDRViewerOptions and ContentOptions.

  • Constructor Details

    • OutputModeOptions

      public OutputModeOptions()

  • Method Details

    • getErrors

      public String getErrors()

    • setOutputThumbnails

      public OutputModeOptions setOutputThumbnails(boolean value)
      Output thumbnails of pages in /thumbnails/.

      Possible value:

      • true/false

      Default: false

      Thumbnails are always generated if using the IDRViewer with ViewerUI Complete.

      Also set with -Dorg.jpedal.pdf2html.outputThumbnails=

      Parameters:
      value - is of type boolean.
      Returns:
      the OutputModeOptions Object.

    • setThumbnailMaxWidth

      public OutputModeOptions setThumbnailMaxWidth(int thumbnailMaxWidth)
      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
      Also set with -Dorg.jpedal.pdf2html.thumbnailMaxWidth=
      Parameters:
      thumbnailMaxWidth - the maximum thumbnail width
      Returns:
      the OutputModeOptions object.
      Since:
      2022.03

    • setThumbnailMaxHeight

      public OutputModeOptions setThumbnailMaxHeight(int thumbnailMaxHeight)
      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
      Also set with -Dorg.jpedal.pdf2html.thumbnailMaxHeight=
      Parameters:
      thumbnailMaxHeight - the maximum thumbnail height
      Returns:
      the OutputModeOptions object.
      Since:
      2022.03

    • setGenerateSearchFile

      public OutputModeOptions 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=

      Parameters:
      value - is of type boolean.
      Returns:
      the OutputModeOptions object.

    • getStringValue

      public String getStringValue(String key)

    • getBooleanValue

      public boolean getBooleanValue(String key, boolean defaultValue)