pdfaction.java

java itext java itext java itext

/*
 * $Id: PdfAction.java,v 1.18 2001/12/10 13:53:21 blowagie Exp $
 * $Name:  $
 *
 * Copyright 2001 by Bruno Lowagie.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Library General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or any
 * later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * You should have received a copy of the GNU Library General Public License along
 * with this library; if not, write to the Free Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA 02111-1307 USA.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * http://www.lowagie.com/iText/
 *
 * ir-arch Bruno Lowagie,
 * Adolf Baeyensstraat 121
 * 9040 Sint-Amandsberg
 * BELGIUM
 * tel. [phone]
 * [e-mail]
 *
 */

package com.lowagie.text.pdf;

import java.net.URL;

/**
 * A <CODE>PdfAction</CODE> defines an action that can be triggered from a PDF file.
 *
 * @see		PdfDictionary
 *
 * @author  [e-mail]
 */

public class PdfAction extends PdfDictionary {
    
    // constructors
    
/**
 * Constructs a new <CODE>PdfAction</CODE> of Subtype URI.
 *
 * @param url the Url to go to
 */
    
    public PdfAction(URL url) {
        super(PdfName.ACTION);
        put(PdfName.S, PdfName.URI);
        put(PdfName.URI, new PdfString(url.toExternalForm()));
    }
    
/**
 * Constructs a new <CODE>PdfAction</CODE> of Subtype URI.
 *
 * @param url the url to go to
 */
    
    public PdfAction(String url) {
        super(PdfName.ACTION);
        put(PdfName.S, PdfName.URI);
        put(PdfName.URI, new PdfString(url));
    }
    
/**
 * Constructs a new <CODE>PdfAction</CODE> of Subtype GoTo.
 * @param destination the destination to go to
 */
    
    PdfAction(PdfIndirectReference destination) {
        super(PdfName.ACTION);
        put(PdfName.S, PdfName.GOTO);
        put(PdfName.D, destination);
    }
  
/**
 * Constructs a new <CODE>PdfAction</CODE> of Subtype GoToR.
 * @param filename the file name to go to
 * @param name the named destination to go to
 */
    
    public PdfAction(String filename, String name)
    {
        super(PdfName.ACTION);
        put(PdfName.S, PdfName.GOTOR);
        put(PdfName.F, new PdfString(filename));
        put(PdfName.D, new PdfString(name));
    }
    
/**
 * Constructs a new <CODE>PdfAction</CODE> of Subtype GoToR.
 * @param filename the file name to go to
 * @param page the page destination to go to
 */
    
    public PdfAction(String filename, int page)
    {
        super(PdfName.ACTION);
        put(PdfName.S, PdfName.GOTOR);
        put(PdfName.F, new PdfString(filename));
        put(PdfName.D, new PdfLiteral("[" + (page - 1) + " /FitH 10000]"));
    }
}