Package com.ebasetech.xi.api

Class PdfOptions

java.lang.Object
com.ebasetech.xi.api.PdfOptions
All Implemented Interfaces:
java.io.Serializable
public class PdfOptions
extends java.lang.Object
implements java.io.Serializable
This class supplies a number of options used to generate a PDF. It is used as an argument for WebForm.generatePdf(PdfOptions).

Further documentation.

Since:
V4.4
See Also:
Serialized Form

  • Constructor Summary

    Constructors
    Constructor Description
    PdfOptions()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getFilePath()
    Returns the file path where the PDF will be saved.
    Page[] getPages()
    Returns the pages to be printed.
    java.lang.String getPopupWindowName()
    Returns the popup window name.
    boolean isDisplay()
    Returns the display option.
    boolean isPopup()
    Returns the popup option.
    boolean isReportMode()
    Returns the report mode option.
    boolean isSave()
    Returns the save option.
    void setDisplay​(boolean display)
    Sets the display option.
    void setFilePath​(java.lang.String filePath)
    Sets the file path used to save the document on the server when option save is set to true.
    void setPages​(Page[] pages)
    Sets the pages to be included in the PDF.
    void setPopup​(boolean popup)
    When the display option is set to true, this option controls whether or not the PDF is displayed to the user in a popup window.
    void setPopupWindowName​(java.lang.String popupWindowName)
    When the popup option is set to true, this method can be used to specify a named window.
    void setReportMode​(boolean reportMode)
    Sets the report mode option.
    void setSave​(boolean save)
    Sets the save option.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PdfOptions

      public PdfOptions()

  • Method Details

    • setDisplay

      public void setDisplay​(boolean display)
      Sets the display option. When true, the PDF is displayed to the user. The default is true.
      Parameters:
      display -
      Since:
      V4.4

    • setFilePath

      public void setFilePath​(java.lang.String filePath)
      Sets the file path used to save the document on the server when option save is set to true. This can be either a relative or absolute file path.

      If not specified, a generated name is used as follows. The directory is specified with property Ufs.pdfDirectoryName in the UFSSetup.properties file. The filename is automatically generated and is constructed as follows: form name-file sequence number.pdf.

      Parameters:
      filePath -
      Since:
      V4.4

    • setPages

      public void setPages​(Page[] pages)
      Sets the pages to be included in the PDF. The default, if this method is not called, is to include the current page.
      Parameters:
      pages -
      Since:
      V4.4

    • setPopup

      public void setPopup​(boolean popup)
      When the display option is set to true, this option controls whether or not the PDF is displayed to the user in a popup window. When true, method setPopupWindowName(String) can be used to specify a named window. The default for this option is true.
      Parameters:
      popup -
      Since:
      V4.4

    • setPopupWindowName

      public void setPopupWindowName​(java.lang.String popupWindowName)
      When the popup option is set to true, this method can be used to specify a named window. There is no default default for this option. If omitted, each PDF will appear in a new popup window.
      Parameters:
      popupWindowName -
      Since:
      V4.4

    • setReportMode

      public void setReportMode​(boolean reportMode)
      Sets the report mode option. When true, all input text and textarea fields, including both form fields and table columns, are displayed as if they are display only. This means that the border surrounding each input element is removed, and also that all data is shown - the page expands downwards to accommodate this.

      Further documentation.

      The default for this option is true.

      Parameters:
      reportMode -
      Since:
      V4.4

    • setSave

      public void setSave​(boolean save)
      Sets the save option. When true, the PDF is saved on the server. The file path is specified with method setFilePath(String). The default for this option is false.
      Parameters:
      save -
      Since:
      V4.4

    • isDisplay

      public boolean isDisplay()
      Returns the display option. See setDisplay(boolean).
      Returns:
      display

    • isSave

      public boolean isSave()
      Returns the save option. See setSave(boolean).
      Returns:
      save

    • isPopup

      public boolean isPopup()
      Returns the popup option. See setPopup(boolean).
      Returns:
      popup

    • getPages

      public Page[] getPages()
      Returns the pages to be printed. See setPages(Page[]).
      Returns:
      pages

    • getFilePath

      public java.lang.String getFilePath()
      Returns the file path where the PDF will be saved. See setFilePath(String).
      Returns:
      filePath

    • getPopupWindowName

      public java.lang.String getPopupWindowName()
      Returns the popup window name. See setPopupWindowName(String).
      Returns:
      popupWindowName

    • isReportMode

      public boolean isReportMode()
      Returns the report mode option. See setReportMode(boolean).
      Returns:
      reportMode