A B C F G I P S T V W X

A

accept(File, String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.FilenameFilterConfig

add(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Params

Add.

addCoverFromFile(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a cover from a file to the pdf

addCoverFromString(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a cover from a HTML-based string to the pdf

addCoverFromUrl(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a cover from an URL to the pdf

addPage(String, SourceType) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Deprecated.

Use the specific type method to a better semantic

addPageFromFile(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a page from a file to the pdf

addPageFromString(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a page from a HTML-based string to the pdf

addPageFromUrl(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a page from an URL to the pdf

addParam(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.BaseObject

Add param.

addParam(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Adds a global param

addParams(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Add params.

addToc() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Add a toc

addTocParam(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Deprecated.

Use per-object params as this will add only to the last ToC

B

BaseObject - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

The type Base object.

C

cleanAllTempFiles() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Cleans up all the files generated by the library.

com.github.jhonnymertz.wkhtmltopdf.wrapper - package com.github.jhonnymertz.wkhtmltopdf.wrapper

com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations - package com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations

com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions - package com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

com.github.jhonnymertz.wkhtmltopdf.wrapper.objects - package com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

com.github.jhonnymertz.wkhtmltopdf.wrapper.params - package com.github.jhonnymertz.wkhtmltopdf.wrapper.params

Cover - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

The type Cover.

Cover(String, SourceType) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Cover

Instantiates a new Cover.

F

FilenameFilterConfig - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations

Implements a filter to get files generated by the library

FilenameFilterConfig() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.FilenameFilterConfig

findExecutable() - Static method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Attempts to find the `wkhtmltopdf` executable in the system path.

G

getAllowMissingAssets() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Gets allow missing assets.

getAlwaysPutTocFirst() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Gets if the TOC is always placed first in the command

getCommand() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Gets command.

getCommand() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

Gets command.

getCommand() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Gets command.

getCommand() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Gets the final wkhtmltopdf command as string

getCommandAsArray() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Get command as array string Note: htmlAsString pages are first store into a temp file, then the location is used in the wkhtmltopdf command this is a workaround to avoid huge commands

getCommandAsList(Pdf) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.BaseObject

Gets command as list.

getCommandAsList(Pdf) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

getCommandLine() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Gets command line.

getErr() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

Get err byte [ ].

getExitStatus() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

Gets exit status.

getExitStatus() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Gets exit status.

getFilePath() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Gets file path.

getKey() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param

Gets key.

getMessage() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

getObjectIdentifier() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.BaseObject

Gets object identifier.

getOut() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

Get out byte [ ].

getOut() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Get out byte [ ].

getParamsAsStringList() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Params

Gets params as string list.

getPDF() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Generates a PDF file as byte array from the wkhtmltopdf output

getSource() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Gets source.

getTempDirectory() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Gets the temporary folder where files are stored during processing

getTimeout() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Get timeout.

getType() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Gets type.

getValues() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param

Gets values.

getWkhtmltopdfCommandAsArray() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Gets the wkhtmltopdf command as an array to be used while calling wkhtmltopdf It's default is 'wkhtmltopdf'

getXvfbConfig() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Gets the Xvfb configuration

I

isXvfbEnabled() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Verify whether the Xvfb support is enabled and configured

P

Page - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

The type Page.

Page(String, SourceType) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Instantiates a new Page.

Param - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.params

The type Param.

Param(String, String...) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param

Instantiates a new Param.

Param(String) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param

Instantiates a new Param.

Params - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.params

The type Params.

Params() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Params

Instantiates a new Params.

Pdf - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper

Represents a Pdf file and wraps up the wkhtmltopdf processing

Pdf() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Deprecated.

Pdf(WrapperConfig) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Instantiates a new Pdf.

PDFExportException - Exception in com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

Exception to describe and track pdf exporting errors

PDFExportException(String, int, byte[], byte[]) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException

Instantiates a new Pdf export exception.

PDFGenerationException - Exception in com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

Exception to describe and track pdf generation process errors

PDFGenerationException(Exception) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFGenerationException

Instantiates a new Pdf timeout exception when future process errors happens

PDFTimeoutException - Exception in com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

Exception to describe and track pdf exporting errors due to timeout

PDFTimeoutException(String, int, byte[]) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Instantiates a new Pdf timeout exception when wkhtmltopdf timeout happens

PDFTimeoutException(int, Exception) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFTimeoutException

Instantiates a new Pdf timeout exception when future process timeout happens

S

saveAs(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Executes the wkhtmltopdf into standard out and captures the results.

saveAsDirect(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Executes the wkhtmltopdf saving the results directly to the specified file path.

setAllowMissingAssets() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

wkhtmltopdf often returns 1 to indicate some assets can't be found, this can occur for protocol less links or in other cases.

setAlwaysPutTocFirst(boolean) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Sets the way TOC locations are determined in the command

setCommand(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Sets command.

setFilePath(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Sets file path.

SetObjectIdentifier() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.BaseObject

Set object identifier string.

SetObjectIdentifier() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Cover

SetObjectIdentifier() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

SetObjectIdentifier() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.TableOfContents

setSource(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Sets source.

setSuccessValues(List<Integer>) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

In standard process returns 0 means "ok" and any other value is an error.

setTempDirectory(File) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Sets the temporary folder to store files during the process Default is provided by #File.createTempFile()

setTimeout(int) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

Sets the timeout to wait while generating a PDF, in seconds

setType(SourceType) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.Page

Sets type.

setWkhtmltopdfCommand(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Sets the configuration based on a provided wkhtmltopdf command to be used

setXvfbConfig(XvfbConfig) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Sets the Xvfb configuration

SourceType - Enum in com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

The source type accepted by wkhtmltopdf

Symbol - Enum in com.github.jhonnymertz.wkhtmltopdf.wrapper.params

The enum Symbol.

T

TableOfContents - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.objects

The type Table of contents.

TableOfContents() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.TableOfContents

TEMPORARY_FILE_PREFIX - Static variable in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf

The constant TEMPORARY_FILE_PREFIX.

toString() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

toString() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

toString() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param

toString() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Params

toString() - Method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Symbol

V

valueOf(String) - Static method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.SourceType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Symbol

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.SourceType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Symbol

Returns an array containing the constants of this enum type, in the order they are declared.

W

WkhtmltopdfConfigurationException - Exception in com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

Exception to describe and track wrapper configuration errors

WkhtmltopdfConfigurationException(String) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.WkhtmltopdfConfigurationException

Instantiates a new Wkhtmltopdf configuration exception.

WrapperConfig - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations

Provides wrapper configuration such as the xvfb configuration and wkhtmltopdf command to be used

WrapperConfig() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Deprecated.

Use the constructor specifying the location of wkhtmltopdf. Use the static method findExecutable() if necessary.

WrapperConfig(String) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig

Initialize the configuration based on a provided wkhtmltopdf command to be used

WrapperConfigException - Exception in com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions

The type Wrapper config exception.

WrapperConfigException(String, Throwable) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.WrapperConfigException

Instantiates a new Wrapper config exception.

X

XvfbConfig - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations

Wrapper for Xvfb parameters and configuration

XvfbConfig() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Instantiates a new Xvfb config.

XvfbConfig(String) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig

Instantiates a new Xvfb config.

A B C F G I P S T V W X