org.openpdf.renderer.action.GoToRAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openpdf-renderer Show documentation
PDF renderer implementation supporting the subset of PDF 1.4 specification.
The newest version!
package org.openpdf.renderer.action;

import java.io.IOException;

import org.openpdf.renderer.PDFDestination;
import org.openpdf.renderer.PDFObject;

/*****************************************************************************
 * Action directing to a location within another PDF document 
 *
 * @author  Katja Sondermann
 * @since 07.07.2009
 ****************************************************************************/
public class GoToRAction extends PDFAction {

	/** the destination within the remote PDF file */
    private PDFDestination destination;
    /** the remote file this action refers to*/
    private String file;
    /** Should the remote file be opened in a new window? (optional)*/
    private boolean newWindow=false;
	/** 
     * Creates a new instance of GoToRAction from an object
     * @param obj the PDFObject with the action information
     * @throws IOException - in case the action can not be parsed
     */
    public GoToRAction(PDFObject obj, PDFObject root) throws IOException {
        super("GoToR");
        // find the destination and parse it
        this.destination = PdfObjectParseUtil.parseDestination("D", obj, root, true);
        
        // find the remote file and parse it
        this.file = PdfObjectParseUtil.parseStringFromDict("F", obj, true);
        
        // find the new window attribute and parse it if available
       	this.newWindow = PdfObjectParseUtil.parseBooleanFromDict("NewWindow", obj, false);
    }    

    /*************************************************************************
     * Create a new GoToRAction from the given attributes
     * @param dest
     * @param file
     * @param newWindow
     ************************************************************************/
    public GoToRAction(PDFDestination dest, String file, boolean newWindow){
    	super("GoToR");
    	this.file = file;
    	this.destination = dest;
    	this.newWindow = newWindow;
    }
    
    /*************************************************************************
     * Get the destination this action refers to
     * @return PDFDestination
     ************************************************************************/
	public PDFDestination getDestination() {
		return this.destination;
	}

    /*************************************************************************
     * Get the file this action refers to
     * @return PDFDestination
     ************************************************************************/
	public String getFile() {
		return this.file;
	}

	/*************************************************************************
	 * Should the remote file be opened in a new window?
	 * @return boolean
	 ************************************************************************/
	public boolean isNewWindow() {
		return this.newWindow;
	}
}