com.canoo.webtest.steps.request
Class ClickButton

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.request.AbstractTargetAction
                      com.canoo.webtest.steps.request.AbstractIdOrLabelTarget
                          com.canoo.webtest.steps.request.ClickButton

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

public class ClickButton
extends AbstractIdOrLabelTarget

Provides the ability to click on a submit button.

Author:

unknown, Marc Guillemot, Paul King, Denis N. Antonioli

See Also:

Serialized Form

Field Summary

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

ClickButton()

Method Summary

void	addText(String text) Called by Ant to set the text nested between opening and closing tags.
protected com.gargoylesoftware.htmlunit.html.HtmlElement	findClickableElementByAttribute(com.gargoylesoftware.htmlunit.html.HtmlPage page) Finds the button in the page according to the properties set on this step
protected com.gargoylesoftware.htmlunit.Page	findTarget() Fetch the target URL specified byu the step.
String	getFieldIndex()
protected String	getLogMessageForTarget()
String	getName()
String	getX()
String	getY()
protected boolean	isImageButton()
void	setFieldIndex(String index) Sets the index of the button to click (starting with 0) within the buttons identified with the other criteria.
void	setHtmlId(String htmlId)
void	setIndex(int index) Deprecated. use setFieldIndex instead
void	setLabel(String newLabel)
void	setName(String name)
void	setX(String clickPositionX)
void	setXpath(String xpath)
void	setY(String clickPositionY)
protected void	verifyParameters() Called to let the step's implementation validate its parameters.

Methods inherited from class com.canoo.webtest.steps.request.AbstractIdOrLabelTarget

findClickableElement, getHtmlId, getLabel, getXpath

Methods inherited from class com.canoo.webtest.steps.request.AbstractTargetAction

doExecute, getPassword, getResponse, getSave, getUsername, setPassword, setUsername

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

ClickButton

public ClickButton()

Method Detail

setName

public void setName(String name)

getName

public String getName()

setFieldIndex

public void setFieldIndex(String index)

Sets the index of the button to click (starting with 0) within the buttons identified with the other criteria.

Parameters:

index - the new value

getFieldIndex

public String getFieldIndex()

setX

public void setX(String clickPositionX)

getX

public String getX()

setY

public void setY(String clickPositionY)

getY

public String getY()

setIndex

public void setIndex(int index)

Deprecated. use setFieldIndex instead

findClickableElementByAttribute

protected com.gargoylesoftware.htmlunit.html.HtmlElement findClickableElementByAttribute(com.gargoylesoftware.htmlunit.html.HtmlPage page)

Finds the button in the page according to the properties set on this step

Specified by:

findClickableElementByAttribute in class AbstractIdOrLabelTarget

Parameters:

page - the page to search in

Returns:

the button, null if not found

findTarget

protected com.gargoylesoftware.htmlunit.Page findTarget()
                                                 throws javax.xml.xpath.XPathException,
                                                        IOException,
                                                        SAXException

Description copied from class: AbstractTargetAction

Fetch the target URL specified byu the step.

Specified by:

findTarget in class AbstractTargetAction

Returns:

A new Page for the target URL.

Throws:

javax.xml.xpath.XPathException

IOException

SAXException

getLogMessageForTarget

protected String getLogMessageForTarget()

Specified by:

getLogMessageForTarget in class AbstractTargetAction

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 Step

isImageButton

protected boolean isImageButton()

addText

public void addText(String text)

Called by Ant to set the text nested between opening and closing tags.

Parameters:

text - the text to set

setXpath

public void setXpath(String xpath)

Overrides:

setXpath in class AbstractIdOrLabelTarget

Parameters:

xpath - The xpath to set.

setLabel

public void setLabel(String newLabel)

Overrides:

setLabel in class AbstractIdOrLabelTarget

Parameters:

newLabel - The Label to set.

setHtmlId

public void setHtmlId(String htmlId)

Overrides:

setHtmlId in class AbstractIdOrLabelTarget

Parameters:

htmlId - The HtmlId to set.