com.screenscraper.action

Class FormNavigationActionDoer

java.lang.Object

com.screenscraper.action.NavigationActionDoer

com.screenscraper.action.FormNavigationActionDoer

public class FormNavigationActionDoer
extends NavigationActionDoer

Handles submitting a form.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Constructor Summary

Constructors

Constructor and Description
FormNavigationActionDoer(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement, java.util.HashSet<FormParameter> formParametersToSet) Generates a new one based on a HtmlElement.

Method Summary

Modifier and Type	Method and Description
com.gargoylesoftware.htmlunit.html.HtmlPage	doAction(ScrapingSessionState scrapingSessionState, boolean enableJavaScript) Causes the HTML element to be clicked that will submit the form.
void	prepareFormForSubmission(ScrapingSessionState scrapingSessionState) Prepares the form to be submitted.

Methods inherited from class com.screenscraper.action.NavigationActionDoer

getFormParametersToSet, getHtmlElement, getNavigationActionName, reset, setFormParametersToSet, setHtmlElement, setNavigationActionName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Constructor Detail

FormNavigationActionDoer

public FormNavigationActionDoer(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement,
                                java.util.HashSet<FormParameter> formParametersToSet)

Generates a new one based on a HtmlElement.

Parameters:

htmlElement - The HtmlElement.

formParametersToSet - The parameters to set on the form.

Method Detail

prepareFormForSubmission

public void prepareFormForSubmission(ScrapingSessionState scrapingSessionState)

Prepares the form to be submitted.

Parameters:

scrapingSessionState - A ScrapingSessionState used to resolve variables.

doAction

public com.gargoylesoftware.htmlunit.html.HtmlPage doAction(ScrapingSessionState scrapingSessionState,
                                                            boolean enableJavaScript)
                                                     throws java.io.IOException

Causes the HTML element to be clicked that will submit the form.

Specified by:

doAction in class NavigationActionDoer

Parameters:

scrapingSessionState - A ScrapingSessionState used to resolve variables.

enableJavaScript - Indicates whether or not JavaScript should be processed when the action occurs.

Returns:

The resulting HtmlPage.

Throws:

java.io.IOException