com.screenscraper.action

Class FormNavigationAction

java.lang.Object

com.screenscraper.action.NavigationAction

com.screenscraper.action.FormNavigationAction

All Implemented Interfaces:

java.lang.Comparable

public class FormNavigationAction
extends NavigationAction

Used to handle submitting forms.

Field Summary

Fields

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

Fields inherited from class com.screenscraper.action.NavigationAction

CLICK_NAVIGATION_ACTION, FORM_NAVIGATION_ACTION, LIST_SELECTION_NAVIGATION_ACTION, TEXT_ENTRY_NAVIGATION_ACTION

Constructor Summary

Constructors

Constructor and Description
FormNavigationAction() Default constructor.
FormNavigationAction(FormNavigationAction formNavigationAction) Creates a new FormNavigationAction based on an existing one.
FormNavigationAction(int navigationActionID, ScrapeableFile scrapeableFile, java.lang.String name, ScrapeableFile targetScrapeableFile, java.lang.String criteria, java.lang.String formParametersToSet, boolean invokedFromScript, int sequence) Initializes the action fully.
FormNavigationAction(ScrapeableFile scrapeableFile) Initializes an empty instance for the given scrapeable file.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAttributes() Returns a list of possible attributes for this action
protected NavigationActionDoer	getNavigationActionDoerForHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement) Gets a NavigationActionDoer based on a HtmlElement.
int	getNavigationActionType() Gets the numeric constant that represents the type of the action.

Methods inherited from class com.screenscraper.action.NavigationAction

addFormParameterToSet, compareTo, delete, dumpToLog, getCriteria, getFormParametersToSet, getFormParametersToSetAsSet, getFormParametersToSetAsSingleValue, getFormParameterToSet, getHtmlElementIdentifier, getHtmlElementIdentifierAttribute, getHtmlElementIdentifierValidSeqencesStringValue, getHtmlElementIdentifierValidSequences, getHtmlElementIdentifierValue, getID, getInvokedFromScript, getName, getNavigationActionDoers, getNumFormParametersToSet, getScrapeableFile, getSequence, getTargetScrapeableFile, getTargetScrapeableFileName, getView, removeFormParameterToSet, save, setCriteria, setFormParametersToSet, setFormParametersToSetAsSingleValue, setFormParameterToSetName, setFormParameterToSetValue, setHtmlElementIdentifier, setHtmlElementIdentifier, setHtmlElementIdentifierAttribute, setHtmlElementIdentifierValidSequences, setHtmlElementIdentifierValue, setID, setInvokedFromScript, setName, setScrapeableFile, setSequence, setTargetScrapeableFile, setTargetScrapeableFileName, setView

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

FormNavigationAction

public FormNavigationAction()

Default constructor.

FormNavigationAction

public FormNavigationAction(ScrapeableFile scrapeableFile)

Initializes an empty instance for the given scrapeable file.

Parameters:

scrapeableFile - The scrapeable file containing the action.

FormNavigationAction

public FormNavigationAction(int navigationActionID,
                            ScrapeableFile scrapeableFile,
                            java.lang.String name,
                            ScrapeableFile targetScrapeableFile,
                            java.lang.String criteria,
                            java.lang.String formParametersToSet,
                            boolean invokedFromScript,
                            int sequence)

Initializes the action fully.

Parameters:

navigationActionID - The database ID.

scrapeableFile - The scrapeable file containing the action.

name - An identifier for the action.

targetScrapeableFile - The scrapeable file targeted by this action.

criteria - Used to determine which forms this action should apply to.

formParametersToSet - A URL-type list of parameters that should be set in the form before it gets submitted.

invokedFromScript - Whether or not the action is to be invoked from a script.

sequence - The sequence of the action.

FormNavigationAction

public FormNavigationAction(FormNavigationAction formNavigationAction)

Creates a new FormNavigationAction based on an existing one.

Parameters:

formNavigationAction - A FormNavigationAction.

Method Detail

getAttributes

public java.lang.String[] getAttributes()

Description copied from class: NavigationAction

Returns a list of possible attributes for this action

Specified by:

getAttributes in class NavigationAction

Returns:

the attributes

getNavigationActionDoerForHtmlElement

protected NavigationActionDoer getNavigationActionDoerForHtmlElement(com.gargoylesoftware.htmlunit.html.HtmlElement htmlElement)

Gets a NavigationActionDoer based on a HtmlElement.

Specified by:

getNavigationActionDoerForHtmlElement in class NavigationAction

Parameters:

htmlElement - The HtmlElement.

Returns:

A NavigationActionDoer.

getNavigationActionType

public int getNavigationActionType()

Gets the numeric constant that represents the type of the action.

Specified by:

getNavigationActionType in class NavigationAction

Returns:

One of the constants defined in this class.