001: /**
002: * Copyright (c) 2004, www.pdfbox.org
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * 1. Redistributions of source code must retain the above copyright notice,
009: * this list of conditions and the following disclaimer.
010: * 2. Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: * 3. Neither the name of pdfbox; nor the names of its
014: * contributors may be used to endorse or promote products derived from this
015: * software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
018: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
019: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
020: * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
021: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
022: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
023: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
024: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
026: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027: *
028: * http://www.pdfbox.org
029: *
030: */package org.pdfbox.pdmodel.fdf;
031:
032: import java.io.IOException;
033:
034: import org.pdfbox.cos.COSBase;
035: import org.pdfbox.cos.COSDictionary;
036:
037: import org.pdfbox.pdmodel.common.COSObjectable;
038:
039: import org.pdfbox.pdmodel.common.filespecification.PDFileSpecification;
040:
041: /**
042: * This represents an FDF named page reference that is part of the FDF field.
043: *
044: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
045: * @version $Revision: 1.3 $
046: */
047: public class FDFNamedPageReference implements COSObjectable {
048: private COSDictionary ref;
049:
050: /**
051: * Default constructor.
052: */
053: public FDFNamedPageReference() {
054: ref = new COSDictionary();
055: }
056:
057: /**
058: * Constructor.
059: *
060: * @param r The FDF named page reference dictionary.
061: */
062: public FDFNamedPageReference(COSDictionary r) {
063: ref = r;
064: }
065:
066: /**
067: * Convert this standard java object to a COS object.
068: *
069: * @return The cos object that matches this Java object.
070: */
071: public COSBase getCOSObject() {
072: return ref;
073: }
074:
075: /**
076: * Convert this standard java object to a COS object.
077: *
078: * @return The cos object that matches this Java object.
079: */
080: public COSDictionary getCOSDictionary() {
081: return ref;
082: }
083:
084: /**
085: * This will get the name of the referenced page. A required parameter.
086: *
087: * @return The name of the referenced page.
088: */
089: public String getName() {
090: return ref.getString("Name");
091: }
092:
093: /**
094: * This will set the name of the referenced page.
095: *
096: * @param name The referenced page name.
097: */
098: public void setName(String name) {
099: ref.setString("Name", name);
100: }
101:
102: /**
103: * This will get the file specification of this reference. An optional parameter.
104: *
105: * @return The F entry for this dictionary.
106: *
107: * @throws IOException If there is an error creating the file spec.
108: */
109: public PDFileSpecification getFileSpecification()
110: throws IOException {
111: return PDFileSpecification.createFS(ref
112: .getDictionaryObject("F"));
113: }
114:
115: /**
116: * This will set the file specification for this named page reference.
117: *
118: * @param fs The file specification to set.
119: */
120: public void setFileSpecification(PDFileSpecification fs) {
121: ref.setItem("F", fs);
122: }
123: }
|