com.lowagie.text.pdf
Class PdfCopy

java.lang.Object
  extended bycom.lowagie.text.DocWriter
      extended bycom.lowagie.text.pdf.PdfWriter
          extended bycom.lowagie.text.pdf.PdfCopy
All Implemented Interfaces:
DocListener, ElementListener, EventListener, PdfAnnotations, PdfDocumentActions, PdfEncryptionSettings, PdfPageActions, PdfRunDirection, PdfVersion, PdfViewerPreferences, PdfXConformance
Direct Known Subclasses:
PdfSmartCopy

public class PdfCopy
extends PdfWriter

Make copies of PDF documents. Documents can be edited after reading and before writing them out.

Author:
Mark Thompson

Nested Class Summary
static class PdfCopy.PageStamp
           
static class PdfCopy.StampContent
           
 
Nested classes inherited from class com.lowagie.text.pdf.PdfWriter
PdfWriter.PdfBody
 
Field Summary
 
Fields inherited from class com.lowagie.text.pdf.PdfWriter
ALLOW_ASSEMBLY, ALLOW_COPY, ALLOW_DEGRADED_PRINTING, ALLOW_FILL_IN, ALLOW_MODIFY_ANNOTATIONS, ALLOW_MODIFY_CONTENTS, ALLOW_PRINTING, ALLOW_SCREENREADERS, AllowAssembly, AllowCopy, AllowDegradedPrinting, AllowFillIn, AllowModifyAnnotations, AllowModifyContents, AllowPrinting, AllowScreenReaders, CenterWindow, DID_PRINT, DID_SAVE, DirectionL2R, DirectionR2L, DisplayDocTitle, DO_NOT_ENCRYPT_METADATA, DOCUMENT_CLOSE, EMBEDDED_FILES_ONLY, ENCRYPTION_AES_128, FitWindow, HideMenubar, HideToolbar, HideWindowUI, NO_SPACE_CHAR_RATIO, NonFullScreenPageModeUseNone, NonFullScreenPageModeUseOC, NonFullScreenPageModeUseOutlines, NonFullScreenPageModeUseThumbs, PAGE_CLOSE, PAGE_OPEN, PageLayoutOneColumn, PageLayoutSinglePage, PageLayoutTwoColumnLeft, PageLayoutTwoColumnRight, PageLayoutTwoPageLeft, PageLayoutTwoPageRight, PageModeFullScreen, PageModeUseAttachments, PageModeUseNone, PageModeUseOC, PageModeUseOutlines, PageModeUseThumbs, PDF_VERSION_1_2, PDF_VERSION_1_3, PDF_VERSION_1_4, PDF_VERSION_1_5, PDF_VERSION_1_6, PDF_VERSION_1_7, PDFA1A, PDFA1B, PDFX1A2001, PDFX32002, PDFXNONE, PrintScalingNone, RUN_DIRECTION_DEFAULT, RUN_DIRECTION_LTR, RUN_DIRECTION_NO_BIDI, RUN_DIRECTION_RTL, SIGNATURE_APPEND_ONLY, SIGNATURE_EXISTS, SPACE_CHAR_RATIO_DEFAULT, STANDARD_ENCRYPTION_128, STANDARD_ENCRYPTION_40, STRENGTH128BITS, STRENGTH40BITS, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_5, VERSION_1_6, VERSION_1_7, WILL_PRINT, WILL_SAVE
 
Fields inherited from class com.lowagie.text.DocWriter
EQUALS, FORWARD, GT, LT, NEWLINE, QUOTE, SPACE, TAB
 
Constructor Summary
PdfCopy(Document document, OutputStream os)
          Constructor
 
Method Summary
 PdfIndirectReference add(PdfOutline outline)
           
 void addAnnotation(PdfAnnotation annot)
          Use this methods to add a PdfAnnotation or a PdfFormField to the document.
 void addPage(PdfImportedPage iPage)
          Add an imported page to our output
 void close()
          Signals that the Document was closed and that no other Elements will be added.
 void copyAcroForm(PdfReader reader)
          Copy the acroform for an input document.
 PdfCopy.PageStamp createPageStamp(PdfImportedPage iPage)
          Create a page stamp.
 void freeReader(PdfReader reader)
          Use this method to writes the reader to the document and free the memory used by it.
 PdfImportedPage getImportedPage(PdfReader reader, int pageNumber)
          Grabs a page from the input document
 boolean isRotateContents()
          Getter for property rotateContents.
 void setRotateContents(boolean rotateContents)
          Setter for property rotateContents.
 
