001: /**
002: * Copyright (c) 2005, 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.interactive.documentnavigation.destination;
031:
032: import java.io.IOException;
033:
034: import org.pdfbox.cos.COSBase;
035: import org.pdfbox.cos.COSName;
036: import org.pdfbox.cos.COSString;
037:
038: /**
039: * This represents a destination to a page by referencing it with a name.
040: *
041: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
042: * @version $Revision: 1.3 $
043: */
044: public class PDNamedDestination extends PDDestination {
045: private COSBase namedDestination;
046:
047: /**
048: * Constructor.
049: *
050: * @param dest The named destination.
051: */
052: public PDNamedDestination(COSString dest) {
053: namedDestination = dest;
054: }
055:
056: /**
057: * Constructor.
058: *
059: * @param dest The named destination.
060: */
061: public PDNamedDestination(COSName dest) {
062: namedDestination = dest;
063: }
064:
065: /**
066: * Default constructor.
067: */
068: public PDNamedDestination() {
069: //default, so do nothing
070: }
071:
072: /**
073: * Default constructor.
074: *
075: * @param dest The named destination.
076: */
077: public PDNamedDestination(String dest) {
078: namedDestination = new COSString(dest);
079: }
080:
081: /**
082: * Convert this standard java object to a COS object.
083: *
084: * @return The cos object that matches this Java object.
085: */
086: public COSBase getCOSObject() {
087: return namedDestination;
088: }
089:
090: /**
091: * This will get the name of the destination.
092: *
093: * @return The name of the destination.
094: */
095: public String getNamedDestination() {
096: String retval = null;
097: if (namedDestination instanceof COSString) {
098: retval = ((COSString) namedDestination).getString();
099: } else if (namedDestination instanceof COSName) {
100: retval = ((COSName) namedDestination).getName();
101: }
102:
103: return retval;
104: }
105:
106: /**
107: * Set the named destination.
108: *
109: * @param dest The new named destination.
110: *
111: * @throws IOException If there is an error setting the named destination.
112: */
113: public void setNamedDestination(String dest) throws IOException {
114: if (namedDestination instanceof COSString) {
115: COSString string = ((COSString) namedDestination);
116: string.reset();
117: string.append(dest.getBytes());
118: } else if (dest == null) {
119: namedDestination = null;
120: } else {
121: namedDestination = new COSString(dest);
122: }
123: }
124:
125: }
|