1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   package org.apache.pdfbox.pdmodel.interactive.form;
   18   
   19   import org.apache.pdfbox.cos.COSDictionary;
   20   import org.apache.pdfbox.cos.COSName;
   21   import org.apache.pdfbox.cos.COSString;
   22   
   23   import java.io.IOException;
   24   
   25   /**
   26    * A class for handling the PDF field as a PDPushButton.
   27    *
   28    * @author sug
   29    * @version $Revision: 1.3 $
   30    */
   31   public class PDPushButton extends PDField
   32   {
   33   
   34       /**
   35        * @see org.apache.pdfbox.pdmodel.field.PDField#COSField(org.apache.pdfbox.cos.COSDictionary)
   36        *
   37        * @param theAcroForm The acroForm for this field.
   38        * @param field The field for this push button.
   39        */
   40       public PDPushButton( PDAcroForm theAcroForm, COSDictionary field)
   41       {
   42           super(theAcroForm, field);
   43       }
   44   
   45       /**
   46        * @see as.interactive.pdf.form.cos.COSField#setValue(java.lang.String)
   47        *
   48        * @param value The new value for the field.
   49        *
   50        * @throws IOException If there is an error creating the appearance stream.
   51        */
   52       public void setValue(String value) throws IOException
   53       {
   54           COSString fieldValue = new COSString(value);
   55           getDictionary().setItem( COSName.getPDFName( "V" ), fieldValue );
   56           getDictionary().setItem( COSName.getPDFName( "DV" ), fieldValue );
   57       }
   58   
   59       /**
   60        * getValue gets the fields value to as a string.
   61        *
   62        * @return The string value of this field.
   63        *
   64        * @throws IOException If there is an error getting the value.
   65        */
   66       public String getValue() throws IOException
   67       {
   68           return getDictionary().getString( "V" );
   69       }
   70   }