Methods inherited from class com.lowagie.text.pdf.PdfWriter
addCalculationOrder, addDirectImageSimple, addDirectImageSimple, addFileAttachment, addFileAttachment, addFileAttachment, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addJavaScript, addOCGRadioGroup, addToBody, addToBody, addToBody, addToBody, addToBody, addToBody, addViewerPreference, clearTextWrap, createXmpMetadata, fitsPage, fitsPage, getAcroForm, getBoxSize, getCompressionLevel, getCurrentDocumentSize, getCurrentPageNumber, getDefaultColorspace, getDirectContent, getDirectContentUnder, getExtraCatalog, getGroup, getInfo, getInstance, getInstance, getOCProperties, getPageEvent, getPageNumber, getPageReference, getPageSize, getPdfIndirectReference, getPDFXConformance, getRootOutline, getRunDirection, getSpaceCharRatio, getStructureTreeRoot, getUserunit, getVerticalPosition, isFullCompression, isPdfX, isRgbTransparencyBlending, isStrictImageSequence, isTagged, isUserProperties, lockLayer, open, releaseTemplate, reorderPages, setAdditionalAction, setAtLeastPdfVersion, setBoxSize, setCollection, setCompressionLevel, setCropBoxSize, setDefaultColorspace, setDuration, setEncryption, setEncryption, setEncryption, setEncryption, setEncryption, setFullCompression, setGroup, setLinearPageMode, setOpenAction, setOpenAction, setOutlines, setOutputIntents, setOutputIntents, setPageAction, setPageEmpty, setPageEvent, setPageLabels, setPageXmpMetadata, setPdfVersion, setPdfVersion, setPDFXConformance, setRgbTransparencyBlending, setRunDirection, setSigFlags, setSpaceCharRatio, setStrictImageSequence, setTagged, setThumbnail, setTransition, setUserProperties, setUserunit, setViewerPreferences, setXmpMetadata
 
Methods inherited from class com.lowagie.text.DocWriter
add, flush, getISOBytes, isCloseStream, isPaused, newPage, pause, resetFooter, resetHeader, resetPageCount, resume, setCloseStream, setFooter, setHeader, setMarginMirroring, setMargins, setPageCount, setPageSize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PdfCopy

public PdfCopy(Document document,
               OutputStream os)
        throws DocumentException
Constructor

Parameters:
document -
os - outputstream
Method Detail

isRotateContents

public boolean isRotateContents()
Getter for property rotateContents.

Returns:
Value of property rotateContents.

setRotateContents

public void setRotateContents(boolean rotateContents)
Setter for property rotateContents.

Parameters:
rotateContents - New value of property rotateContents.

getImportedPage

public PdfImportedPage getImportedPage(PdfReader reader,
                                       int pageNumber)
Grabs a page from the input document

Overrides:
getImportedPage in class PdfWriter
Parameters:
reader - the reader of the document
pageNumber - which page to get
Returns:
the page

addPage

public void addPage(PdfImportedPage iPage)
             throws IOException,
                    BadPdfFormatException
Add an imported page to our output

Parameters:
iPage - an imported page
Throws:
IOException, - BadPdfFormatException
IOException
BadPdfFormatException

copyAcroForm

public void copyAcroForm(PdfReader reader)
                  throws IOException,
                         BadPdfFormatException
Copy the acroform for an input document. Note that you can only have one, we make no effort to merge them.

Parameters:
reader - The reader of the input file that is being copied
Throws:
IOException, - BadPdfFormatException
IOException
BadPdfFormatException

close

public void close()
Signals that the Document was closed and that no other Elements will be added.

The pages-tree is built and written to the outputstream. A Catalog is constructed, as well as an Info-object, the reference table is composed and everything is written to the outputstream embedded in a Trailer.

Specified by:
close in interface DocListener
Overrides:
close in class PdfWriter
See Also:
DocWriter.close()

add

public PdfIndirectReference add(PdfOutline outline)

addAnnotation

public void addAnnotation(PdfAnnotation annot)
Description copied from interface: PdfAnnotations
Use this methods to add a PdfAnnotation or a PdfFormField to the document. Only the top parent of a PdfFormField needs to be added.

Specified by:
addAnnotation in interface PdfAnnotations
Overrides:
addAnnotation in class PdfWriter
See Also:
PdfAnnotations.addAnnotation(com.lowagie.text.pdf.PdfAnnotation)

freeReader

public void freeReader(PdfReader reader)
                throws IOException
Description copied from class: PdfWriter
Use this method to writes the reader to the document and free the memory used by it. The main use is when concatenating multiple documents to keep the memory usage restricted to the current appending document.

Overrides:
freeReader in class PdfWriter
Parameters:
reader - the PdfReader to free
Throws:
IOException - on error

createPageStamp

public PdfCopy.PageStamp createPageStamp(PdfImportedPage iPage)
Create a page stamp. New content and annotations, including new fields, are allowed. The fields added cannot have parents in another pages. This method modifies the PdfReader instance.

The general usage to stamp something in a page is:

 PdfImportedPage page = copy.getImportedPage(reader, 1);
 PdfCopy.PageStamp ps = copy.createPageStamp(page);
 ps.addAnnotation(PdfAnnotation.createText(copy, new Rectangle(50, 180, 70, 200), "Hello", "No Thanks", true, "Comment"));
 PdfContentByte under = ps.getUnderContent();
 under.addImage(img);
 PdfContentByte over = ps.getOverContent();
 over.beginText();
 over.setFontAndSize(bf, 18);
 over.setTextMatrix(30, 30);
 over.showText("total page " + totalPage);
 over.endText();
 ps.alterContents();
 copy.addPage(page);
 

Parameters:
iPage - an imported page
Returns:
the PageStamp


Copyright © 2011 EGIZ - E-Government Innovation Center. All Rights Reserved.