Pdfcrowd.ImageToPdfClient (com.pdfcrowd:pdfcrowd 6.5.3 API)

java.lang.Object
- com.pdfcrowd.Pdfcrowd.ImageToPdfClient

Enclosing class:: Pdfcrowd

public static final class Pdfcrowd.ImageToPdfClient
extends Object

Conversion from an image to PDF.

Constructor Summary

Constructors
Constructor and Description

ImageToPdfClient(String userName, String apiKey)
Constructor for the PDFCrowd API client.

Constructors
Constructor and Description
`ImageToPdfClient(String userName, String apiKey)` Constructor for the PDFCrowd API client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`convertFile(String file)` Convert a local file.
`void`	`convertFileToFile(String file, String filePath)` Convert a local file and write the result to a local file.
`void`	`convertFileToStream(String file, OutputStream outStream)` Convert a local file and write the result to an output stream.
`byte[]`	`convertRawData(byte[] data)` Convert raw data.
`void`	`convertRawDataToFile(byte[] data, String filePath)` Convert raw data to a file.
`void`	`convertRawDataToStream(byte[] data, OutputStream outStream)` Convert raw data and write the result to an output stream.
`byte[]`	`convertStream(InputStream inStream)` Convert the contents of an input stream.
`void`	`convertStreamToFile(InputStream inStream, String filePath)` Convert the contents of an input stream and write the result to a local file.
`void`	`convertStreamToStream(InputStream inStream, OutputStream outStream)` Convert the contents of an input stream and write the result to an output stream.
`byte[]`	`convertUrl(String url)` Convert an image.
`void`	`convertUrlToFile(String url, String filePath)` Convert an image and write the result to a local file.
`void`	`convertUrlToStream(String url, OutputStream outStream)` Convert an image and write the result to an output stream.
`int`	`getConsumedCreditCount()` Get the number of credits consumed by the last conversion.
`String`	`getDebugLogUrl()` Get the URL of the debug log for the last conversion.
`String`	`getJobId()` Get the job id.
`int`	`getOutputSize()` Get the size of the output in bytes.
`int`	`getRemainingCreditCount()` Get the number of conversion credits available in your account.
`String`	`getVersion()` Get the version details.
`Pdfcrowd.ImageToPdfClient`	`setAuthor(String author)` Set the author of the PDF.
`Pdfcrowd.ImageToPdfClient`	`setCenterWindow(boolean value)` Specify whether to position the document's window in the center of the screen.
`Pdfcrowd.ImageToPdfClient`	`setClientUserAgent(String agent)` Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
`Pdfcrowd.ImageToPdfClient`	`setConverterVersion(String version)` Set the converter version.
`Pdfcrowd.ImageToPdfClient`	`setCropArea(String x, String y, String width, String height)` Set the content area position and size.
`Pdfcrowd.ImageToPdfClient`	`setCropAreaHeight(String height)` Set the height of the content area.
`Pdfcrowd.ImageToPdfClient`	`setCropAreaWidth(String width)` Set the width of the content area.
`Pdfcrowd.ImageToPdfClient`	`setCropAreaX(String x)` Set the top left X coordinate of the content area.
`Pdfcrowd.ImageToPdfClient`	`setCropAreaY(String y)` Set the top left Y coordinate of the content area.
`Pdfcrowd.ImageToPdfClient`	`setDebugLog(boolean value)` Turn on the debug logging.
`Pdfcrowd.ImageToPdfClient`	`setDisplayTitle(boolean value)` Specify whether the window's title bar should display the document title.
`Pdfcrowd.ImageToPdfClient`	`setDpi(int dpi)` Set the DPI resolution of the input image.
`Pdfcrowd.ImageToPdfClient`	`setEncrypt(boolean value)` Encrypt the PDF.
`Pdfcrowd.ImageToPdfClient`	`setFitWindow(boolean value)` Specify whether to resize the document's window to fit the size of the first displayed page.
`Pdfcrowd.ImageToPdfClient`	`setHideMenubar(boolean value)` Specify whether to hide the viewer application's menu bar when the document is active.
`Pdfcrowd.ImageToPdfClient`	`setHideToolbar(boolean value)` Specify whether to hide the viewer application's tool bars when the document is active.
`Pdfcrowd.ImageToPdfClient`	`setHideWindowUi(boolean value)` Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
`Pdfcrowd.ImageToPdfClient`	`setHttpProxy(String proxy)` A proxy server used by the conversion process for accessing the source URLs with HTTP scheme.
`Pdfcrowd.ImageToPdfClient`	`setHttpsProxy(String proxy)` A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme.
`Pdfcrowd.ImageToPdfClient`	`setInitialPage(int page)` Display the specified page when the document is opened.
`Pdfcrowd.ImageToPdfClient`	`setInitialZoom(int zoom)` Specify the initial page zoom in percents when the document is opened.
`Pdfcrowd.ImageToPdfClient`	`setInitialZoomType(String zoomType)` Specify how the page should be displayed when opened.
`Pdfcrowd.ImageToPdfClient`	`setKeywords(String keywords)` Associate keywords with the document.
`Pdfcrowd.ImageToPdfClient`	`setLinearize(boolean value)` Create linearized PDF.
`Pdfcrowd.ImageToPdfClient`	`setMarginBottom(String bottom)` Set the output page bottom margin.
`Pdfcrowd.ImageToPdfClient`	`setMarginLeft(String left)` Set the output page left margin.
`Pdfcrowd.ImageToPdfClient`	`setMarginRight(String right)` Set the output page right margin.
`Pdfcrowd.ImageToPdfClient`	`setMarginTop(String top)` Set the output page top margin.
`Pdfcrowd.ImageToPdfClient`	`setMultipageBackground(String background)` Apply each page of a background to the corresponding page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setMultipageBackgroundUrl(String url)` Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setMultipageWatermark(String watermark)` Apply each page of a watermark to the corresponding page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setMultipageWatermarkUrl(String url)` Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setNoCopy(boolean value)` Disallow text and graphics extraction from the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setNoModify(boolean value)` Disallow modification of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setNoPrint(boolean value)` Disallow printing of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setOrientation(String orientation)` Set the output page orientation.
`Pdfcrowd.ImageToPdfClient`	`setOwnerPassword(String password)` Protect the PDF with an owner password.
`Pdfcrowd.ImageToPdfClient`	`setPageBackground(String background)` Apply a background to each page of the output PDF file.
`Pdfcrowd.ImageToPdfClient`	`setPageBackgroundColor(String color)` The page background color in RGB or RGBA hexadecimal format.
`Pdfcrowd.ImageToPdfClient`	`setPageBackgroundUrl(String url)` Load a file from the specified URL and apply the file as a background to each page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setPageDimensions(String width, String height)` Set the output page dimensions.
`Pdfcrowd.ImageToPdfClient`	`setPageHeight(String height)` Set the output page height.
`Pdfcrowd.ImageToPdfClient`	`setPageLayout(String layout)` Specify the page layout to be used when the document is opened.
`Pdfcrowd.ImageToPdfClient`	`setPageMargins(String top, String right, String bottom, String left)` Set the output page margins.
`Pdfcrowd.ImageToPdfClient`	`setPageMode(String mode)` Specify how the document should be displayed when opened.
`Pdfcrowd.ImageToPdfClient`	`setPageSize(String size)` Set the output page size.
`Pdfcrowd.ImageToPdfClient`	`setPageWatermark(String watermark)` Apply a watermark to each page of the output PDF file.
`Pdfcrowd.ImageToPdfClient`	`setPageWatermarkUrl(String url)` Load a file from the specified URL and apply the file as a watermark to each page of the output PDF.
`Pdfcrowd.ImageToPdfClient`	`setPageWidth(String width)` Set the output page width.
`Pdfcrowd.ImageToPdfClient`	`setPosition(String position)` Set the image position on the page.
`Pdfcrowd.ImageToPdfClient`	`setPrintPageMode(String mode)` Set the mode to print the image on the content area of the page.
`Pdfcrowd.ImageToPdfClient`	`setProxy(String host, int port, String userName, String password)` Specifies an HTTP proxy that the API client library will use to connect to the internet.
`Pdfcrowd.ImageToPdfClient`	`setRemoveBorders(boolean value)` Remove borders of an image which does not change in color.
`Pdfcrowd.ImageToPdfClient`	`setResize(String resize)` Resize the image.
`Pdfcrowd.ImageToPdfClient`	`setRetryCount(int count)` Specifies the number of automatic retries when the 502 or 503 HTTP status code is received.
`Pdfcrowd.ImageToPdfClient`	`setRotate(String rotate)` Rotate the image.
`Pdfcrowd.ImageToPdfClient`	`setSubject(String subject)` Set the subject of the PDF.
`Pdfcrowd.ImageToPdfClient`	`setTag(String tag)` Tag the conversion with a custom value.
`Pdfcrowd.ImageToPdfClient`	`setTitle(String title)` Set the title of the PDF.
`Pdfcrowd.ImageToPdfClient`	`setUseHttp(boolean value)` Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.
`Pdfcrowd.ImageToPdfClient`	`setUserAgent(String agent)` Set a custom user agent HTTP header.
`Pdfcrowd.ImageToPdfClient`	`setUserPassword(String password)` Protect the PDF with a user password.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImageToPdfClient
```
public ImageToPdfClient(String userName,
                        String apiKey)
```
    Constructor for the PDFCrowd API client.
    
    Parameters:
    
    userName - Your username at PDFCrowd.
    
    apiKey - Your API key.
- Method Detail
  - convertUrl
```
public byte[] convertUrl(String url)
```
    Convert an image.
    
    Parameters:
    
    url - The address of the image to convert. Supported protocols are http:// and https://.
    
    Returns:
    
    Byte array containing the conversion output.
  - convertUrlToStream
```
public void convertUrlToStream(String url,
                               OutputStream outStream)
```
    Convert an image and write the result to an output stream.
    
    Parameters:
    
    url - The address of the image to convert. Supported protocols are http:// and https://.
    
    outStream - The output stream that will contain the conversion output.
  - convertUrlToFile
```
public void convertUrlToFile(String url,
                             String filePath)
                      throws IOException
```
    Convert an image and write the result to a local file.
    
    Parameters:
    
    url - The address of the image to convert. Supported protocols are http:// and https://.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertFile
```
public byte[] convertFile(String file)
```
    Convert a local file.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file must exist and not be empty.
    
    Returns:
    
    Byte array containing the conversion output.
  - convertFileToStream
```
public void convertFileToStream(String file,
                                OutputStream outStream)
```
    Convert a local file and write the result to an output stream.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file must exist and not be empty.
    
    outStream - The output stream that will contain the conversion output.
  - convertFileToFile
```
public void convertFileToFile(String file,
                              String filePath)
                       throws IOException
```
    Convert a local file and write the result to a local file.
    
    Parameters:
    
    file - The path to a local file to convert.
    The file must exist and not be empty.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertRawData
