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 org.pdfbox.cos.COSArray;
033: import org.pdfbox.cos.COSBase;
034: import org.pdfbox.cos.COSString;
035:
036: import org.pdfbox.pdmodel.common.COSObjectable;
037:
038: /**
039: * This represents an object that can be used in a Field's Opt entry to represent
040: * an available option and a default appearance string.
041: *
042: * @author <a href="mailto:ben@benlitchfield.com">Ben Litchfield</a>
043: * @version $Revision: 1.2 $
044: */
045: public class FDFOptionElement implements COSObjectable {
046: private COSArray option;
047:
048: /**
049: * Default constructor.
050: */
051: public FDFOptionElement() {
052: option = new COSArray();
053: option.add(new COSString(""));
054: option.add(new COSString(""));
055: }
056:
057: /**
058: * Constructor.
059: *
060: * @param o The option element.
061: */
062: public FDFOptionElement(COSArray o) {
063: option = o;
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 option;
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 COSArray getCOSArray() {
081: return option;
082: }
083:
084: /**
085: * This will get the string of one of the available options. A required element.
086: *
087: * @return An available option.
088: */
089: public String getOption() {
090: return ((COSString) option.getObject(0)).getString();
091: }
092:
093: /**
094: * This will set the string for an available option.
095: *
096: * @param opt One of the available options.
097: */
098: public void setOption(String opt) {
099: option.set(0, new COSString(opt));
100: }
101:
102: /**
103: * This will get the string of default appearance string. A required element.
104: *
105: * @return A default appearance string.
106: */
107: public String getDefaultAppearanceString() {
108: return ((COSString) option.getObject(1)).getString();
109: }
110:
111: /**
112: * This will set the default appearance string.
113: *
114: * @param da The default appearance string.
115: */
116: public void setDefaultAppearanceString(String da) {
117: option.set(1, new COSString(da));
118: }
119: }
|