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.documentinterchange.logicalstructure;
031:
032: import org.pdfbox.cos.COSBase;
033: import org.pdfbox.cos.COSDictionary;
034: import org.pdfbox.pdmodel.common.COSObjectable;
035:
036: /**
037: * The MarkInfo provides additional information relevant to specialized
038: * uses of structured documents.
039: *
040: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
041: * @version $Revision: 1.4 $
042: */
043: public class PDMarkInfo implements COSObjectable {
044: private COSDictionary dictionary;
045:
046: /**
047: * Default Constructor.
048: *
049: */
050: public PDMarkInfo() {
051: dictionary = new COSDictionary();
052: }
053:
054: /**
055: * Constructor for an existing MarkInfo element.
056: *
057: * @param dic The existing dictionary.
058: */
059: public PDMarkInfo(COSDictionary dic) {
060: dictionary = dic;
061: }
062:
063: /**
064: * Convert this standard java object to a COS object.
065: *
066: * @return The cos object that matches this Java object.
067: */
068: public COSBase getCOSObject() {
069: return dictionary;
070: }
071:
072: /**
073: * Convert this standard java object to a COS object.
074: *
075: * @return The cos object that matches this Java object.
076: */
077: public COSDictionary getDictionary() {
078: return dictionary;
079: }
080:
081: /**
082: * Tells if this is a tagged PDF.
083: *
084: * @return true If this is a tagged PDF.
085: */
086: public boolean isMarked() {
087: return dictionary.getBoolean("Marked", false);
088: }
089:
090: /**
091: * Set if this is a tagged PDF.
092: *
093: * @param value The new marked value.
094: */
095: public void setMarked(boolean value) {
096: dictionary.setBoolean("Marked", value);
097: }
098:
099: /**
100: * Tells if structure elements use user properties.
101: *
102: * @return A boolean telling if the structure elements use user properties.
103: */
104: public boolean usesUserProperties() {
105: return dictionary.getBoolean("UserProperties", false);
106: }
107:
108: /**
109: * Set if the structure elements contain user properties.
110: *
111: * @param userProps The new value for this property.
112: */
113: public void setUserProperties(boolean userProps) {
114: dictionary.setBoolean("UserProperties", userProps);
115: }
116:
117: /**
118: * Tells if this PDF contain 'suspect' tags. See PDF Reference 1.6
119: * section 10.6 "Logical Structure" for more information about this property.
120: *
121: * @return true if the suspect flag has been set.
122: */
123: public boolean isSuspect() {
124: return dictionary.getBoolean("Suspects", false);
125: }
126:
127: /**
128: * Set the value of the suspects property. See PDF Reference 1.6
129: * section 10.6 "Logical Structure" for more information about this
130: * property.
131: *
132: * @param suspect The new "Suspects" value.
133: */
134: public void setSuspect(boolean suspect) {
135: dictionary.setBoolean("Suspects", false);
136: }
137: }
|