```
public byte[] convertRawData(byte[] data)
```
    Convert raw data.
    
    Parameters:
    
    data - The raw content to be converted.
    
    Returns:
    
    Byte array with the output.
  - convertRawDataToStream
```
public void convertRawDataToStream(byte[] data,
                                   OutputStream outStream)
```
    Convert raw data and write the result to an output stream.
    
    Parameters:
    
    data - The raw content to be converted.
    
    outStream - The output stream that will contain the conversion output.
  - convertRawDataToFile
```
public void convertRawDataToFile(byte[] data,
                                 String filePath)
                          throws IOException
```
    Convert raw data to a file.
    
    Parameters:
    
    data - The raw content to be converted.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - convertStream
```
public byte[] convertStream(InputStream inStream)
                     throws IOException
```
    Convert the contents of an input stream.
    
    Parameters:
    
    inStream - The input stream with source data.
    
    Returns:
    
    Byte array containing the conversion output.
    
    Throws:
    
    IOException
  - convertStreamToStream
```
public void convertStreamToStream(InputStream inStream,
                                  OutputStream outStream)
                           throws IOException
```
    Convert the contents of an input stream and write the result to an output stream.
    
    Parameters:
    
    inStream - The input stream with source data.
    
    outStream - The output stream that will contain the conversion output.
    
    Throws:
    
    IOException
  - convertStreamToFile
```
public void convertStreamToFile(InputStream inStream,
                                String filePath)
                         throws IOException
```
    Convert the contents of an input stream and write the result to a local file.
    
    Parameters:
    
    inStream - The input stream with source data.
    
    filePath - The output file path. The string must not be empty.
    
    Throws:
    
    IOException
  - setResize
```
public Pdfcrowd.ImageToPdfClient setResize(String resize)
```
    Resize the image.
    
    Parameters:
    
    resize - The resize percentage or new image dimensions.
    
    Returns:
    
    The converter object.
  - setRotate
