intarsys PDF library API

de.intarsys.pdf.pd
Class PDActionSubmitForm

java.lang.Object
  extended by de.intarsys.pdf.cos.COSBasedObject
      extended by de.intarsys.pdf.pd.PDObject
          extended by de.intarsys.pdf.pd.PDAction
              extended by de.intarsys.pdf.pd.PDActionSubmitForm
All Implemented Interfaces:
ICOSObjectListener, IAttributeSupport

public class PDActionSubmitForm
extends PDAction

The SubmitForm action.

When executed the action submit the documents AcroForm acording to the defined flags.


Nested Class Summary
static class PDActionSubmitForm.MetaClass
          The meta class implementation
 
Field Summary
static COSName CN_ActionType_SubmitForm
           
static COSName DK_F
           
static COSName DK_Fields
           
static COSName DK_Flags
           
static PDActionSubmitForm.MetaClass META
          The meta class instance
 
Fields inherited from class de.intarsys.pdf.pd.PDAction
CN_Type_Action, DK_Next, DK_S
 
Fields inherited from class de.intarsys.pdf.pd.PDObject
DK_Subtype, DK_Type
 
Method Summary
 COSName cosGetExpectedActionType()
          The action type expected for a PDAction of the instantiated class.
static PDActionSubmitForm createNew(URL url)
           
 List getFields()
          A list of field names (plain Java String) to be resetted or null.
 URL getUrl()
           
 boolean isCanonicalFormat()
           
 boolean isEmbedForm()
           
 boolean isExclFKey()
           
 boolean isExclNonUserAnnots()
           
 boolean isExportFormat()
           
 boolean isGetMethod()
           
 boolean isInclude()
           
 boolean isIncludeAnnotations()
           
 boolean isIncludeAppendSaves()
           
 boolean isIncludeNoValueFields()
           
 boolean isNotDEFINED()
           
 boolean isSubmitCoordinates()
           
 boolean isSubmitPDF()
           
 boolean isXFDF()
           
 void setCanonicalFormat(boolean flag)
           
 void setEmbedForm(boolean flag)
           
 void setExclFKey(boolean flag)
           
 void setExclNonUserAnnots(boolean flag)
           
 void setExportFormat(boolean flag)
           
 void setGetMethod(boolean flag)
           
 void setInclude(boolean flag)
           
 void setIncludeAnnotations(boolean flag)
           
 void setIncludeAppendSaves(boolean flag)
           
 void setIncludeNoValueFields(boolean flag)
           
 void setNotDEFINED(boolean flag)
           
 void setSubmitCoordinates(boolean flag)
           
 void setSubmitPDF(boolean flag)
           
 void setUrl(URL url)
           
 void setXFDF(boolean flag)
           
 
Methods inherited from class de.intarsys.pdf.pd.PDAction
addNext, cosGetActionType, getNext, removeNext
 
Methods inherited from class de.intarsys.pdf.pd.PDObject
cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString
 
Methods inherited from class de.intarsys.pdf.cos.COSBasedObject
changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, invalidateCaches, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

META

public static final PDActionSubmitForm.MetaClass META
The meta class instance


CN_ActionType_SubmitForm

public static final COSName CN_ActionType_SubmitForm

DK_F

public static final COSName DK_F

DK_Fields

public static final COSName DK_Fields

DK_Flags

public static final COSName DK_Flags
Method Detail

cosGetExpectedActionType

public COSName cosGetExpectedActionType()
Description copied from class: PDAction
The action type expected for a PDAction of the instantiated class.

Specified by:
cosGetExpectedActionType in class PDAction
Returns:
The action type expected for a PDAction of the instantiated class.

setCanonicalFormat

public void setCanonicalFormat(boolean flag)

isCanonicalFormat

public boolean isCanonicalFormat()

setEmbedForm

public void setEmbedForm(boolean flag)

isEmbedForm

public boolean isEmbedForm()

setExclFKey

public void setExclFKey(boolean flag)

isExclFKey

public boolean isExclFKey()

setExclNonUserAnnots

public void setExclNonUserAnnots(boolean flag)

isExclNonUserAnnots

public boolean isExclNonUserAnnots()

setExportFormat

public void setExportFormat(boolean flag)

isExportFormat

public boolean isExportFormat()

setGetMethod

public void setGetMethod(boolean flag)

isGetMethod

public boolean isGetMethod()

setInclude

public void setInclude(boolean flag)

isInclude

public boolean isInclude()

setIncludeAnnotations

public void setIncludeAnnotations(boolean flag)

isIncludeAnnotations

public boolean isIncludeAnnotations()

setIncludeAppendSaves

public void setIncludeAppendSaves(boolean flag)

isIncludeAppendSaves

public boolean isIncludeAppendSaves()

setIncludeNoValueFields

public void setIncludeNoValueFields(boolean flag)

isIncludeNoValueFields

public boolean isIncludeNoValueFields()

setNotDEFINED

public void setNotDEFINED(boolean flag)

isNotDEFINED

public boolean isNotDEFINED()

setSubmitCoordinates

public void setSubmitCoordinates(boolean flag)

isSubmitCoordinates

public boolean isSubmitCoordinates()

setSubmitPDF

public void setSubmitPDF(boolean flag)

isSubmitPDF

public boolean isSubmitPDF()

setUrl

public void setUrl(URL url)

getUrl

public URL getUrl()

setXFDF

public void setXFDF(boolean flag)

isXFDF

public boolean isXFDF()

createNew

public static PDActionSubmitForm createNew(URL url)

getFields

public List getFields()
A list of field names (plain Java String) to be resetted or null.

Returns:
A list of field names (plain Java String) to be resetted or null.

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.