KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > fdf > FDFOptionElement


1 /**
2  * Copyright (c) 2004, www.pdfbox.org
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * 3. Neither the name of pdfbox; nor the names of its
14  * contributors may be used to endorse or promote products derived from this
15  * software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * http://www.pdfbox.org
29  *
30  */
31 package org.pdfbox.pdmodel.fdf;
32
33 import org.pdfbox.cos.COSArray;
34 import org.pdfbox.cos.COSBase;
35 import org.pdfbox.cos.COSString;
36
37 import org.pdfbox.pdmodel.common.COSObjectable;
38
39 /**
40  * This represents an object that can be used in a Field's Opt entry to represent
41  * an available option and a default appearance string.
42  *
43  * @author <a HREF="mailto:ben@benlitchfield.com">Ben Litchfield</a>
44  * @version $Revision: 1.2 $
45  */
46 public class FDFOptionElement implements COSObjectable
47 {
48     private COSArray option;
49
50     /**
51      * Default constructor.
52      */
53     public FDFOptionElement()
54     {
55         option = new COSArray();
56         option.add( new COSString( "" ) );
57         option.add( new COSString( "" ) );
58     }
59
60     /**
61      * Constructor.
62      *
63      * @param o The option element.
64      */
65     public FDFOptionElement( COSArray o )
66     {
67         option = o;
68     }
69
70     /**
71      * Convert this standard java object to a COS object.
72      *
73      * @return The cos object that matches this Java object.
74      */
75     public COSBase getCOSObject()
76     {
77         return option;
78     }
79
80     /**
81      * Convert this standard java object to a COS object.
82      *
83      * @return The cos object that matches this Java object.
84      */
85     public COSArray getCOSArray()
86     {
87         return option;
88     }
89
90     /**
91      * This will get the string of one of the available options. A required element.
92      *
93      * @return An available option.
94      */
95     public String JavaDoc getOption()
96     {
97         return ((COSString)option.getObject( 0 ) ).getString();
98     }
99
100     /**
101      * This will set the string for an available option.
102      *
103      * @param opt One of the available options.
104      */
105     public void setOption( String JavaDoc opt )
106     {
107         option.set( 0, new COSString( opt ) );
108     }
109
110     /**
111      * This will get the string of default appearance string. A required element.
112      *
113      * @return A default appearance string.
114      */
115     public String JavaDoc getDefaultAppearanceString()
116     {
117         return ((COSString)option.getObject( 1 ) ).getString();
118     }
119
120     /**
121      * This will set the default appearance string.
122      *
123      * @param da The default appearance string.
124      */
125     public void setDefaultAppearanceString( String JavaDoc da )
126     {
127         option.set( 1, new COSString( da ) );
128     }
129 }
Popular Tags