```
public Pdfcrowd.ImageToPdfClient setRotate(String rotate)
```
    Rotate the image.
    
    Parameters:
    
    rotate - The rotation specified in degrees.
    
    Returns:
    
    The converter object.
  - setCropAreaX
```
public Pdfcrowd.ImageToPdfClient setCropAreaX(String x)
```
    Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
    
    Parameters:
    
    x - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setCropAreaY
```
public Pdfcrowd.ImageToPdfClient setCropAreaY(String y)
```
    Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
    
    Parameters:
    
    y - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setCropAreaWidth
```
public Pdfcrowd.ImageToPdfClient setCropAreaWidth(String width)
```
    Set the width of the content area. It should be at least 1 inch.
    
    Parameters:
    
    width - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setCropAreaHeight
```
public Pdfcrowd.ImageToPdfClient setCropAreaHeight(String height)
```
    Set the height of the content area. It should be at least 1 inch.
    
    Parameters:
    
    height - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setCropArea
```
public Pdfcrowd.ImageToPdfClient setCropArea(String x,
                                             String y,
                                             String width,
                                             String height)
```
    Set the content area position and size. The content area enables to specify the part to be converted.
    
    Parameters:
    
    x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setRemoveBorders
```
public Pdfcrowd.ImageToPdfClient setRemoveBorders(boolean value)
```
    Remove borders of an image which does not change in color.
    
    Parameters:
    
    value - Set to true to remove borders.
    
    Returns:
    
    The converter object.
  - setPageSize
```
public Pdfcrowd.ImageToPdfClient setPageSize(String size)
```
    Set the output page size.
    
    Parameters:
    
    size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.
    
    Returns:
    
    The converter object.
  - setPageWidth
```
public Pdfcrowd.ImageToPdfClient setPageWidth(String width)
```
    Set the output page width.
    
    Parameters:
    
    width - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setPageHeight
```
public Pdfcrowd.ImageToPdfClient setPageHeight(String height)
```
    Set the output page height.
    
    Parameters:
    
    height - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setPageDimensions
```
public Pdfcrowd.ImageToPdfClient setPageDimensions(String width,
                                                   String height)
```
    Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.
    
    Parameters:
    
    width - Set the output page width. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    height - Set the output page height. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setOrientation
```
public Pdfcrowd.ImageToPdfClient setOrientation(String orientation)
```
    Set the output page orientation.
    
    Parameters:
    
    orientation - Allowed values are landscape, portrait.
    
    Returns:
    
    The converter object.
  - setPosition
```
public Pdfcrowd.ImageToPdfClient setPosition(String position)
```
    Set the image position on the page.
    
    Parameters:
    
    position - Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.
    
    Returns:
    
    The converter object.
  - setPrintPageMode
```
public Pdfcrowd.ImageToPdfClient setPrintPageMode(String mode)
```
    Set the mode to print the image on the content area of the page.
    
    Parameters:
    
    mode - Allowed values are default, fit, stretch.
    
    Returns:
    
    The converter object.
  - setMarginTop
```
public Pdfcrowd.ImageToPdfClient setMarginTop(String top)
```
    Set the output page top margin.
    
    Parameters:
    
    top - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setMarginRight
```
public Pdfcrowd.ImageToPdfClient setMarginRight(String right)
```
    Set the output page right margin.
    
    Parameters:
    
    right - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setMarginBottom
```
public Pdfcrowd.ImageToPdfClient setMarginBottom(String bottom)
```
    Set the output page bottom margin.
    
    Parameters:
    
    bottom - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setMarginLeft
```
public Pdfcrowd.ImageToPdfClient setMarginLeft(String left)
```
    Set the output page left margin.
    
    Parameters:
    
    left - The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setPageMargins
```
public Pdfcrowd.ImageToPdfClient setPageMargins(String top,
                                                String right,
                                                String bottom,
                                                String left)
```
    Set the output page margins.
    
    Parameters:
    
    top - Set the output page top margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    right - Set the output page right margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    bottom - Set the output page bottom margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    left - Set the output page left margin. The value must be specified in inches 'in', millimeters 'mm', centimeters 'cm', pixels 'px', or points 'pt'.
    
    Returns:
    
    The converter object.
  - setPageBackgroundColor
```
public Pdfcrowd.ImageToPdfClient setPageBackgroundColor(String color)
```
    The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
    
    Parameters:
    
    color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
    
    Returns:
    
    The converter object.
  - setDpi
