C D E G I O P R S
All Classes All Packages
All Classes All Packages
All Classes All Packages
C
- createRequest() - Method in interface org.xwiki.export.pdf.job.PDFExportJobRequestFactory
- createRequest() - Method in class org.xwiki.export.pdf.script.PDFExportScriptService
D
- DocumentRenderingResult(DocumentReference, XDOM, String) - Constructor for class org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult
-
Create a new rendering result for the specified document.
E
- execute(PDFExportJobRequest) - Method in class org.xwiki.export.pdf.script.PDFExportScriptService
-
Schedule the execution of the given PDF export request.
G
- getChromeDockerContainerName() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- getChromeDockerImage() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- getChromeHost() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- getChromeRemoteDebuggingPort() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- getDepth() - Method in class org.xwiki.export.pdf.macro.PDFTocMacroParameters
- getDockerNetwork() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- getDocumentReference() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult
- getDocumentRenderingResults() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus
- getDocuments() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- getHTML() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult
- getJobId() - Method in class org.xwiki.export.pdf.macro.PDFTocMacroParameters
- getLastError() - Method in class org.xwiki.export.pdf.script.PDFExportScriptService
-
Get the error generated while performing the previously called action.
- getPDFFileReference() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus
- getRequiredSkinExtensions() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus
- getTemplate() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- getXDOM() - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult
- getXWikiHost() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
I
- isChromeDockerContainerReusable() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- isServerSide() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- isServerSide() - Method in interface org.xwiki.export.pdf.PDFExportConfiguration
- isWithCover() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- isWithFooter() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- isWithHeader() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
- isWithToc() - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
O
- org.xwiki.export.pdf - package org.xwiki.export.pdf
- org.xwiki.export.pdf.job - package org.xwiki.export.pdf.job
- org.xwiki.export.pdf.macro - package org.xwiki.export.pdf.macro
- org.xwiki.export.pdf.script - package org.xwiki.export.pdf.script
P
- PDFExportConfiguration - Interface in org.xwiki.export.pdf
-
PDF export configuration options.
- PDFExportJobRequest - Class in org.xwiki.export.pdf.job
-
Represents a request to export multiple XWiki documents as PDF.
- PDFExportJobRequest() - Constructor for class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Default constructor.
- PDFExportJobRequest(Request) - Constructor for class org.xwiki.export.pdf.job.PDFExportJobRequest
- PDFExportJobRequestFactory - Interface in org.xwiki.export.pdf.job
-
Used to create and initialize
PDFExportJobRequestinstances. - PDFExportJobStatus - Class in org.xwiki.export.pdf.job
-
The status of the PDF export job.
- PDFExportJobStatus(String, PDFExportJobRequest, ObservationManager, LoggerManager) - Constructor for class org.xwiki.export.pdf.job.PDFExportJobStatus
-
Create a new PDF export job status.
- PDFExportJobStatus.DocumentRenderingResult - Class in org.xwiki.export.pdf.job
-
The result obtained by rendering a given document.
- PDFExportScriptService - Class in org.xwiki.export.pdf.script
-
Scripting API to export documents as PDF.
- PDFExportScriptService() - Constructor for class org.xwiki.export.pdf.script.PDFExportScriptService
- PDFPrinter<T> - Interface in org.xwiki.export.pdf
-
Generic interface to print some data as PDF.
- PDFTocMacroParameters - Class in org.xwiki.export.pdf.macro
-
The parameters supported by
PDFTocMacro. - PDFTocMacroParameters() - Constructor for class org.xwiki.export.pdf.macro.PDFTocMacroParameters
- print(T) - Method in interface org.xwiki.export.pdf.PDFPrinter
-
Prints the specified data as PDF.
R
- ROLE_HINT - Static variable in class org.xwiki.export.pdf.script.PDFExportScriptService
-
The role hint of this script service.
S
- setDepth(int) - Method in class org.xwiki.export.pdf.macro.PDFTocMacroParameters
- setDocuments(List<DocumentReference>) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets the list of documents to export as PDF.
- setJobId(String) - Method in class org.xwiki.export.pdf.macro.PDFTocMacroParameters
-
Specifies the PDF export job for which to generate the table of contents.
- setRequiredSkinExtensions(String) - Method in class org.xwiki.export.pdf.job.PDFExportJobStatus
-
Sets the skin extensions required by the rendered documents.
- setRightsProperties(PDFExportJobRequest) - Method in interface org.xwiki.export.pdf.job.PDFExportJobRequestFactory
-
Sets the access rights related properties on the given PDF export request.
- setServerSide(boolean) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets whether to generate the PDF file server-side, as a temporary resource, or client-side.
- setTemplate(DocumentReference) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets the PDF template.
- setWithCover(boolean) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets whether to generate the cover page or not.
- setWithFooter(boolean) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets whether to generate the page footer or not.
- setWithHeader(boolean) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets whether to generate the page header or not.
- setWithToc(boolean) - Method in class org.xwiki.export.pdf.job.PDFExportJobRequest
-
Sets whether to generate the table of contents page or not.
All Classes All Packages