A C F G H I P S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
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
- addPage(String, PageType) - 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.Pdf
- addParams(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig
- addToc() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf
- addTocParam(Param, Param...) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf
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.page - package com.github.jhonnymertz.wkhtmltopdf.wrapper.page
- com.github.jhonnymertz.wkhtmltopdf.wrapper.params - package com.github.jhonnymertz.wkhtmltopdf.wrapper.params
F
- file - com.github.jhonnymertz.wkhtmltopdf.wrapper.page.PageType
-
File page
- 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
- getCommand() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig
- getCommand() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException
- 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
- getCommandLine() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig
- getErr() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException
- getExitStatus() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException
- getFilePath() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- getKey() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param
- getMessage() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException
- getOut() - Method in exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.PDFExportException
- getParamsAsStringList() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Params
- 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.page.Page
- getType() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- getValues() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param
- getWkhtmltopdfCommand() - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig
-
Gets the wkhtmltopdf command 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
H
- htmlAsString - com.github.jhonnymertz.wkhtmltopdf.wrapper.page.PageType
-
Html as string
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.page
- Page(String, PageType) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- PageType - Enum in com.github.jhonnymertz.wkhtmltopdf.wrapper.page
-
The Page type accepted by wkhtmltopdf
- param - com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Symbol
- Param - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.params
- Param(String) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param
- Param(String, String...) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param
- Params - Class in com.github.jhonnymertz.wkhtmltopdf.wrapper.params
- Params() - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.params.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
- 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
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.
- separator - com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Symbol
- 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.
- setCommand(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig
- setFilePath(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- setSource(String) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- 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(PageType) - Method in class com.github.jhonnymertz.wkhtmltopdf.wrapper.page.Page
- 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
- Symbol - Enum in com.github.jhonnymertz.wkhtmltopdf.wrapper.params
T
- 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
U
V
- valueOf(String) - Static method in enum com.github.jhonnymertz.wkhtmltopdf.wrapper.page.PageType
-
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.page.PageType
-
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
- 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
- WrapperConfigException(String, Throwable) - Constructor for exception com.github.jhonnymertz.wkhtmltopdf.wrapper.exceptions.WrapperConfigException
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
- XvfbConfig(String) - Constructor for class com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.XvfbConfig
All Classes All Packages