```
public Pdfcrowd.ImageToPdfClient setDpi(int dpi)
```
    Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
    
    Parameters:
    
    dpi - The DPI value.
    
    Returns:
    
    The converter object.
  - setPageWatermark
```
public Pdfcrowd.ImageToPdfClient setPageWatermark(String watermark)
```
    Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
    
    Parameters:
    
    watermark - The file path to a local file. The file must exist and not be empty.
    
    Returns:
    
    The converter object.
  - setPageWatermarkUrl
```
public Pdfcrowd.ImageToPdfClient setPageWatermarkUrl(String url)
```
    Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
    
    Parameters:
    
    url - Supported protocols are http:// and https://.
    
    Returns:
    
    The converter object.
  - setMultipageWatermark
```
public Pdfcrowd.ImageToPdfClient setMultipageWatermark(String watermark)
```
    Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
    
    Parameters:
    
    watermark - The file path to a local file. The file must exist and not be empty.
    
    Returns:
    
    The converter object.
  - setMultipageWatermarkUrl
```
public Pdfcrowd.ImageToPdfClient setMultipageWatermarkUrl(String url)
```
    Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
    
    Parameters:
    
    url - Supported protocols are http:// and https://.
    
    Returns:
    
    The converter object.
  - setPageBackground
```
public Pdfcrowd.ImageToPdfClient setPageBackground(String background)
```
    Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
    
    Parameters:
    
    background - The file path to a local file. The file must exist and not be empty.
    
    Returns:
    
    The converter object.
  - setPageBackgroundUrl
```
public Pdfcrowd.ImageToPdfClient setPageBackgroundUrl(String url)
```
    Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
    
    Parameters:
    
    url - Supported protocols are http:// and https://.
    
    Returns:
    
    The converter object.
  - setMultipageBackground
```
public Pdfcrowd.ImageToPdfClient setMultipageBackground(String background)
```
    Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
    
    Parameters:
    
    background - The file path to a local file. The file must exist and not be empty.
    
    Returns:
    
    The converter object.
  - setMultipageBackgroundUrl
```
public Pdfcrowd.ImageToPdfClient setMultipageBackgroundUrl(String url)
```
    Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
    
    Parameters:
    
    url - Supported protocols are http:// and https://.
    
    Returns:
    
    The converter object.
  - setLinearize
```
public Pdfcrowd.ImageToPdfClient setLinearize(boolean value)
```
    Create linearized PDF. This is also known as Fast Web View.
    
    Parameters:
    
    value - Set to true to create linearized PDF.
    
    Returns:
    
    The converter object.
  - setEncrypt
```
public Pdfcrowd.ImageToPdfClient setEncrypt(boolean value)
```
    Encrypt the PDF. This prevents search engines from indexing the contents.
    
    Parameters:
    
    value - Set to true to enable PDF encryption.
    
    Returns:
    
    The converter object.
  - setUserPassword
```
public Pdfcrowd.ImageToPdfClient setUserPassword(String password)
```
    Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
    
    Parameters:
    
    password - The user password.
    
    Returns:
    
    The converter object.
  - setOwnerPassword
```
public Pdfcrowd.ImageToPdfClient setOwnerPassword(String password)
```
    Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
    
    Parameters:
    
    password - The owner password.
    
    Returns:
    
    The converter object.
  - setNoPrint
```
public Pdfcrowd.ImageToPdfClient setNoPrint(boolean value)
```
    Disallow printing of the output PDF.
    
    Parameters:
    
    value - Set to true to set the no-print flag in the output PDF.
    
    Returns:
    
    The converter object.
  - setNoModify
```
public Pdfcrowd.ImageToPdfClient setNoModify(boolean value)
```
    Disallow modification of the output PDF.
    
    Parameters:
    
    value - Set to true to set the read-only only flag in the output PDF.
    
    Returns:
    
    The converter object.
  - setNoCopy
```
public Pdfcrowd.ImageToPdfClient setNoCopy(boolean value)
```
    Disallow text and graphics extraction from the output PDF.
    
    Parameters:
    
    value - Set to true to set the no-copy flag in the output PDF.
    
    Returns:
    
    The converter object.
  - setTitle
```
public Pdfcrowd.ImageToPdfClient setTitle(String title)
```
    Set the title of the PDF.
    
    Parameters:
    
    title - The title.
    
    Returns:
    
    The converter object.
  - setSubject
