com.canoo.webtest.steps.form
Class SetCheckbox

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.SetCheckbox

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

public class SetCheckbox
extends AbstractSetNamedFieldStep

Provides the ability to check / uncheck HTML checkboxes.

Author:

Marc Guillemot

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

SetCheckbox()

Method Summary

protected com.gargoylesoftware.htmlunit.html.HtmlForm	findForm() Finds the relevant form.
String	getChecked() Gets the value of the argument setChecked(String).
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.
void	setChecked(String checked)
protected void	setField(com.gargoylesoftware.htmlunit.html.HtmlElement field) Updates a field.
void	setValue(String value) Set the value.

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

addText, getValue, isValueNull

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

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

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

SetCheckbox

public SetCheckbox()

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.

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.

setValue

public void setValue(String value)

Set the value.

Overrides:

setValue in class AbstractSetNamedFieldStep

Parameters:

value -

setField

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

Updates a field.

Specified by:

setField in class AbstractSetFieldStep

Parameters:

field - The field to update

Throws:

IOException

getChecked

public String getChecked()

Gets the value of the argument setChecked(String).

Returns:

The value as set by the user.

setChecked

public void setChecked(String checked)