01: /*
02: * $Id: PdfDocumentActions.java 2569 2007-02-06 13:10:39Z blowagie $
03: *
04: * Copyright 2006 Bruno Lowagie
05: *
06: * The contents of this file are subject to the Mozilla Public License Version 1.1
07: * (the "License"); you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
09: *
10: * Software distributed under the License is distributed on an "AS IS" basis,
11: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12: * for the specific language governing rights and limitations under the License.
13: *
14: * The Original Code is 'iText, a free JAVA-PDF library'.
15: *
16: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
17: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
18: * All Rights Reserved.
19: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
20: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
21: *
22: * Contributor(s): all the names of the contributors are added in the source code
23: * where applicable.
24: *
25: * Alternatively, the contents of this file may be used under the terms of the
26: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
27: * provisions of LGPL are applicable instead of those above. If you wish to
28: * allow use of your version of this file only under the terms of the LGPL
29: * License and not to allow others to use your version of this file under
30: * the MPL, indicate your decision by deleting the provisions above and
31: * replace them with the notice and other provisions required by the LGPL.
32: * If you do not delete the provisions above, a recipient may use your version
33: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
34: *
35: * This library is free software; you can redistribute it and/or modify it
36: * under the terms of the MPL as stated above or under the terms of the GNU
37: * Library General Public License as published by the Free Software Foundation;
38: * either version 2 of the License, or any later version.
39: *
40: * This library is distributed in the hope that it will be useful, but WITHOUT
41: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
42: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
43: * details.
44: *
45: * If you didn't download this code from the following link, you should check if
46: * you aren't using an obsolete version:
47: * http://www.lowagie.com/iText/
48: */
49:
50: package com.lowagie.text.pdf.interfaces;
51:
52: import com.lowagie.text.DocumentException;
53: import com.lowagie.text.pdf.PdfAction;
54: import com.lowagie.text.pdf.PdfName;
55:
56: /**
57: * A PDF document can have an open action and other additional actions.
58: */
59:
60: public interface PdfDocumentActions {
61:
62: /**
63: * When the document opens it will jump to the destination with
64: * this name.
65: * @param name the name of the destination to jump to
66: */
67: public void setOpenAction(String name);
68:
69: /**
70: * When the document opens this <CODE>action</CODE> will be
71: * invoked.
72: * @param action the action to be invoked
73: */
74: public void setOpenAction(PdfAction action);
75:
76: /**
77: * Additional-actions defining the actions to be taken in
78: * response to various trigger events affecting the document
79: * as a whole. The actions types allowed are: <CODE>DOCUMENT_CLOSE</CODE>,
80: * <CODE>WILL_SAVE</CODE>, <CODE>DID_SAVE</CODE>, <CODE>WILL_PRINT</CODE>
81: * and <CODE>DID_PRINT</CODE>.
82: *
83: * @param actionType the action type
84: * @param action the action to execute in response to the trigger
85: * @throws DocumentException on invalid action type
86: */
87: public void setAdditionalAction(PdfName actionType, PdfAction action)
88: throws DocumentException;
89:
90: }
|