Package com.dynamicpdf.api

Class Pdf

java.lang.Object
com.dynamicpdf.api.Endpoint
com.dynamicpdf.api.Pdf
public class Pdf extends Endpoint
Represents a pdf endpoint.

  • Constructor Details

    • Pdf

      public Pdf()
      Initializes a new instance of the Pdf class.

  • Method Details

    • getResources

      public HashSet<Resource> getResources()
      Sets the collection of resource.
      Returns:
      The collection of resource.

    • getAuthor

      public String getAuthor()
      Gets the author.
      Returns:
      The author.

    • setAuthor

      public void setAuthor​(String value)
      Sets the author.
      Parameters:
      value - The author.

    • getTitle

      public String getTitle()
      Gets the title.
      Returns:
      The title.

    • setTitle

      public void setTitle​(String value)
      Sets the title.
      Parameters:
      value - The title.

    • getSubject

      public String getSubject()
      Gets the subject.
      Returns:
      The subject.

    • setSubject

      public void setSubject​(String value)
      Sets the subject.
      Parameters:
      value - The subject.

    • getCreator

      public String getCreator()
      Gets the creator.
      Returns:
      The creator.

    • setCreator

      public void setCreator​(String value)
      Sets the creator.
      Parameters:
      value - The creator.

    • getKeywords

      public String getKeywords()
      Gets the keywords.
      Returns:
      The keywords.

    • setKeywords

      public void setKeywords​(String value)
      Sets the keywords.
      Parameters:
      value - The keywords.

    • getSecurity

      public Security getSecurity()
      Gets the security.
      Returns:
      The security.

    • setSecurity

      public void setSecurity​(Security value)
      Sets the security.
      Parameters:
      value - The security.

    • getFlattenAllFormFields

      public boolean getFlattenAllFormFields()
      Gets the value indicating whether to flatten all form fields.
      Returns:
      The value indicating whether to flatten all form fields.

    • setFlattenAllFormFields

      public void setFlattenAllFormFields​(boolean value)
      Sets the value indicating whether to flatten all form fields.
      Parameters:
      value - The value indicating whether to flatten all form fields.

    • getRetainSignatureFormFields

      public boolean getRetainSignatureFormFields()
      Gets the value indicating whether to retain signature form field.
      Returns:
      The value indicating whether to retain signature form field.

    • setRetainSignatureFormFields

      public void setRetainSignatureFormFields​(boolean value)
      Sets the value indicating whether to retain signature form field.
      Parameters:
      value - The value indicating whether to retain signature form field.

    • addPdf

      public PdfInput addPdf​(PdfResource resource, MergeOptions options)
      Returns a PdfInput object containing the input pdf.
      Parameters:
      resource - The resource of type PdfResource.
      options - The merge options for the pdf.

    • addPdf

      public PdfInput addPdf​(PdfResource resource)
      Parameters:
      resource - The resource of type PdfResource.
      Returns:
      Added pdf pages

    • addPdf

      public PdfInput addPdf​(String cloudResourcePath, MergeOptions options)
      Returns a PdfInput object containing the input pdf.
      Parameters:
      cloudResourcePath - The resource path in cloud resource manager.
      options - The merge options for the pdf.
      Returns:
      Added pdf pages

    • addPdf

      public PdfInput addPdf​(String cloudResourcePath)
      Parameters:
      cloudResourcePath - The resource path in cloud resource manager.
      Returns:
      Added pdf pages

    • addImage

      public ImageInput addImage​(ImageResource resource)
      Returns an ImageInput object containing the input pdf.
      Parameters:
      resource - The resource of type ImageResource.
      Returns:
      Added pdf pages

    • addImage

      public ImageInput addImage​(String cloudResourcePath)
      Returns an ImageInput object containing the input pdf.
      Parameters:
      cloudResourcePath - The resource path in cloud resource manager.
      Returns:
      Added pdf pages

    • addDlex

      public DlexInput addDlex​(DlexResource dlexResource, LayoutDataResource layoutData)
      Returns a DlexInput object containing the input pdf.
      Parameters:
      dlexResource - The dlex resource of type DlexResource.
      layoutData - The layout data resource of type LayoutDataResource.
      Returns:
      Added pdf pages

    • addDlex

      public DlexInput addDlex​(String cloudResourcePath, LayoutDataResource layoutData)
      Returns a DlexInput object containing the input pdf.
      Parameters:
      cloudResourcePath - The resource path in cloud resource manager.
      layoutData - The layout data resource of type LayoutDataResource.
      Returns:
      Added pdf pages

    • addDlex

      public DlexInput addDlex​(String cloudResourcePath, String cloudLayoutDataPat)
      Returns a DlexInput object containing the input pdf.
      Parameters:
      cloudResourcePath - The resource path in cloud resource manager.
      cloudLayoutDataPat - The layout data resource path in cloud resource manager.
      Returns:
      Added pdf pages

    • addPage

      public PageInput addPage​(float pageWidth, float pageHeight)
      Returns a PageInput object containing the input pdf.
      Parameters:
      pageWidth - The width of the page.
      pageHeight - The height of the page.
      Returns:
      Added pdf pages

    • addPage

      public PageInput addPage()
      Returns a PageInput object containing the input pdf.
      Returns:
      A PageInput object containing the input pdf.

    • getInputs

      public List<Input> getInputs()
      Gets the inputs.
      Returns:
      The inputs.

    • getTemplates

      public HashSet<Template> getTemplates()
      Gets the templates.
      Returns:
      The templates.

    • getFonts

      public HashSet<Font> getFonts()
      Gets the fonts.
      Returns:
      The fonts.

    • getFormFields

      public List<FormField> getFormFields()
      Gets the formFields.
      Returns:
      The formFields.

    • getOutlines

      public OutlineList getOutlines()
      Gets the outlines.
      Returns:
      The outlines.

    • getInstructonsJson

      public String getInstructonsJson()

    • process

      public PdfResponse process()
      Process to create pdf.
      Returns:
      Pdf Response

    • processAsync

      public CompletableFuture<PdfResponse> processAsync()
      Process to create pdf.
      Returns:
      collection of PdfResponse as multithreading tasks CompletableFuture.