com.canoo.webtest.steps.form
Class SetInputField

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.steps.AbstractBrowserAction
                  com.canoo.webtest.steps.form.AbstractSetFieldStep
                      com.canoo.webtest.steps.form.AbstractSetNamedFieldStep
                          com.canoo.webtest.steps.form.SetInputField

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

public class SetInputField
extends AbstractSetNamedFieldStep

Sets the value of a text field (inputs of type 'text' and 'password' as well as textareas).

Author:

Marc Guillemot, Paul King

See Also:

Serialized Form

Field Summary

Fields inherited from class com.canoo.webtest.steps.form.AbstractSetNamedFieldStep

DEFAULT_VALUE_NULL_MESSAGE

Fields inherited from class com.canoo.webtest.steps.form.AbstractSetFieldStep

MESSAGE_ARGUMENT_MISSING, MESSAGE_ARGUMENT_REDUNDANT

Fields inherited from class com.canoo.webtest.steps.Step

DEFAULT_DESCRIPTION, ELEMENT_ATTRIBUTE_ID, ELEMENT_ATTRIBUTE_NAME, PROPERTY_TYPE_ANT, PROPERTY_TYPE_ANT_STRICT, PROPERTY_TYPE_DEFAULT, PROPERTY_TYPE_DYNAMIC

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

SetInputField()

Method Summary

protected List	findFields(com.gargoylesoftware.htmlunit.html.HtmlForm form) Finds all text and password inputs or textareas with the given name in the form.
protected com.gargoylesoftware.htmlunit.html.HtmlForm	findForm() Finds the relevant form.
protected boolean	keepField(com.gargoylesoftware.htmlunit.html.HtmlElement elt) Called by AbstractSetFieldStep.findFields(com.gargoylesoftware.htmlunit.html.HtmlForm) to filter out elements with the correct name but not matching some other selection criteria.
protected void	setField(com.gargoylesoftware.htmlunit.html.HtmlElement elt) Sets a field according to the step.
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

Methods inherited from class com.canoo.webtest.steps.form.AbstractSetNamedFieldStep

addText, getValue, isValueNull, setValue

Methods inherited from class com.canoo.webtest.steps.form.AbstractSetFieldStep

doExecute, getFieldIndex, getForLabel, getFormName, getHtmlId, getName, getXpath, selectField, setFieldIndex, setForLabel, setFormName, setHtmlId, setName, setXpath, trimFields

Methods inherited from class com.canoo.webtest.steps.AbstractBrowserAction

setSave, setSavePrefix, setSaveResponse

Methods inherited from class com.canoo.webtest.steps.Step

addComputedParameters, clone, emptyParamCheck, execute, getComputedParameters, getContext, getDefaultPropertyType, getDescription, getDuration, getParameterDictionary, getStepLabel, getVerifier, getWebtestProperties, getWebtestProperties, getWebtestProperty, getWebtestProperty, handleException, hasDescription, integerParamCheck, isCompleted, isPerformingAction, isStarted, isSuccessful, notifyCompleted, notifyStarted, notifyStepResultsListeners, notifySuccess, nullParamCheck, nullResponseCheck, optionalIntegerParamCheck, paramCheck, positiveOrZeroParamCheck, setStepid, setWebtestProperty, setWebtestProperty, toString

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.canoo.webtest.interfaces.IBrowserAction

getTaskName

Constructor Detail

SetInputField

public SetInputField()

Method Detail

findForm

protected com.gargoylesoftware.htmlunit.html.HtmlForm findForm()

Description copied from class: AbstractSetFieldStep

Finds the relevant form.

Specified by:

findForm in class AbstractSetFieldStep

Returns:

The found form.

findFields

protected List findFields(com.gargoylesoftware.htmlunit.html.HtmlForm form)

Finds all text and password inputs or textareas with the given name in the form.

Overrides:

findFields in class AbstractSetFieldStep

Parameters:

form - The form to search

Returns:

The list of fields with the given name

keepField

protected boolean keepField(com.gargoylesoftware.htmlunit.html.HtmlElement elt)

Description copied from class: AbstractSetFieldStep

Called by AbstractSetFieldStep.findFields(com.gargoylesoftware.htmlunit.html.HtmlForm) to filter out elements with the correct name but not matching some other selection criteria.

Overrides:

keepField in class AbstractSetFieldStep

Parameters:

elt - One of the elements with the correct name.

Returns:

True if the element is accepted.

setField

protected void setField(com.gargoylesoftware.htmlunit.html.HtmlElement elt)
                 throws IOException

Description copied from class: AbstractSetFieldStep

Sets a field according to the step. It is up to the step's implementation to decide how to set the step.

Specified by:

setField in class AbstractSetFieldStep

Parameters:

elt - The field to set.

Throws:

IOException

verifyParameters

protected void verifyParameters()

Description copied from class: Step

Called to let the step's implementation validate its parameters. The method is called after parameter extensions but before Step.doExecute(). This implementation does nothing, overwrite as needed.

Overrides:

verifyParameters in class AbstractSetFieldStep