KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > pdfbox > pdmodel > interactive > form > PDChoiceButton


1 /**
2  * Copyright (c) 2003, 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.interactive.form;
32
33 import org.pdfbox.cos.COSArray;
34 import org.pdfbox.cos.COSDictionary;
35 import org.pdfbox.cos.COSName;
36 import org.pdfbox.cos.COSString;
37
38 import org.pdfbox.pdmodel.common.COSArrayList;
39
40 import java.util.ArrayList JavaDoc;
41 import java.util.List JavaDoc;
42
43 /**
44  * This holds common functionality for check boxes and radio buttons.
45  *
46  * @author sug
47  * @version $Revision: 1.4 $
48  */
49 public abstract class PDChoiceButton extends PDField
50 {
51
52     /**
53      * @see PDField#PDField(PDAcroForm,org.pdfbox.cos.COSDictionary)
54      *
55      * @param theAcroForm The acroForm for this field.
56      * @param field The field for this button.
57      */
58     public PDChoiceButton( PDAcroForm theAcroForm, COSDictionary field)
59     {
60         super(theAcroForm, field);
61     }
62
63     /**
64      * This will get the option values "Opt" entry of the pdf button.
65      *
66      * @return A list of java.lang.String values.
67      */
68     public List getOptions()
69     {
70         List retval = null;
71         COSArray array = (COSArray)getDictionary().getDictionaryObject( COSName.getPDFName( "Opt" ) );
72         if( array != null )
73         {
74             List strings = new ArrayList();
75             for( int i=0; i<array.size(); i++ )
76             {
77                 strings.add( ((COSString)array.getObject( i )).getString() );
78             }
79             retval = new COSArrayList( strings, array );
80         }
81         return retval;
82     }
83
84     /**
85      * This will will set the list of options for this button.
86      *
87      * @param options The list of options for the button.
88      */
89     public void setOptions( List options )
90     {
91         getDictionary().setItem(
92             COSName.getPDFName( "Opt" ),
93             COSArrayList.converterToCOSArray( options ) );
94     }
95 }
Popular Tags