```
public Pdfcrowd.ImageToPdfClient setSubject(String subject)
```
    Set the subject of the PDF.
    
    Parameters:
    
    subject - The subject.
    
    Returns:
    
    The converter object.
  - setAuthor
```
public Pdfcrowd.ImageToPdfClient setAuthor(String author)
```
    Set the author of the PDF.
    
    Parameters:
    
    author - The author.
    
    Returns:
    
    The converter object.
  - setKeywords
```
public Pdfcrowd.ImageToPdfClient setKeywords(String keywords)
```
    Associate keywords with the document.
    
    Parameters:
    
    keywords - The string with the keywords.
    
    Returns:
    
    The converter object.
  - setPageLayout
```
public Pdfcrowd.ImageToPdfClient setPageLayout(String layout)
```
    Specify the page layout to be used when the document is opened.
    
    Parameters:
    
    layout - Allowed values are single-page, one-column, two-column-left, two-column-right.
    
    Returns:
    
    The converter object.
  - setPageMode
```
public Pdfcrowd.ImageToPdfClient setPageMode(String mode)
```
    Specify how the document should be displayed when opened.
    
    Parameters:
    
    mode - Allowed values are full-screen, thumbnails, outlines.
    
    Returns:
    
    The converter object.
  - setInitialZoomType
```
public Pdfcrowd.ImageToPdfClient setInitialZoomType(String zoomType)
```
    Specify how the page should be displayed when opened.
    
    Parameters:
    
    zoomType - Allowed values are fit-width, fit-height, fit-page.
    
    Returns:
    
    The converter object.
  - setInitialPage
```
public Pdfcrowd.ImageToPdfClient setInitialPage(int page)
```
    Display the specified page when the document is opened.
    
    Parameters:
    
    page - Must be a positive integer.
    
    Returns:
    
    The converter object.
  - setInitialZoom
```
public Pdfcrowd.ImageToPdfClient setInitialZoom(int zoom)
```
    Specify the initial page zoom in percents when the document is opened.
    
    Parameters:
    
    zoom - Must be a positive integer.
    
    Returns:
    
    The converter object.
  - setHideToolbar
```
public Pdfcrowd.ImageToPdfClient setHideToolbar(boolean value)
```
    Specify whether to hide the viewer application's tool bars when the document is active.
    
    Parameters:
    
    value - Set to true to hide tool bars.
    
    Returns:
    
    The converter object.
  - setHideMenubar
```
public Pdfcrowd.ImageToPdfClient setHideMenubar(boolean value)
```
    Specify whether to hide the viewer application's menu bar when the document is active.
    
    Parameters:
    
    value - Set to true to hide the menu bar.
    
    Returns:
    
    The converter object.
  - setHideWindowUi
```
public Pdfcrowd.ImageToPdfClient setHideWindowUi(boolean value)
```
    Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
    
    Parameters:
    
    value - Set to true to hide ui elements.
    
    Returns:
    
    The converter object.
  - setFitWindow
```
public Pdfcrowd.ImageToPdfClient setFitWindow(boolean value)
```
    Specify whether to resize the document's window to fit the size of the first displayed page.
    
    Parameters:
    
    value - Set to true to resize the window.
    
    Returns:
    
    The converter object.
  - setCenterWindow
```
public Pdfcrowd.ImageToPdfClient setCenterWindow(boolean value)
```
    Specify whether to position the document's window in the center of the screen.
    
    Parameters:
    
    value - Set to true to center the window.
    
    Returns:
    
    The converter object.
  - setDisplayTitle
```
public Pdfcrowd.ImageToPdfClient setDisplayTitle(boolean value)
```
    Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
    
    Parameters:
    
    value - Set to true to display the title.
    
    Returns:
    
    The converter object.
  - setDebugLog
```
public Pdfcrowd.ImageToPdfClient setDebugLog(boolean value)
```
    Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
    
    Parameters:
    
    value - Set to true to enable the debug logging.
    
    Returns:
    
    The converter object.
  - getDebugLogUrl
```
public String getDebugLogUrl()
```
    Get the URL of the debug log for the last conversion.
    
    Returns:
    
    The link to the debug log.
  - getRemainingCreditCount
