com.screenscraper.action

Class NavigationActionDoer

java.lang.Object

com.screenscraper.action.NavigationActionDoer

Direct Known Subclasses:

ClickNavigationActionDoer, FormNavigationActionDoer, ListSelectionNavigationActionDoer, TextEntryNavigationActionDoer

public abstract class NavigationActionDoer
extends java.lang.Object

A base class for carrying out navigation actions, such as clicking a button or entering text into a text field.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
NavigationActionDoer()

Method Summary

Modifier and Type	Method and Description
abstract com.gargoylesoftware.htmlunit.html.HtmlPage	doAction(ScrapingSessionState scrapingSessionState, boolean enableJavaScript) Causes the navigation action to be carried out, such as clicking a link or submitting a form.
protected java.util.HashSet<FormParameter>	getFormParametersToSet() Gets any form parameters to be set when the action occurs.
com.gargoylesoftware.htmlunit.html.HtmlElement	getHtmlElement() Gets the element to be clicked to submit the form.
java.lang.String	getNavigationActionName() Gets the name of the corresponding navigation action.
void	reset() Cleans up the doer.
protected void	setFormParametersToSet(java.util.HashSet<FormParameter> formParametersToSet) Sets any form parameters to be set when the action occurs.
void	setHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement) Sets the element to be clicked to submit the form.
void	setNavigationActionName(java.lang.String navigationActionName) Sets the name of the corresponding navigation action.

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

NavigationActionDoer

public NavigationActionDoer()

Method Detail

doAction

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

Causes the navigation action to be carried out, such as clicking a link or submitting a form.

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

getHtmlElement

public com.gargoylesoftware.htmlunit.html.HtmlElement getHtmlElement()

Gets the element to be clicked to submit the form.

Returns:

A HtmlElement.

setHtmlElement

public void setHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement)

Sets the element to be clicked to submit the form.

Parameters:

htmlElement - A HtmlElement.

getFormParametersToSet

protected java.util.HashSet<FormParameter> getFormParametersToSet()

Gets any form parameters to be set when the action occurs.

Returns:

A HashSet of FormParameter objects.

setFormParametersToSet

protected void setFormParametersToSet(java.util.HashSet<FormParameter> formParametersToSet)

Sets any form parameters to be set when the action occurs.

Parameters:

formParametersToSet - A HashSet of FormParameter objects.

getNavigationActionName

public java.lang.String getNavigationActionName()

Gets the name of the corresponding navigation action.

Returns:

The name of the action.

setNavigationActionName

public void setNavigationActionName(java.lang.String navigationActionName)

Sets the name of the corresponding navigation action.

Parameters:

navigationActionName - The name of the action.

reset

public void reset()

Cleans up the doer.