KickJava   Java API By Example, From Geeks To Geeks.

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


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.COSDictionary;
34 import org.pdfbox.cos.COSName;
35 import org.pdfbox.cos.COSString;
36
37 import java.io.IOException JavaDoc;
38
39 /**
40  * A class for handling the PDF field as a PDPushButton.
41  *
42  * @author sug
43  * @version $Revision: 1.3 $
44  */
45 public class PDPushButton extends PDField
46 {
47
48     /**
49      * @see org.pdfbox.pdmodel.field.PDField#COSField(org.pdfbox.cos.COSDictionary)
50      *
51      * @param theAcroForm The acroForm for this field.
52      * @param field The field for this push button.
53      */
54     public PDPushButton( PDAcroForm theAcroForm, COSDictionary field)
55     {
56         super(theAcroForm, field);
57     }
58
59     /**
60      * @see as.interactive.pdf.form.cos.COSField#setValue(java.lang.String)
61      *
62      * @param value The new value for the field.
63      *
64      * @throws IOException If there is an error creating the appearance stream.
65      */
66     public void setValue(String JavaDoc value) throws IOException JavaDoc
67     {
68         COSString fieldValue = new COSString(value);
69         getDictionary().setItem( COSName.getPDFName( "V" ), fieldValue );
70         getDictionary().setItem( COSName.getPDFName( "DV" ), fieldValue );
71     }
72     
73     /**
74      * getValue gets the fields value to as a string.
75      *
76      * @return The string value of this field.
77      *
78      * @throws IOException If there is an error getting the value.
79      */
80     public String JavaDoc getValue() throws IOException JavaDoc
81     {
82         return getDictionary().getString( "V" );
83     }
84 }
Popular Tags