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.pagenavigation;
031:
032: import org.pdfbox.cos.COSBase;
033: import org.pdfbox.cos.COSDictionary;
034:
035: import org.pdfbox.pdmodel.PDDocumentInformation;
036: import org.pdfbox.pdmodel.common.COSObjectable;
037:
038: /**
039: * This a single thread in a PDF document.
040: *
041: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
042: * @version $Revision: 1.2 $
043: */
044: public class PDThread implements COSObjectable {
045:
046: private COSDictionary thread;
047:
048: /**
049: * Constructor that is used for a preexisting dictionary.
050: *
051: * @param t The underlying dictionary.
052: */
053: public PDThread(COSDictionary t) {
054: thread = t;
055: }
056:
057: /**
058: * Default constructor.
059: *
060: */
061: public PDThread() {
062: thread = new COSDictionary();
063: thread.setName("Type", "Thread");
064: }
065:
066: /**
067: * This will get the underlying dictionary that this object wraps.
068: *
069: * @return The underlying info dictionary.
070: */
071: public COSDictionary getDictionary() {
072: return thread;
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 COSBase getCOSObject() {
081: return thread;
082: }
083:
084: /**
085: * Get info about the thread, or null if there is nothing.
086: *
087: * @return The thread information.
088: */
089: public PDDocumentInformation getThreadInfo() {
090: PDDocumentInformation retval = null;
091: COSDictionary info = (COSDictionary) thread
092: .getDictionaryObject("I");
093: if (info != null) {
094: retval = new PDDocumentInformation(info);
095: }
096:
097: return retval;
098: }
099:
100: /**
101: * Set the thread info, can be null.
102: *
103: * @param info The info dictionary about this thread.
104: */
105: public void setThreadInfo(PDDocumentInformation info) {
106: thread.setItem("I", info);
107: }
108:
109: /**
110: * Get the first bead in the thread, or null if it has not been set yet. This
111: * is a required field for this object.
112: *
113: * @return The first bead in the thread.
114: */
115: public PDThreadBead getFirstBead() {
116: PDThreadBead retval = null;
117: COSDictionary bead = (COSDictionary) thread
118: .getDictionaryObject("F");
119: if (bead != null) {
120: retval = new PDThreadBead(bead);
121: }
122:
123: return retval;
124: }
125:
126: /**
127: * This will set the first bead in the thread. When this is set it will
128: * also set the thread property of the bead object.
129: *
130: * @param bead The first bead in the thread.
131: */
132: public void setFirstBead(PDThreadBead bead) {
133: if (bead != null) {
134: bead.setThread(this );
135: }
136: thread.setItem("F", bead);
137: }
138:
139: }
|