[cubeextranet.git] /

/*\r
 * Licensed to the Apache Software Foundation (ASF) under one or more\r
 * contributor license agreements.  See the NOTICE file distributed with\r
 * this work for additional information regarding copyright ownership.\r
 * The ASF licenses this file to You under the Apache License, Version 2.0\r
 * (the "License"); you may not use this file except in compliance with\r
 * the License.  You may obtain a copy of the License at\r
 *\r
 *      http://www.apache.org/licenses/LICENSE-2.0\r
 *\r
 * Unless required by applicable law or agreed to in writing, software\r
 * distributed under the License is distributed on an "AS IS" BASIS,\r
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 * See the License for the specific language governing permissions and\r
 * limitations under the License.\r
 */\r
package org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination;\r
\r
import java.util.ArrayList;\r
import java.util.List;\r
\r
import org.apache.pdfbox.cos.COSArray;\r
import org.apache.pdfbox.cos.COSBase;\r
import org.apache.pdfbox.cos.COSDictionary;\r
import org.apache.pdfbox.cos.COSNumber;\r
\r
import org.apache.pdfbox.pdmodel.PDPage;\r
import org.apache.pdfbox.pdmodel.PDPageNode;\r
\r
/**\r
 * This represents a destination to a page, see subclasses for specific parameters.\r
 *\r
 * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>\r
 * @version $Revision: 1.2 $\r
 */\r
public abstract class PDPageDestination extends PDDestination\r
{\r
    /**\r
     * Storage for the page destination.\r
     */\r
    protected COSArray array;\r
\r
    /**\r
     * Constructor to create empty page destination.\r
     *\r
     */\r
    protected PDPageDestination()\r
    {\r
        array = new COSArray();\r
    }\r
\r
    /**\r
     * Constructor to create empty page destination.\r
     *\r
     * @param arr A page destination array.\r
     */\r
    protected PDPageDestination( COSArray arr )\r
    {\r
        array = arr;\r
    }\r
\r
    /**\r
     * This will get the page for this destination.  A page destination\r
     * can either reference a page or a page number(when doing a remote destination to\r
     * another PDF).  If this object is referencing by page number then this method will\r
     * return null and getPageNumber should be used.\r
     *\r
     * @return The page for this destination.\r
     */\r
    public PDPage getPage()\r
    {\r
        PDPage retval = null;\r
        if( array.size() > 0 )\r
        {\r
            COSBase page = array.getObject( 0 );\r
            if( page instanceof COSDictionary )\r
            {\r
                retval = new PDPage( (COSDictionary)page );\r
            }\r
        }\r
        return retval;\r
    }\r
\r
    /**\r
     * Set the page for this destination.\r
     *\r
     * @param page The page for the destination.\r
     */\r
    public void setPage( PDPage page )\r
    {\r
        array.set( 0, page );\r
    }\r
\r
    /**\r
     * This will get the page number for this destination.  A page destination\r
     * can either reference a page or a page number(when doing a remote destination to\r
     * another PDF).  If this object is referencing by page number then this method will\r
     * return that number, otherwise -1 will be returned.\r
     *\r
     * @return The page number for this destination.\r
     */\r
    public int getPageNumber()\r
    {\r
        int retval = -1;\r
        if( array.size() > 0 )\r
        {\r
            COSBase page = array.getObject( 0 );\r
            if( page instanceof COSNumber )\r
            {\r
                retval = ((COSNumber)page).intValue();\r
            }\r
        }\r
        return retval;\r
    }\r
\r
    /**\r
     * Returns the page number for this destination, regardless of whether\r
     * this is a page number or a reference to a page.\r
     *\r
     * @since Apache PDFBox 1.0.0\r
     * @see PDOutlineItem\r
     * @return page number, or -1 if the destination type is unknown\r
     */\r
    public int findPageNumber() {\r
        int retval = -1;\r
        if( array.size() > 0 )\r
        {\r
            COSBase page = array.getObject( 0 );\r
            if( page instanceof COSNumber )\r
            {\r
                retval = ((COSNumber)page).intValue();\r
            }\r
            else if (page instanceof COSDictionary)\r
            {\r
                COSBase parent = page;\r
                while (((COSDictionary) parent).getDictionaryObject("Parent", "P") != null) {\r
                    parent = ((COSDictionary) parent).getDictionaryObject( "Parent", "P" );\r
                }\r
                // now parent is the pages node\r
                PDPageNode pages = new PDPageNode((COSDictionary) parent);\r
                List<PDPage> allPages = new ArrayList<PDPage>();\r
                pages.getAllKids(allPages);\r
                retval = allPages.indexOf(new PDPage((COSDictionary) page)) + 1;\r
            }\r
        }\r
        return retval;\r
    }\r
\r
    /**\r
     * Set the page number for this destination.\r
     *\r
     * @param pageNumber The page for the destination.\r
     */\r
    public void setPageNumber( int pageNumber )\r
    {\r
        array.set( 0, pageNumber );\r
    }\r
\r
    /**\r
     * Convert this standard java object to a COS object.\r
     *\r
     * @return The cos object that matches this Java object.\r
     */\r
    public COSBase getCOSObject()\r
    {\r
        return array;\r
    }\r
\r
    /**\r
     * Convert this standard java object to a COS object.\r
     *\r
     * @return The cos object that matches this Java object.\r
     */\r
    public COSArray getCOSArray()\r
    {\r
        return array;\r
    }\r
}\r