Foxit PDF SDK
com.foxit.sdk.pdf.actions.ResetFormAction Class Reference
Inheritance diagram for com.foxit.sdk.pdf.actions.ResetFormAction:
com.foxit.sdk.pdf.actions.Action com.foxit.sdk.common.Base

Public Member Functions

 ResetFormAction (Action action)
 Constructor, with parent class object.
More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
WStringArray getFieldNames () throws com.foxit.sdk.PDFException
 Get all field names from the array of current reset form action.
More...
 
int getFlags () throws com.foxit.sdk.PDFException
 Get the flag value used for resetting.
More...
 
void setFieldNames (WStringArray field_names) throws com.foxit.sdk.PDFException
 Set field name array.
More...
 
void setFlags (int flags) throws com.foxit.sdk.PDFException
 Set the flag value used for resetting.
More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.actions.Action
 Action (Action action)
 Constructor, with another action object.
More...
 
 Action (PDFDoc document, PDFDictionary action_dict)
 Constructor, with parameters.
More...
 
PDFDictionary getDict () throws com.foxit.sdk.PDFException
 Get PDF dictionary of current object.
More...
 
PDFDoc getDocument () throws com.foxit.sdk.PDFException
 Get the PDF document, to which current action belongs.
More...
 
Action getSubAction (int index) throws com.foxit.sdk.PDFException
 Get a sub-action by index.
More...
 
int getSubActionCount () throws com.foxit.sdk.PDFException
 Get the count of sub-actions.
More...
 
int getType () throws com.foxit.sdk.PDFException
 Get action type.
More...
 
void insertSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
 Insert a new sub-action to the location specified by index.
More...
 
boolean isEmpty ()
 Check whether current object is empty or not.
More...
 
void removeAllSubActions () throws com.foxit.sdk.PDFException
 Remove all the sub-actions.
More...
 
void removeSubAction (int index) throws com.foxit.sdk.PDFException
 Remove a sub-action, specified by index.
More...
 
void setSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
 Set a sub-action by index.
More...
 

Additional Inherited Members

- Static Public Member Functions inherited from com.foxit.sdk.pdf.actions.Action
static Action create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
 Create a new action, for specified action type.
More...
 
- Static Public Attributes inherited from com.foxit.sdk.pdf.actions.Action
static final int e_NewWindowFlagFalse = 0
 "NewWindow" flag is false.

 
static final int e_NewWindowFlagNone = 2
 No "NewWindow" flag.

 
static final int e_NewWindowFlagTrue = 1
 "NewWindow" flag is true.

 
static final int e_TypeGoto = 1
 Action type: go-to action.

 
static final int e_TypeGoTo3DView = 18
 Action type: go-to-3D-view action.

 
static final int e_TypeGoToE = 3
 Action type: embedded go-to action.

 
static final int e_TypeGoToR = 2
 Action type: remote go-to action.

 
static final int e_TypeHide = 9
 Action type: hide action.

 
static final int e_TypeImportData = 13
 Action type: import-data action.

 
static final int e_TypeJavaScript = 14
 Action type: JavaScript action.

 
static final int e_TypeLaunch = 4
 Action type: launch action.

 
static final int e_TypeMovie = 8
 Action type: movie action.

 
static final int e_TypeNamed = 10
 Action type: named action.

 
static final int e_TypeRendition = 16
 Action type: rendition action.

 
static final int e_TypeResetForm = 12
 Action type: reset-form action.

 
static final int e_TypeSetOCGState = 15
 Action type: set-OCG-state action.

 
static final int e_TypeSound = 7
 Action type: sound action.

 
static final int e_TypeSubmitForm = 11
 Action type: submit-form action.

 
static final int e_TypeThread = 5
 Action type: thread action.

 
static final int e_TypeTrans = 17
 Action type: transition action.

 
static final int e_TypeUnknown = 0
 Action type: unknown action.

 
static final int e_TypeURI = 6
 Action type: uniform resource identifier (URI) action.

 

Detailed Description

Reset-form action is to set fields to their default values Class com.foxit.sdk.pdf.actions.ResetFormAction is derived from Action and offers functions to get/set reset-form action data.

See also
Action

Constructor & Destructor Documentation

◆ ResetFormAction()

com.foxit.sdk.pdf.actions.ResetFormAction.ResetFormAction ( Action  action)

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.actions.ResetFormAction.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

Reimplemented from com.foxit.sdk.pdf.actions.Action.

◆ getFieldNames()

WStringArray com.foxit.sdk.pdf.actions.ResetFormAction.getFieldNames ( ) throws com.foxit.sdk.PDFException

Get all field names from the array of current reset form action.

A reset form action can have an array identifying which fields to reset or to exclude from resetting, depending on the flag value.

Returns
An array of field names.

◆ getFlags()

int com.foxit.sdk.pdf.actions.ResetFormAction.getFlags ( ) throws com.foxit.sdk.PDFException

Get the flag value used for resetting.

Returns
Flag value. Currently, the value would be :
  • 0: means to reset fields defined in the array.
  • 1: means to reset all fields except those defined in the array.

◆ setFieldNames()

void com.foxit.sdk.pdf.actions.ResetFormAction.setFieldNames ( WStringArray  field_names) throws com.foxit.sdk.PDFException

Set field name array.

A reset form action can have an array identifying which fields to reset or to exclude from resetting, depending on the flag value.

Parameters
[in]field_namesAn array of form fields' names, to identify which fields to reset or to exclude from resetting. Field name can be retrieved by function interform.Field.getName .
Returns
None.

◆ setFlags()

void com.foxit.sdk.pdf.actions.ResetFormAction.setFlags ( int  flags) throws com.foxit.sdk.PDFException

Set the flag value used for resetting.

Parameters
[in]flagsFlag value. Currently, valid values are:
  • 0: means to reset fields defined in the array.
  • 1: means to reset all fields except those defined in the array.

Returns
None.