com.qoppa.pdf.actions

Class SubmitFormAction

java.lang.Object

com.qoppa.pdf.actions.Action

com.qoppa.pdf.actions.SubmitFormAction

public class SubmitFormAction
extends Action

Action that submits a form.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_TYPE_DESCRIPTION

Fields inherited from class com.qoppa.pdf.actions.Action

OPEN_EXISTING_WINDOW, OPEN_NEW_WINDOW, OPEN_USER_PREFERENCE

Constructor Summary

Constructors

Constructor and Description
SubmitFormAction(String submitMalformedURL, int flags) Constructs the action with a destination for the form and flags controlling the action.
SubmitFormAction(URL submitURL, int flags) Constructs the action with a destination for the form and flags controlling the action.
SubmitFormAction(URL submitURL, int flags, boolean submitXML) Constructs the action with a destination for the form and flags controlling the action.

Method Summary

Modifier and Type	Method and Description
String	getActionType() Returns the type of action.
String	getActionTypeDesc() Returns the action type description
List<String>	getFields() Returns the List of field names that are associated with this submit action.
int	getFlags() Returns the flags representing the details of the action.
URL	getSubmitURL() Returns the destination of the action.
String	getSubmitURLString() Return a string representing the attempted destination of the action.
boolean	isSubmitAsXML() Return whether this SubmitFormAction is supposed to submit the fields in XML format.
void	setFields(List<String> fields) Sets the List of field names associated with the action.
String	toString() Returns the description of the action.

Methods inherited from class com.qoppa.pdf.actions.Action

getNextAction, setNextAction

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACTION_TYPE_DESCRIPTION

public static String ACTION_TYPE_DESCRIPTION

Constructor Detail

SubmitFormAction

public SubmitFormAction(URL submitURL,
                        int flags)

Constructs the action with a destination for the form and flags controlling the action.

Parameters:

submitURL - The destination for submitting forms.

flags - Flags determining details of the action.

SubmitFormAction

public SubmitFormAction(URL submitURL,
                        int flags,
                        boolean submitXML)

Constructs the action with a destination for the form and flags controlling the action.

Parameters:

submitURL - The destination for submitting forms.

flags - Flags determining details of the action.

submitXML - A boolean for the submit type being XML which isn't supported by the flags

SubmitFormAction

public SubmitFormAction(String submitMalformedURL,
                        int flags)

Constructs the action with a destination for the form and flags controlling the action. This should only used when the string can not be used to make a valid URL. This submit action will not be able to function until it is updated with a valid URL.

Parameters:

submitMalformedURL - The destination for submitting forms.

flags - Flags determining details of the action.

Method Detail

getActionType

public String getActionType()

Description copied from class: Action

Returns the type of action.

Specified by:

getActionType in class Action

Returns:

The action type.

getActionTypeDesc

public String getActionTypeDesc()

Description copied from class: Action

Returns the action type description

Specified by:

getActionTypeDesc in class Action

getSubmitURL

public URL getSubmitURL()

Returns the destination of the action.

Returns:

The destination for submitting a form.

getFlags

public int getFlags()

Returns the flags representing the details of the action.

Returns:

represents the details of the action

getFields

public List<String> getFields()

Returns the List of field names that are associated with this submit action. Depending on the flags, these can be the fields that are or aren't being sent.

Returns:

the fields associated with the action.

setFields

public void setFields(List<String> fields)

Sets the List of field names associated with the action.

Parameters:

fields - associated with the submit action.

toString

public String toString()

Returns the description of the action.

Overrides:

toString in class Object

isSubmitAsXML

public boolean isSubmitAsXML()

Return whether this SubmitFormAction is supposed to submit the fields in XML format.

Returns:

boolean determining if this SubmitFormAction is supposed to submit the fields in XML format.

getSubmitURLString

public String getSubmitURLString()

Return a string representing the attempted destination of the action. This is null unless a URL could not be formed from the string.

Returns:

String The destination for submitting forms.