com.canoo.webtest.steps.form
Class SetSelectField

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

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

public class SetSelectField
extends AbstractSetNamedFieldStep

Selects one or many elements of a select field ( <select name="foo">... </select>)

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

SetSelectField()

Method Summary

protected List	findFields(com.gargoylesoftware.htmlunit.html.HtmlForm form) Finds all relevant fields with the given name in the form.
protected com.gargoylesoftware.htmlunit.html.HtmlForm	findForm() Finds the relevant form.
String	getMultiselect()
String	getOptionIndex()
String	getPassword()
String	getRegex()
String	getSave()
String	getSavePrefix()
String	getSaveResponse()
String	getText()
String	getUserName()
boolean	isMultiSelect() Gets the value of the multiSelect attribute.
boolean	isRegex() Gets the value of the regex attribute.
protected void	maybeTarget(com.gargoylesoftware.htmlunit.Page page, com.gargoylesoftware.htmlunit.html.HtmlSelect select, com.gargoylesoftware.htmlunit.html.HtmlOption option)
protected void	setField(com.gargoylesoftware.htmlunit.html.HtmlElement elt) Sets a field according to the step.
void	setIndex(String index) Deprecated. use setOptionIndex instead
void	setMultiselect(String multiSelect)
void	setOptionIndex(String index)
void	setPassword(String password)
void	setRegex(String regex)
void	setSavePrefix(String prefix)
void	setSaveResponse(String response)
void	setText(String text)
void	setUserName(String userName)
void	setValue(String value) Set the value
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

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

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

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

setSave

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

SetSelectField

public SetSelectField()

Method Detail

isRegex

public boolean isRegex()

Gets the value of the regex attribute. The value is only available after the parameter has been validated.

Returns:

true if getText() is a regular expression

isMultiSelect

public boolean isMultiSelect()

Gets the value of the multiSelect attribute. The value is only available after the parameter has been validated.

Returns:

true if multiple selection is allowed

setMultiselect

public void setMultiselect(String multiSelect)

getMultiselect

public String getMultiselect()

setRegex

public void setRegex(String regex)

getRegex

public String getRegex()

setText

public void setText(String text)

getText

public String getText()

setOptionIndex

public void setOptionIndex(String index)

Parameters:

index - The new index value

getOptionIndex

public String getOptionIndex()

setUserName

public void setUserName(String userName)

Parameters:

userName -

getUserName

public String getUserName()

setPassword

public void setPassword(String password)

Parameters:

password -

getPassword

public String getPassword()

setSavePrefix

public void setSavePrefix(String prefix)

Specified by:

setSavePrefix in interface IBrowserAction

Overrides:

setSavePrefix in class AbstractBrowserAction

getSavePrefix

public String getSavePrefix()

setSaveResponse

public void setSaveResponse(String response)

Specified by:

setSaveResponse in interface IBrowserAction

Overrides:

setSaveResponse in class AbstractBrowserAction

getSaveResponse

public String getSaveResponse()

getSave

public String getSave()

setIndex

public void setIndex(String index)

Deprecated. use setOptionIndex instead

Parameters:

index -

setValue

public void setValue(String value)

Set the value

Overrides:

setValue in class AbstractSetNamedFieldStep

Parameters:

value -

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 relevant fields 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

setField

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

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.

maybeTarget

protected void maybeTarget(com.gargoylesoftware.htmlunit.Page page,
                           com.gargoylesoftware.htmlunit.html.HtmlSelect select,
                           com.gargoylesoftware.htmlunit.html.HtmlOption option)

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