PDF (PDF Custom Keywords)

com.kms.katalon.keyword.pdf.PDF

Methods Summary

Methods
Type	Name and description
`static boolean`	`compareAllPages(java.lang.String file1, java.lang.String file2, java.lang.Object excludePattern)` Compares all pages of two given PDF documents.
`static boolean`	`compareByPixel(java.lang.String file1, java.lang.String file2, int startPage, int endPage, boolean highlightImageDifferences, boolean showAllDifferences)` Compare pages in range of 2 PDF documents pixel by pixel for the content and format.
`static boolean`	`compareFromPage(java.lang.String file1, java.lang.String file2, int startPage, java.lang.Object excludePattern)` Compares two given pdf documents from a specified page.
`static boolean`	`compareInPageRange(java.lang.String file1, java.lang.String file2, int startPage, int endPage, java.lang.Object excludePattern)` Compares two given PDF documents in a specified page range.
`static java.util.List<java.lang.String>`	`extractAllImages(java.lang.String file)` Extract all the embedded images from the pdf document
`static java.util.List<java.lang.String>`	`extractImagesFromPage(java.lang.String file, int startPage)` Extract all the embedded images from the specified PDF pages
`static java.util.List<java.lang.String>`	`extractImagesInPageRange(java.lang.String file, int startPage, int endPage)` Extract all the embedded images from PDF pages in range
`static java.lang.String`	`getAllText(java.lang.String file)` Get all the content of the document as plain text.
`static int`	`getPageNumber(java.lang.String file)` Get the page count of the document.
`static java.lang.String`	`getTextFromPage(java.lang.String file, int startPage)` Get the content of a specified PDF page as plain text.
`static java.lang.String`	`getTextInPageRange(java.lang.String file, int startPage, int endPage)` Get the content of PDF pages in rage as plain text.
`static java.util.List<java.lang.String>`	`saveAllPagesAsImages(java.lang.String file)` Save each page of the PDF as image
`static java.util.List<java.lang.String>`	`savePageAsImage(java.lang.String file, int startPage)` Save PDF pages from a specified page as images
`static java.util.List<java.lang.String>`	`savePageRangeAsImages(java.lang.String file, int startPage, int endPage)` Save PDF pages in range as images

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareAllPages(java.lang.String file1, java.lang.String file2, java.lang.Object excludePattern)
    
    Compares all pages of two given PDF documents. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    boolean true if matches, false otherwise
    Parameters:
    file1 - Absolute file path of the expected file
    file2 - Absolute file path of the actual file
    excludePattern - The strings need to exclude from the comparison
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareByPixel(java.lang.String file1, java.lang.String file2, int startPage, int endPage, boolean highlightImageDifferences, boolean showAllDifferences)
    
    Compare pages in range of 2 PDF documents pixel by pixel for the content and format.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    boolean true if matches, false otherwise
    Parameters:
    file1 - Absolute file path of the expected file
    file2 - Absolute file path of the actual file
    startPage - Starting page number of the document
    endPage - Ending page number of the document
    highlightImageDifferences - To highlight differences in the images
    showAllDifferences - To compare all the pages of the PDF (by default as soon as a mismatch is found in a page, this method exits)
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareFromPage(java.lang.String file1, java.lang.String file2, int startPage, java.lang.Object excludePattern)
    
    Compares two given pdf documents from a specified page. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    boolean true if matches, false otherwise
    Parameters:
    file1 - Absolute file path of the expected file
    file2 - Absolute file path of the actual file
    startPage - Starting page number of the document
    excludePattern - The strings need to exclude from the comparison
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareInPageRange(java.lang.String file1, java.lang.String file2, int startPage, int endPage, java.lang.Object excludePattern)
    
    Compares two given PDF documents in a specified page range. Note : TEXT_MODE : Compare 2 pdf documents contents with no formatting. VISUAL_MODE : Compare 2 pdf documents pixel by pixel for the content and format.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    boolean true if matches, false otherwise
    Parameters:
    file1 - Absolute file path of the expected file
    file2 - Absolute file path of the actual file
    startPage - Starting page number of the document
    endPage - Ending page number of the document
    excludePattern - The strings need to exclude from the comparison
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractAllImages(java.lang.String file)
    
    Extract all the embedded images from the pdf document
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractImagesFromPage(java.lang.String file, int startPage)
    
    Extract all the embedded images from the specified PDF pages
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
    startPage - Starting page number of the document
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractImagesInPageRange(java.lang.String file, int startPage, int endPage)
    
    Extract all the embedded images from PDF pages in range
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
    startPage - Starting page number of the document
    endPage - Ending page number of the document
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getAllText(java.lang.String file)
    
    Get all the content of the document as plain text.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    String document content in plain text.
    Parameters:
    file - Absolute file path
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static int getPageNumber(java.lang.String file)
    
    Get the page count of the document.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    int No of pages in the document.
    Parameters:
    file - Absolute file path
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getTextFromPage(java.lang.String file, int startPage)
    
    Get the content of a specified PDF page as plain text.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    String document content in plain text.
    Parameters:
    file - Absolute file path
    startPage - Starting page number of the document
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getTextInPageRange(java.lang.String file, int startPage, int endPage)
    
    Get the content of PDF pages in rage as plain text.
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    String document content in plain text.
    Parameters:
    file - Absolute file path
    startPage - Starting page number of the document
    endPage - Ending page number of the document
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> saveAllPagesAsImages(java.lang.String file)
    
    Save each page of the PDF as image
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> savePageAsImage(java.lang.String file, int startPage)
    
    Save PDF pages from a specified page as images
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
    startPage - Starting page number of the document
  - @groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> savePageRangeAsImages(java.lang.String file, int startPage, int endPage)
    
    Save PDF pages in range as images
    throws:
    java.io.IOException when file is not found.
    
    Returns:
    List list of image file names with absolute path
    Parameters:
    file - Absolute file path of the file
    startPage - Starting page number of the document
    endPage - Ending page number of the document

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class PDF

Methods Summary

Inherited Methods Summary

Method Detail

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareAllPages(java.lang.String file1, java.lang.String file2, java.lang.Object excludePattern)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareByPixel(java.lang.String file1, java.lang.String file2, int startPage, int endPage, boolean highlightImageDifferences, boolean showAllDifferences)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareFromPage(java.lang.String file1, java.lang.String file2, int startPage, java.lang.Object excludePattern)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static boolean compareInPageRange(java.lang.String file1, java.lang.String file2, int startPage, int endPage, java.lang.Object excludePattern)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractAllImages(java.lang.String file)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractImagesFromPage(java.lang.String file, int startPage)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> extractImagesInPageRange(java.lang.String file, int startPage, int endPage)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getAllText(java.lang.String file)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static int getPageNumber(java.lang.String file)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getTextFromPage(java.lang.String file, int startPage)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.lang.String getTextInPageRange(java.lang.String file, int startPage, int endPage)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> saveAllPagesAsImages(java.lang.String file)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> savePageAsImage(java.lang.String file, int startPage)

@groovy.transform.CompileStatic @com.kms.katalon.core.annotation.Keyword static java.util.List<java.lang.String> savePageRangeAsImages(java.lang.String file, int startPage, int endPage)