KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * Copyright (c) 2003-2005, 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 java.io.IOException JavaDoc;
34 import java.util.ArrayList JavaDoc;
35 import java.util.List JavaDoc;
36
37 import org.pdfbox.cos.COSArray;
38 import org.pdfbox.cos.COSDictionary;
39 import org.pdfbox.cos.COSName;
40
41 import org.pdfbox.pdmodel.common.COSArrayList;
42 import org.pdfbox.util.BitFlagHelper;
43
44 /**
45  * A class for handling the PDF field as a Radio Collection.
46  * This class automatically keeps track of the child radio buttons
47  * in the collection.
48  *
49  * @see PDCheckbox
50  * @author sug
51  * @version $Revision: 1.13 $
52  */
53 public class PDRadioCollection extends PDChoiceButton
54 {
55     /**
56      * A Ff flag.
57      */
58     public static final int FLAG_RADIOS_IN_UNISON = 1 << 25;
59     
60     /**
61      * @param theAcroForm The acroForm for this field.
62      * @param field The field that makes up the radio collection.
63      *
64      * {@inheritDoc}
65      */
66     public PDRadioCollection( PDAcroForm theAcroForm, COSDictionary field)
67     {
68         super(theAcroForm,field);
69     }
70     
71     /**
72      * From the PDF Spec <br/>
73      * If set, a group of radio buttons within a radio button field that
74      * use the same value for the on state will turn on and off in unison; that is if
75      * one is checked, they are all checked. If clear, the buttons are mutually exclusive
76      * (the same behavior as HTML radio buttons).
77      *
78      * @param radiosInUnison The new flag for radiosInUnison.
79      */
80     public void setRadiosInUnison(boolean radiosInUnison)
81     {
82         BitFlagHelper.setFlag( getDictionary(), "Ff", FLAG_RADIOS_IN_UNISON, radiosInUnison );
83     }
84
85     /**
86      *
87      * @return true If the flag is set for radios in unison.
88      */
89     public boolean isRadiosInUnison()
90     {
91         return BitFlagHelper.getFlag( getDictionary(), "Ff", FLAG_RADIOS_IN_UNISON );
92     }
93
94     /**
95      * This setValue method iterates the collection of radiobuttons
96      * and checks or unchecks each radiobutton according to the
97      * given value.
98      * If the value is not represented by any of the radiobuttons,
99      * then none will be checked.
100      *
101      * {@inheritDoc}
102      */
103     public void setValue(String JavaDoc value) throws IOException JavaDoc
104     {
105         getDictionary().setString( "V", value );
106         List JavaDoc kids = getKids();
107         for (int i = 0; i < kids.size(); i++)
108         {
109             PDCheckbox btn = (PDCheckbox)kids.get(i);
110             if( btn.getOnValue().equals(value) )
111             {
112                 btn.check();
113             }
114             else
115             {
116                 btn.unCheck();
117             }
118         }
119     }
120     
121     /**
122      * getValue gets the fields value to as a string.
123      *
124      * @return The string value of this field.
125      *
126      * @throws IOException If there is an error getting the value.
127      */
128     public String JavaDoc getValue()throws IOException JavaDoc
129     {
130         String JavaDoc retval = null;
131         List JavaDoc kids = getKids();
132         for (int i = 0; i < kids.size(); i++)
133         {
134             PDCheckbox btn = (PDCheckbox)kids.get(i);
135             if( btn.isChecked() )
136             {
137                 retval = btn.getOnValue();
138             }
139         }
140         if( retval == null )
141         {
142             retval = getDictionary().getNameAsString( "V" );
143         }
144         return retval;
145     }
146
147
148     /**
149      * This will return a list of PDField objects that are part of this radio collection.
150      *
151      * @see PDField#getWidget()
152      * @return A list of PDWidget objects.
153      * @throws IOException if there is an error while creating the children objects.
154      */
155     public List JavaDoc getKids() throws IOException JavaDoc
156     {
157         List JavaDoc retval = null;
158         COSArray kids = (COSArray)getDictionary().getDictionaryObject(COSName.KIDS);
159         if( kids != null )
160         {
161             List JavaDoc kidsList = new ArrayList JavaDoc();
162             for (int i = 0; i < kids.size(); i++)
163             {
164                 kidsList.add( PDFieldFactory.createField( getAcroForm(), (COSDictionary)kids.getObject(i) ) );
165             }
166             retval = new COSArrayList( kidsList, kids );
167         }
168         return retval;
169     }
170 }
Popular Tags