|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.PdfPageEventHelper
com.atlassian.crucible.plugin.export.ReviewExporter
public class ReviewExporter
Handles exporting a Crucible review to PDF, using the iText(http://itextdocs.lowagie.com/) library.
Nested Class Summary | |
---|---|
class |
ReviewExporter.ReviewMap
Mapping of VersionedLineCommentData and
FisheyeReviewItemData instances. |
Constructor Summary | |
---|---|
ReviewExporter(CrucibleClient client,
java.util.Locale locale)
Constructs a ReviewExporter instance. |
Method Summary | |
---|---|
java.io.ByteArrayOutputStream |
createPdfExport(java.lang.String userName,
java.lang.String password,
java.lang.String reviewId)
Performs input validation checks, retrieves the ReviewData ,
GeneralCommentData and VersionedLineCommentData for the
specific reviewId, and invokes the PDF processing. |
CrucibleClient |
getClient()
Returns the CrucibleClient instance. |
void |
onCloseDocument(com.lowagie.text.pdf.PdfWriter writer,
com.lowagie.text.Document document)
Finishes the calculation of the page numbering. |
void |
onEndPage(com.lowagie.text.pdf.PdfWriter writer,
com.lowagie.text.Document document)
Displays the page number and page generation information. |
void |
onOpenDocument(com.lowagie.text.pdf.PdfWriter writer,
com.lowagie.text.Document document)
Adds the Crucible image to the top of the page |
void |
setBaseUrl(java.lang.String baseUrl)
Sets the baseUrl variable. |
Methods inherited from class com.lowagie.text.pdf.PdfPageEventHelper |
---|
onChapter, onChapterEnd, onGenericTag, onParagraph, onParagraphEnd, onSection, onSectionEnd, onStartPage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReviewExporter(CrucibleClient client, java.util.Locale locale)
client
- Method Detail |
---|
public CrucibleClient getClient()
CrucibleClient
instance.
public java.io.ByteArrayOutputStream createPdfExport(java.lang.String userName, java.lang.String password, java.lang.String reviewId) throws ExportException
ReviewData
,
GeneralCommentData
and VersionedLineCommentData
for the
specific reviewId, and invokes the PDF processing.
userName
- password
- reviewId
-
ExportException
public void onOpenDocument(com.lowagie.text.pdf.PdfWriter writer, com.lowagie.text.Document document)
onOpenDocument
in interface com.lowagie.text.pdf.PdfPageEvent
onOpenDocument
in class com.lowagie.text.pdf.PdfPageEventHelper
public void onEndPage(com.lowagie.text.pdf.PdfWriter writer, com.lowagie.text.Document document)
onEndPage
in interface com.lowagie.text.pdf.PdfPageEvent
onEndPage
in class com.lowagie.text.pdf.PdfPageEventHelper
public void onCloseDocument(com.lowagie.text.pdf.PdfWriter writer, com.lowagie.text.Document document)
onCloseDocument
in interface com.lowagie.text.pdf.PdfPageEvent
onCloseDocument
in class com.lowagie.text.pdf.PdfPageEventHelper
public void setBaseUrl(java.lang.String baseUrl)
baseUrl
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |