From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001
From: tknall <tknall@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c>
Date: Fri, 1 Dec 2006 12:20:24 +0000
Subject: Initial import of release 2.2.

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c
---
 src/main/java/org/pdfbox/pdmodel/PDPage.java | 776 +++++++++++++++++++++++++++
 1 file changed, 776 insertions(+)
 create mode 100644 src/main/java/org/pdfbox/pdmodel/PDPage.java

(limited to 'src/main/java/org/pdfbox/pdmodel/PDPage.java')

diff --git a/src/main/java/org/pdfbox/pdmodel/PDPage.java b/src/main/java/org/pdfbox/pdmodel/PDPage.java
new file mode 100644
index 0000000..3739a5a
--- /dev/null
+++ b/src/main/java/org/pdfbox/pdmodel/PDPage.java
@@ -0,0 +1,776 @@
+/**
+ * Copyright (c) 2003-2005, www.pdfbox.org
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of pdfbox; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://www.pdfbox.org
+ *
+ */
+package org.pdfbox.pdmodel;
+
+import org.pdfbox.cos.COSArray;
+import org.pdfbox.cos.COSBase;
+import org.pdfbox.cos.COSDictionary;
+import org.pdfbox.cos.COSInteger;
+import org.pdfbox.cos.COSName;
+import org.pdfbox.cos.COSNumber;
+import org.pdfbox.cos.COSStream;
+
+import org.pdfbox.pdfviewer.PageDrawer;
+import org.pdfbox.pdmodel.common.COSArrayList;
+import org.pdfbox.pdmodel.common.COSObjectable;
+import org.pdfbox.pdmodel.common.PDMetadata;
+import org.pdfbox.pdmodel.common.PDRectangle;
+import org.pdfbox.pdmodel.common.PDStream;
+import org.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions;
+import org.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
+import org.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.image.BufferedImage;
+import java.awt.print.PageFormat;
+import java.awt.print.Paper;
+import java.awt.print.Printable;
+import java.awt.print.PrinterException;
+import java.awt.print.PrinterIOException;
+import java.io.IOException;
+
+import java.util.ArrayList;
+import java.util.Calendar;
+import java.util.GregorianCalendar;
+import java.util.List;
+
+/**
+ * This represents a single page in a PDF document.
+ *
+ * @author  Ben Litchfield (ben@benlitchfield.com)
+ * @version $Revision: 1.24 $
+ */
+public class PDPage implements COSObjectable, Printable
+{
+    private COSDictionary page;
+    
+    /**
+     * A page size of LETTER or 8.5x11.
+     */
+    public static final PDRectangle PAGE_SIZE_LETTER = new PDRectangle( 612, 792 );
+    
+
+    /**
+     * Creates a new instance of PDPage with a size of 8.5x11.
+     */
+    public PDPage()
+    {
+        page = new COSDictionary();
+        page.setItem( COSName.TYPE, COSName.PAGE );
+        setMediaBox( PAGE_SIZE_LETTER );
+    }
+
+    /**
+     * Creates a new instance of PDPage.
+     *
+     * @param pageDic The existing page dictionary.
+     */
+    public PDPage( COSDictionary pageDic )
+    {
+        page = pageDic;
+    }
+
+    /**
+     * Convert this standard java object to a COS object.
+     *
+     * @return The cos object that matches this Java object.
+     */
+    public COSBase getCOSObject()
+    {
+        return page;
+    }
+
+    /**
+     * This will get the underlying dictionary that this class acts on.
+     *
+     * @return The underlying dictionary for this class.
+     */
+    public COSDictionary getCOSDictionary()
+    {
+        return page;
+    }
+
+
+    /**
+     * This is the parent page node.  The parent is a required element of the
+     * page.  This will be null until this page is added to the document.
+     *
+     * @return The parent to this page.
+     */
+    public PDPageNode getParent()
+    {
+        PDPageNode parent = null;
+        COSDictionary parentDic = (COSDictionary)page.getDictionaryObject( COSName.PARENT );
+        if( parentDic != null )
+        {
+            parent = new PDPageNode( parentDic );
+        }
+        return parent;
+    }
+
+    /**
+     * This will set the parent of this page.
+     *
+     * @param parent The parent to this page node.
+     */
+    public void setParent( PDPageNode parent )
+    {
+        page.setItem( COSName.PARENT, parent.getDictionary() );
+    }
+
+    /**
+     * This will update the last modified time for the page object.
+     */
+    public void updateLastModified()
+    {
+        page.setDate( "LastModified", new GregorianCalendar() );
+    }
+
+    /**
+     * This will get the date that the content stream was last modified.  This
+     * may return null.
+     *
+     * @return The date the content stream was last modified.
+     *
+     * @throws IOException If there is an error accessing the date information.
+     */
+    public Calendar getLastModified() throws IOException
+    {
+        return page.getDate( "LastModified" );
+    }
+
+    /**
+     * This will get the resources at this page and not look up the hierarchy.
+     * This attribute is inheritable, and findResources() should probably used.
+     * This will return null if no resources are available at this level.
+     *
+     * @return The resources at this level in the hierarchy.
+     */
+    public PDResources getResources()
+    {
+        PDResources retval = null;
+        COSDictionary resources = (COSDictionary)page.getDictionaryObject( COSName.RESOURCES );
+        if( resources != null )
+        {
+            retval = new PDResources( resources );
+        }
+        return retval;
+    }
+
+    /**
+     * This will find the resources for this page by looking up the hierarchy until
+     * it finds them.
+     *
+     * @return The resources at this level in the hierarchy.
+     */
+    public PDResources findResources()
+    {
+        PDResources retval = getResources();
+        PDPageNode parent = getParent();
+        if( retval == null && parent != null )
+        {
+            retval = parent.findResources();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the resources for this page.
+     *
+     * @param resources The new resources for this page.
+     */
+    public void setResources( PDResources resources )
+    {
+        page.setItem( COSName.RESOURCES, resources );
+    }
+
+    /**
+     * A rectangle, expressed
+     * in default user space units, defining the boundaries of the physical
+     * medium on which the page is intended to be displayed or printed
+     *
+     * This will get the MediaBox at this page and not look up the hierarchy.
+     * This attribute is inheritable, and findMediaBox() should probably used.
+     * This will return null if no MediaBox are available at this level.
+     *
+     * @return The MediaBox at this level in the hierarchy.
+     */
+    public PDRectangle getMediaBox()
+    {
+        PDRectangle retval = null;
+        COSArray array = (COSArray)page.getDictionaryObject( COSName.MEDIA_BOX );
+        if( array != null )
+        {
+            retval = new PDRectangle( array );
+        }
+        return retval;
+    }
+
+    /**
+     * This will find the MediaBox for this page by looking up the hierarchy until
+     * it finds them.
+     *
+     * @return The MediaBox at this level in the hierarchy.
+     */
+    public PDRectangle findMediaBox()
+    {
+        PDRectangle retval = getMediaBox();
+        PDPageNode parent = getParent();
+        if( retval == null && parent != null )
+        {
+            retval = parent.findMediaBox();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the mediaBox for this page.
+     *
+     * @param mediaBox The new mediaBox for this page.
+     */
+    public void setMediaBox( PDRectangle mediaBox )
+    {
+        if( mediaBox == null )
+        {
+            page.removeItem( COSName.MEDIA_BOX );
+        }
+        else
+        {
+            page.setItem( COSName.MEDIA_BOX, mediaBox.getCOSArray() );
+        }
+    }
+
+    /**
+     * A rectangle, expressed in default user space units,
+     * defining the visible region of default user space. When the page is displayed
+     * or printed, its contents are to be clipped (cropped) to this rectangle
+     * and then imposed on the output medium in some implementationdefined
+     * manner
+     *
+     * This will get the CropBox at this page and not look up the hierarchy.
+     * This attribute is inheritable, and findCropBox() should probably used.
+     * This will return null if no CropBox is available at this level.
+     *
+     * @return The CropBox at this level in the hierarchy.
+     */
+    public PDRectangle getCropBox()
+    {
+        PDRectangle retval = null;
+        COSArray array = (COSArray)page.getDictionaryObject( COSName.CROP_BOX);
+        if( array != null )
+        {
+            retval = new PDRectangle( array );
+        }
+        return retval;
+    }
+
+    /**
+     * This will find the CropBox for this page by looking up the hierarchy until
+     * it finds them.
+     *
+     * @return The CropBox at this level in the hierarchy.
+     */
+    public PDRectangle findCropBox()
+    {
+        PDRectangle retval = getCropBox();
+        PDPageNode parent = getParent();
+        if( retval == null && parent != null )
+        {
+            retval = findParentCropBox( parent );
+        }
+
+        //default value for cropbox is the media box
+        if( retval == null )
+        {
+            retval = findMediaBox();
+        }
+        return retval;
+    }
+
+    /**
+     * This will search for a crop box in the parent and return null if it is not
+     * found.  It will NOT default to the media box if it cannot be found.
+     *
+     * @param node The node
+     */
+    private PDRectangle findParentCropBox( PDPageNode node )
+    {
+        PDRectangle rect = node.getCropBox();
+        PDPageNode parent = node.getParent();
+        if( rect == null && parent != null )
+        {
+            rect = findParentCropBox( parent );
+        }
+        return rect;
+    }
+
+    /**
+     * This will set the CropBox for this page.
+     *
+     * @param cropBox The new CropBox for this page.
+     */
+    public void setCropBox( PDRectangle cropBox )
+    {
+        if( cropBox == null )
+        {
+            page.removeItem( COSName.CROP_BOX );
+        }
+        else
+        {
+            page.setItem( COSName.CROP_BOX, cropBox.getCOSArray() );
+        }
+    }
+
+    /**
+     * A rectangle, expressed in default user space units, defining
+     * the region to which the contents of the page should be clipped
+     * when output in a production environment.  The default is the CropBox.
+     *
+     * @return The BleedBox attribute.
+     */
+    public PDRectangle getBleedBox()
+    {
+        PDRectangle retval = null;
+        COSArray array = (COSArray)page.getDictionaryObject( COSName.BLEED_BOX );
+        if( array != null )
+        {
+            retval = new PDRectangle( array );
+        }
+        else
+        {
+            retval = findCropBox();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the BleedBox for this page.
+     *
+     * @param bleedBox The new BleedBox for this page.
+     */
+    public void setBleedBox( PDRectangle bleedBox )
+    {
+        if( bleedBox == null )
+        {
+            page.removeItem( COSName.BLEED_BOX );
+        }
+        else
+        {
+            page.setItem( COSName.BLEED_BOX, bleedBox.getCOSArray() );
+        }
+    }
+
+    /**
+     * A rectangle, expressed in default user space units, defining
+     * the intended dimensions of the finished page after trimming.
+     * The default is the CropBox.
+     *
+     * @return The TrimBox attribute.
+     */
+    public PDRectangle getTrimBox()
+    {
+        PDRectangle retval = null;
+        COSArray array = (COSArray)page.getDictionaryObject( COSName.TRIM_BOX );
+        if( array != null )
+        {
+            retval = new PDRectangle( array );
+        }
+        else
+        {
+            retval = findCropBox();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the TrimBox for this page.
+     *
+     * @param trimBox The new TrimBox for this page.
+     */
+    public void setTrimBox( PDRectangle trimBox )
+    {
+        if( trimBox == null )
+        {
+            page.removeItem( COSName.TRIM_BOX );
+        }
+        else
+        {
+            page.setItem( COSName.TRIM_BOX, trimBox.getCOSArray() );
+        }
+    }
+
+    /**
+     * A rectangle, expressed in default user space units, defining
+     * the extent of the page's meaningful content (including potential
+     * white space) as intended by the page's creator  The default isthe CropBox.
+     *
+     * @return The ArtBox attribute.
+     */
+    public PDRectangle getArtBox()
+    {
+        PDRectangle retval = null;
+        COSArray array = (COSArray)page.getDictionaryObject( COSName.ART_BOX );
+        if( array != null )
+        {
+            retval = new PDRectangle( array );
+        }
+        else
+        {
+            retval = findCropBox();
+        }
+        return retval;
+    }
+
+    /**
+     * This will set the ArtBox for this page.
+     *
+     * @param artBox The new ArtBox for this page.
+     */
+    public void setArtBox( PDRectangle artBox )
+    {
+        if( artBox == null )
+        {
+            page.removeItem( COSName.ART_BOX );
+        }
+        else
+        {
+            page.setItem( COSName.ART_BOX, artBox.getCOSArray() );
+        }
+    }
+
+
+    //todo BoxColorInfo
+    //todo Contents
+
+    /**
+     * A value representing the rotation.  This will be null if not set at this level
+     * The number of degrees by which the page should
+     * be rotated clockwise when displayed or printed. The value must be a multiple
+     * of 90.
+     *
+     * This will get the rotation at this page and not look up the hierarchy.
+     * This attribute is inheritable, and findRotation() should probably used.
+     * This will return null if no rotation is available at this level.
+     *
+     * @return The rotation at this level in the hierarchy.
+     */
+    public Integer getRotation()
+    {
+        Integer retval = null;
+        COSNumber value = (COSNumber)page.getDictionaryObject( COSName.ROTATE );
+        if( value != null )
+        {
+            retval = new Integer( value.intValue() );
+        }
+        return retval;
+    }
+
+    /**
+     * This will find the rotation for this page by looking up the hierarchy until
+     * it finds them.
+     *
+     * @return The rotation at this level in the hierarchy.
+     */
+    public int findRotation()
+    {
+        int retval = 0;
+        Integer rotation = getRotation();
+        if( rotation != null )
+        {
+            retval = rotation.intValue();
+        }
+        else
+        {
+            PDPageNode parent = getParent();
+            if( parent != null )
+            {
+                retval = parent.findRotation();
+            }
+        }
+
+        return retval;
+    }
+
+    /**
+     * This will set the rotation for this page.
+     *
+     * @param rotation The new rotation for this page.
+     */
+    public void setRotation( int rotation )
+    {
+        page.setItem( COSName.ROTATE, new COSInteger( rotation ) );
+    }
+
+    /**
+     * This will get the contents of the PDF Page, in the case that the contents
+     * of the page is an array then then the entire array of streams will be
+     * be wrapped and appear as a single stream.
+     *
+     * @return The page content stream.
+     *
+     * @throws IOException If there is an error obtaining the stream.
+     */
+    public PDStream getContents() throws IOException
+    {
+        return PDStream.createFromCOS( page.getDictionaryObject( COSName.CONTENTS ) );
+    }
+
+    /**
+     * This will set the contents of this page.
+     *
+     * @param contents The new contents of the page.
+     */
+    public void setContents( PDStream contents )
+    {
+        page.setItem( COSName.CONTENTS, contents );
+    }
+    
+    /**
+     * This will get a list of PDThreadBead objects, which are article threads in the
+     * document.  This will return an empty list of there are no thread beads.
+     * 
+     * @return A list of article threads on this page.
+     */
+    public List getThreadBeads()
+    {
+        COSArray beads = (COSArray)page.getDictionaryObject( COSName.B );
+        if( beads == null )
+        {
+            beads = new COSArray();
+        }
+        List pdObjects = new ArrayList();
+        for( int i=0; i<beads.size(); i++)
+        {
+            COSDictionary beadDic = (COSDictionary)beads.getObject( i );
+            PDThreadBead bead = null;
+            //in some cases the bead is null
+            if( beadDic != null )
+            {
+                bead = new PDThreadBead( beadDic );
+            }
+            pdObjects.add( bead );
+        }
+        return new COSArrayList(pdObjects, beads);
+        
+    }
+    
+    /**
+     * This will set the list of thread beads.
+     * 
+     * @param beads A list of PDThreadBead objects or null.
+     */
+    public void setThreadBeads( List beads )
+    {
+        page.setItem( COSName.B, COSArrayList.converterToCOSArray( beads ) );
+    }
+    
+    /**
+     * Get the metadata that is part of the document catalog.  This will 
+     * return null if there is no meta data for this object.
+     * 
+     * @return The metadata for this object.
+     */
+    public PDMetadata getMetadata()
+    {
+        PDMetadata retval = null;
+        COSStream stream = (COSStream)page.getDictionaryObject( COSName.METADATA );
+        if( stream != null )
+        {
+            retval = new PDMetadata( stream );
+        }
+        return retval;
+    }
+    
+    /**
+     * Set the metadata for this object.  This can be null.
+     * 
+     * @param meta The meta data for this object.
+     */
+    public void setMetadata( PDMetadata meta )
+    {
+        page.setItem( COSName.METADATA, meta );
+    }
+    
+    /**
+     * Convert this page to an output image.
+     * 
+     * @return A graphical representation of this page.
+     * 
+     * @throws IOException If there is an error drawing to the image.
+     */
+    public BufferedImage convertToImage() throws IOException
+    {
+        int scaling = 2;
+        int rotation = findRotation();
+        PDRectangle mBox = findMediaBox();
+        int width = (int)(mBox.getWidth());//*2);
+        int height = (int)(mBox.getHeight());//*2);
+        if( rotation == 90 || rotation == 270 )
+        {
+            int tmp = width;
+            width = height;
+            height = tmp;
+        }
+        Dimension pageDimension = new Dimension( width, height );
+        
+        //note we are doing twice as many pixels because
+        //the default size is not really good resolution,
+        //so create an image that is twice the size
+        //and let the client scale it down.
+        BufferedImage retval = 
+            new BufferedImage( width*scaling, height*scaling, BufferedImage.TYPE_BYTE_INDEXED );
+        Graphics2D graphics = (Graphics2D)retval.getGraphics();
+        graphics.setColor( Color.WHITE );
+        graphics.fillRect(0,0,width*scaling, height*scaling);
+        graphics.scale( scaling, scaling );
+        PageDrawer drawer = new PageDrawer();
+        drawer.drawPage( graphics, this, pageDimension );
+        
+        
+        return retval;
+    }
+    
+    /**
+     * Get the page actions.
+     * 
+     * @return The Actions for this Page 
+     */
+    public PDPageAdditionalActions getActions()
+    {
+        COSDictionary addAct = (COSDictionary) page.getDictionaryObject(COSName.AA);
+        if (addAct == null)
+        {
+            addAct = new COSDictionary();
+            page.setItem(COSName.AA, addAct);
+        }        
+        return new PDPageAdditionalActions(addAct);
+    }
+    
+    /**
+     * Set the page actions.
+     * 
+     * @param actions The actions for the page.
+     */
+    public void setActions( PDPageAdditionalActions actions )
+    {
+        page.setItem( COSName.AA, actions );
+    }
+    
+    /**
+     * This will return a list of the Annotations for this page.
+     *
+     * @return List of the PDAnnotation objects.
+     * 
+     * @throws IOException If there is an error while creating the annotations.
+     */
+    public List getAnnotations() throws IOException
+    {
+        COSArrayList retval = null;
+        COSArray annots = (COSArray)page.getDictionaryObject(COSName.ANNOTS); 
+        if (annots == null) 
+        {
+            annots = new COSArray();
+            page.setItem(COSName.ANNOTS, annots);
+            retval = new COSArrayList(new ArrayList(), annots);
+        }
+        else
+        {        
+            List actuals = new ArrayList();
+        
+            for (int i=0; i < annots.size(); i++) 
+            {
+                COSBase item = annots.getObject(i);
+                actuals.add( PDAnnotation.createAnnotation( item ) );
+            }
+            retval = new COSArrayList(actuals, annots);
+        }
+        return retval;
+    }
+    
+    /**
+     * This will set the list of annotations.
+     * 
+     * @param annots The new list of annotations. 
+     */
+    public void setAnnotations( List annots )
+    {
+        page.setItem( COSName.ANNOTS, COSArrayList.converterToCOSArray( annots ) );
+    }
+    
+    /**
+     * @see Printable#print(java.awt.Graphics, java.awt.print.PageFormat, int)
+     */
+    public int print(Graphics graphics, PageFormat pageFormat, int pageIndex)
+        throws PrinterException
+    {
+        int retval = Printable.NO_SUCH_PAGE;
+        if( pageIndex == 0 )
+        {
+            try
+            {
+                retval = Printable.PAGE_EXISTS;
+                PageDrawer drawer = new PageDrawer();
+                PDRectangle pageSize = findMediaBox();
+                Paper paper = new Paper();
+                
+                paper.setImageableArea( 0, 0, pageSize.getWidth(), pageSize.getHeight());
+                pageFormat.setPaper( paper );
+                drawer.drawPage( graphics, this, pageSize.createDimension() );
+                
+            }
+            catch( IOException io )
+            {
+                throw new PrinterIOException( io );
+            }
+            
+        }
+        return retval;
+    }
+    
+    /**
+     * @see Object#equals( Object )
+     */
+    public boolean equals( Object other )
+    {
+        return other instanceof PDPage && ((PDPage)other).getCOSObject() == this.getCOSObject();
+    }
+    
+    /**
+     * @see Object#hashCode()
+     */
+    public int hashCode()
+    {
+        return this.getCOSDictionary().hashCode();
+    }
+}
\ No newline at end of file
-- 
cgit v1.2.3