```
public int getRemainingCreditCount()
```
    Get the number of conversion credits available in your account. This method can only be called after a call to one of the convertXtoY methods. The returned value can differ from the actual count if you run parallel conversions. The special value 999999 is returned if the information is not available.
    
    Returns:
    
    The number of credits.
  - getConsumedCreditCount
```
public int getConsumedCreditCount()
```
    Get the number of credits consumed by the last conversion.
    
    Returns:
    
    The number of credits.
  - getJobId
```
public String getJobId()
```
    Get the job id.
    
    Returns:
    
    The unique job identifier.
  - getOutputSize
```
public int getOutputSize()
```
    Get the size of the output in bytes.
    
    Returns:
    
    The count of bytes.
  - getVersion
```
public String getVersion()
```
    Get the version details.
    
    Returns:
    
    API version, converter version, and client version.
  - setTag
```
public Pdfcrowd.ImageToPdfClient setTag(String tag)
```
    Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
    
    Parameters:
    
    tag - A string with the custom tag.
    
    Returns:
    
    The converter object.
  - setHttpProxy
```
public Pdfcrowd.ImageToPdfClient setHttpProxy(String proxy)
```
    A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
    
    Parameters:
    
    proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
    
    Returns:
    
    The converter object.
  - setHttpsProxy
```
public Pdfcrowd.ImageToPdfClient setHttpsProxy(String proxy)
```
    A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
    
    Parameters:
    
    proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
    
    Returns:
    
    The converter object.
  - setConverterVersion
```
public Pdfcrowd.ImageToPdfClient setConverterVersion(String version)
```
    Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
    
    Parameters:
    
    version - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
    
    Returns:
    
    The converter object.
  - setUseHttp
```
public Pdfcrowd.ImageToPdfClient setUseHttp(boolean value)
```
    Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
    
    Parameters:
    
    value - Set to true to use HTTP.
    
    Returns:
    
    The converter object.
  - setClientUserAgent
```
public Pdfcrowd.ImageToPdfClient setClientUserAgent(String agent)
```
    Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
    
    Parameters:
    
    agent - The user agent string.
    
    Returns:
    
    The converter object.
  - setUserAgent
```
public Pdfcrowd.ImageToPdfClient setUserAgent(String agent)
```
    Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
    
    Parameters:
    
    agent - The user agent string.
    
    Returns:
    
    The converter object.
  - setProxy
```
public Pdfcrowd.ImageToPdfClient setProxy(String host,
                                          int port,
                                          String userName,
                                          String password)
```
    Specifies an HTTP proxy that the API client library will use to connect to the internet.
    
    Parameters:
    
    host - The proxy hostname.
    
    port - The proxy port.
    
    userName - The username.
    
    password - The password.
    
    Returns:
    
    The converter object.
  - setRetryCount
```
public Pdfcrowd.ImageToPdfClient setRetryCount(int count)
```
    Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
    
    Parameters:
    
    count - Number of retries.
    
    Returns:
    
    The converter object.

Class Pdfcrowd.ImageToPdfClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageToPdfClient

Method Detail

convertUrl

convertUrlToStream

convertUrlToFile

convertFile

convertFileToStream

convertFileToFile

convertRawData

convertRawDataToStream

convertRawDataToFile

convertStream

convertStreamToStream

convertStreamToFile

setResize

setRotate

setCropAreaX

setCropAreaY

setCropAreaWidth

setCropAreaHeight

setCropArea

setRemoveBorders

setPageSize

setPageWidth

setPageHeight

setPageDimensions

setOrientation

setPosition

setPrintPageMode

setMarginTop

setMarginRight

setMarginBottom

setMarginLeft

setPageMargins

setPageBackgroundColor

setDpi

setPageWatermark

setPageWatermarkUrl

setMultipageWatermark

setMultipageWatermarkUrl

setPageBackground

setPageBackgroundUrl

setMultipageBackground

setMultipageBackgroundUrl

setLinearize

setEncrypt

setUserPassword

setOwnerPassword

setNoPrint

setNoModify

setNoCopy

setTitle

setSubject

setAuthor

setKeywords

setPageLayout

setPageMode

setInitialZoomType

setInitialPage

setInitialZoom

setHideToolbar

setHideMenubar

setHideWindowUi

setFitWindow

setCenterWindow

setDisplayTitle

setDebugLog

getDebugLogUrl

getRemainingCreditCount

getConsumedCreditCount

getJobId

getOutputSize

getVersion

setTag

setHttpProxy