Package org.xwiki.export.pdf.job
Class PDFExportJobStatus.DocumentRenderingResult
- java.lang.Object
-
- org.xwiki.export.pdf.job.PDFExportJobStatus.DocumentRenderingResult
-
- Enclosing class:
- PDFExportJobStatus
public static class PDFExportJobStatus.DocumentRenderingResult extends Object
The result obtained by rendering a given document.- Version:
- $Id: f5dcd5420c32ab7f7bb48a2ed68a95a49f06b8c8 $
-
-
Constructor Summary
Constructors Constructor Description DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, String html)
Create a new rendering result for the specified document.DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, String html, Map<String,String> idMap)
Create a new rendering result for the specified document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.xwiki.model.reference.DocumentReference
getDocumentReference()
String
getHTML()
Map<String,String>
getIdMap()
org.xwiki.rendering.block.XDOM
getXDOM()
-
-
-
Constructor Detail
-
DocumentRenderingResult
public DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, String html)
Create a new rendering result for the specified document.- Parameters:
documentReference
- the document that has been renderedxdom
- the XDOM obtained by rendering the specified documenthtml
- the HTML obtained by rendering the specified document
-
DocumentRenderingResult
public DocumentRenderingResult(org.xwiki.model.reference.DocumentReference documentReference, org.xwiki.rendering.block.XDOM xdom, String html, Map<String,String> idMap)
Create a new rendering result for the specified document.- Parameters:
documentReference
- the document that has been renderedxdom
- the XDOM obtained by rendering the specified documenthtml
- the HTML obtained by rendering the specified documentidMap
- the mapping between local IDs (that would have been generated if the document were rendered alone) and global IDs (that were actually generated when the document was rendered together with the other documents included in the PDF export); this mapping can be used to convert external links into internal links- Since:
- 14.10.6, 15.1RC1
-
-
Method Detail
-
getDocumentReference
public org.xwiki.model.reference.DocumentReference getDocumentReference()
- Returns:
- the document that has been rendered
-
getXDOM
public org.xwiki.rendering.block.XDOM getXDOM()
- Returns:
- the XDOM obtained by rendering the specified document, after executing the rendering transformations; this is needed in order to generate the table of contents for the PDF export
-
getHTML
public String getHTML()
- Returns:
- the HTML obtained by rendering the specified document; the PDF sheet aggregates the HTML from all the exported documents in order to produce the PDF file
-
getIdMap
public Map<String,String> getIdMap()
- Returns:
- the mapping between local IDs (that would have been generated if the document were rendered alone) and global IDs (that were actually generated when the document was rendered together with the other documents included in the PDF export); this mapping can be used to convert external links into internal links
- Since:
- 14.10.6, 15.1RC1
-
-