You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2010/01/31 19:54:16 UTC
svn commit: r905097 -
/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java
Author: lehmi
Date: Sun Jan 31 18:54:16 2010
New Revision: 905097
URL: http://svn.apache.org/viewvc?rev=905097&view=rev
Log:
PDFBOX-607: added an example on how to add a rubber stamp including an image to a pdf document.
Added:
pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java
Added: pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java?rev=905097&view=auto
==============================================================================
--- pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java (added)
+++ pdfbox/trunk/src/main/java/org/apache/pdfbox/examples/pdmodel/RubberStampWithImage.java Sun Jan 31 18:54:16 2010
@@ -0,0 +1,197 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.examples.pdmodel;
+
+import org.apache.pdfbox.cos.COSDictionary;
+import org.apache.pdfbox.exceptions.COSVisitorException;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDResources;
+import org.apache.pdfbox.pdmodel.common.PDRectangle;
+import org.apache.pdfbox.pdmodel.common.PDStream;
+import org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg;
+import org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm;
+import org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
+import org.apache.pdfbox.util.MapUtil;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.text.NumberFormat;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+/**
+ * This is an example on how to add a rubber stamp with an image to pages of a PDF document.
+ *
+ * @version $Revision: 1.0 $
+ */
+public class RubberStampWithImage
+{
+
+ private static final String SAVE_GRAPHICS_STATE = "q\n";
+ private static final String RESTORE_GRAPHICS_STATE = "Q\n";
+ private static final String CONCATENATE_MATRIX = "cm\n";
+ private static final String XOBJECT_DO = "Do\n";
+ private static final String SPACE = " ";
+
+ private static NumberFormat formatDecimal = NumberFormat.getNumberInstance( Locale.US );
+
+ /**
+ * Add a rubber stamp with an jpg image to every page of the given document.
+ * @param args the command line arguments
+ * @throws IOException an exception is thrown if something went wrong
+ */
+ public void doIt( String[] args ) throws IOException
+ {
+ if( args.length != 3 )
+ {
+ usage();
+ }
+ else
+ {
+ PDDocument document = null;
+ try
+ {
+ document = PDDocument.load( args[0] );
+ if( document.isEncrypted() )
+ {
+ throw new IOException( "Encrypted documents are not supported for this example" );
+ }
+ List allpages = new ArrayList();
+ document.getDocumentCatalog().getPages().getAllKids(allpages);
+ int numberOfPages = allpages.size();
+
+ for (int i=0; i < numberOfPages; i++)
+ {
+ PDPage apage = (PDPage) allpages.get(i);
+ List annotations = apage.getAnnotations();
+ PDAnnotationRubberStamp rubberStamp = new PDAnnotationRubberStamp();
+ rubberStamp.setName(PDAnnotationRubberStamp.NAME_TOP_SECRET);
+ rubberStamp.setRectangle(new PDRectangle(100,100));
+ rubberStamp.setContents("A top secret note");
+
+ // Create a PDXObjectImage with the given jpg
+ FileInputStream fin = new FileInputStream( args[2] );
+ PDJpeg mypic = new PDJpeg(document,fin);
+
+ //Define and set the target rectangle
+ PDRectangle myrect = new PDRectangle();
+ myrect.setUpperRightX(275);
+ myrect.setUpperRightY(575);
+ myrect.setLowerLeftX(250);
+ myrect.setLowerLeftY(550);
+
+ // Create a PDXObjectForm
+ PDStream formstream = new PDStream(document);
+ OutputStream os = formstream.createOutputStream();
+ PDXObjectForm form = new PDXObjectForm(formstream);
+ form.setResources(new PDResources());
+ form.setBBox(myrect);
+ form.setFormType(1);
+ // adjust the image to the target rectangle and add it to the stream
+ drawXObject(mypic, form.getResources(), os, 250, 550, 25, 25);
+ os.close();
+
+ PDAppearanceStream myDic = new PDAppearanceStream(form.getCOSStream());
+ PDAppearanceDictionary appearance = new PDAppearanceDictionary(new COSDictionary());
+ appearance.setNormalAppearance(myDic);
+ rubberStamp.setAppearance(appearance);
+ rubberStamp.setRectangle(myrect);
+
+ //Add the new RubberStamp to the document
+ annotations.add(rubberStamp);
+
+ }
+ document.save( args[1] );
+ }
+ catch(COSVisitorException exception)
+ {
+ System.err.println("An error occured during saving the document.");
+ System.err.println("Exception:"+exception);
+ }
+ finally
+ {
+ if( document != null )
+ {
+ document.close();
+ }
+ }
+ }
+ }
+
+ private void drawXObject( PDXObjectImage xobject, PDResources resources, OutputStream os,
+ float x, float y, float width, float height ) throws IOException
+ {
+ // This is similar to PDPageContentStream.drawXObject()
+ String xObjectPrefix = "Im";
+ String objMapping = MapUtil.getNextUniqueKey( resources.getImages(), xObjectPrefix );
+ resources.getXObjects().put( objMapping, xobject );
+
+ appendRawCommands( os, SAVE_GRAPHICS_STATE );
+ appendRawCommands( os, formatDecimal.format( width ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, formatDecimal.format( 0 ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, formatDecimal.format( 0 ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, formatDecimal.format( height ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, formatDecimal.format( x ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, formatDecimal.format( y ) );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, CONCATENATE_MATRIX );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, "/" );
+ appendRawCommands( os, objMapping );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, XOBJECT_DO );
+ appendRawCommands( os, SPACE );
+ appendRawCommands( os, RESTORE_GRAPHICS_STATE );
+ }
+
+ private void appendRawCommands(OutputStream os, String commands) throws IOException
+ {
+ os.write( commands.getBytes("ISO-8859-1"));
+ }
+
+ /**
+ * This creates an instance of RubberStampWithImage.
+ *
+ * @param args The command line arguments.
+ *
+ * @throws Exception If there is an error parsing the document.
+ */
+ public static void main( String[] args ) throws Exception
+ {
+ RubberStampWithImage rubberStamp = new RubberStampWithImage();
+ rubberStamp.doIt(args);
+ }
+
+ /**
+ * This will print the usage for this example.
+ */
+ private void usage()
+ {
+ System.err.println( "Usage: java "+getClass().getName()+" <input-pdf> <output-pdf> <jpeg-filename>" );
+ }
+}