/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.pdmodel.interactive.action;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification;
import java.io.IOException;
/**
* This represents a Submit-Form action that can be executed in a PDF document.
*
* @author Evgeniy Muravitskiy
*/
public class PDActionSubmitForm extends PDAction
{
/**
* This type of action this object represents.
*/
public static final String SUB_TYPE = "SubmitForm";
/**
* Default Constructor
*/
public PDActionSubmitForm()
{
setSubType(SUB_TYPE);
}
/**
* Constructor
*
* @param a the action dictionary
*/
public PDActionSubmitForm(COSDictionary a)
{
super(a);
}
/**
* This will get the file in which the destination is located.
*
* @return The F entry of the specific Submit-From action dictionary.
* @throws IOException If there is an error creating the file spec.
*/
public PDFileSpecification getFile() throws IOException
{
return PDFileSpecification.createFS(action.getDictionaryObject(COSName.F));
}
/**
* This will set the file in which the destination is located.
*
* @param fs The file specification.
*/
public void setFile(PDFileSpecification fs)
{
action.setItem(COSName.F, fs);
}
/**
* An array identifying which fields to include in the submission or which to exclude, depending
* on the setting of the Include/Exclude flag in the Flags entry
*
* @return the array of fields
*/
public COSArray getFields()
{
COSBase retval = this.action.getDictionaryObject(COSName.FIELDS);
return retval instanceof COSArray ? (COSArray) retval : null;
}
/**
* @param array the array of fields
*/
public void setFields(COSArray array)
{
this.action.setItem(COSName.FIELDS, array);
}
/**
* A set of flags specifying various characteristics of the action
*
* @return the flags
*/
public int getFlags()
{
return this.action.getInt(COSName.FLAGS, 0);
}
/**
* @param flags the flags
*/
public void setFlags(int flags)
{
this.action.setInt(COSName.FLAGS, flags);
}
}