Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.action

public Class PDFormFieldAdditionalActions

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable
This class represents a form field's dictionary of actions that occur due to events.
Authors
Ben Litchfield, Panagiotis Toumasis

Field Summary

Modifier and TypeField and Description
private final COSDictionary
actions

Constructor Summary

AccessConstructor and Description
public
PDFormFieldAdditionalActions()

Default constructor.

public
PDFormFieldAdditionalActions(COSDictionary
The action dictionary.
a)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public PDAction

Returns:

The C entry of form field's additional actions dictionary.
getC()

This will get a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes.

public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public PDAction

Returns:

The F entry of form field's additional actions dictionary.
getF()

This will get a JavaScript action to be performed before the field is formatted to display its current value.

public PDAction

Returns:

The K entry of form field's additional actions dictionary.
getK()

This will get a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.

public PDAction

Returns:

The V entry of form field's additional actions dictionary.
getV()

This will get a JavaScript action to be performed when the field's value is changed.

public void
setC(PDAction
The action to be performed.
c)

This will set a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes.

public void
setF(PDAction
The action to be performed.
f)

This will set a JavaScript action to be performed before the field is formatted to display its current value.

public void
setK(PDAction
The action to be performed.
k)

This will set a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.

public void
setV(PDAction
The action to be performed.
v)

This will set a JavaScript action to be performed when the field's value is changed.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actionsback to summary
private final COSDictionary actions

Constructor Detail

PDFormFieldAdditionalActionsback to summary
public PDFormFieldAdditionalActions()

Default constructor.

PDFormFieldAdditionalActionsback to summary
public PDFormFieldAdditionalActions(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

The action dictionary.

Method Detail

getCback to summary
public PDAction getC()

This will get a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes. The order in which the document's fields are recalculated is defined by the CO entry in the interactive form dictionary. The name C stands for "calculate".

Returns:PDAction

The C entry of form field's additional actions dictionary.

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getFback to summary
public PDAction getF()

This will get a JavaScript action to be performed before the field is formatted to display its current value. This allows the field's value to be modified before formatting.

Returns:PDAction

The F entry of form field's additional actions dictionary.

getKback to summary
public PDAction getK()

This will get a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This allows the keystroke to be checked for validity and rejected or modified.

Returns:PDAction

The K entry of form field's additional actions dictionary.

getVback to summary
public PDAction getV()

This will get a JavaScript action to be performed when the field's value is changed. This allows the new value to be checked for validity. The name V stands for "validate".

Returns:PDAction

The V entry of form field's additional actions dictionary.

setCback to summary
public void setC(PDAction c)

This will set a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes. The order in which the document's fields are recalculated is defined by the CO entry in the interactive form dictionary. The name C stands for "calculate".

Parameters
c:PDAction

The action to be performed.

setFback to summary
public void setF(PDAction f)

This will set a JavaScript action to be performed before the field is formatted to display its current value. This allows the field's value to be modified before formatting.

Parameters
f:PDAction

The action to be performed.

setKback to summary
public void setK(PDAction k)

This will set a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This allows the keystroke to be checked for validity and rejected or modified.

Parameters
k:PDAction

The action to be performed.

setVback to summary
public void setV(PDAction v)

This will set a JavaScript action to be performed when the field's value is changed. This allows the new value to be checked for validity. The name V stands for "validate".

Parameters
v:PDAction

The action to be performed.