com.canoo.webtest.steps.request
Class ClickLink

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

All Implemented Interfaces:

IBrowserAction, Serializable, Cloneable

public class ClickLink
extends AbstractIdOrLabelTarget

Clicks a link determined by its id or its label and/or its href.

Author:

Mister Unknown, Marc Guillemot, Matt Raible, 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

ClickLink()

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)
protected com.gargoylesoftware.htmlunit.Page	findTarget() Fetch the target URL specified byu the step.
String	getHref()
protected static com.gargoylesoftware.htmlunit.html.HtmlAnchor	getLinkWithImageText(com.gargoylesoftware.htmlunit.html.HtmlPage htmlPage, String text) Returns the first link which contains an image with the specified text as its 'alt' attribute.
protected String	getLogMessageForTarget()
protected boolean	isMatching(com.gargoylesoftware.htmlunit.html.HtmlAnchor link)
protected com.gargoylesoftware.htmlunit.html.HtmlAnchor	locateTextLink(com.gargoylesoftware.htmlunit.html.HtmlPage currentResponse)
protected com.gargoylesoftware.htmlunit.html.HtmlAnchor	locateWebLink(com.gargoylesoftware.htmlunit.html.HtmlPage page) Deprecated. Use AbstractIdOrLabelTarget.findClickableElement(com.gargoylesoftware.htmlunit.html.HtmlPage) .
void	setHref(String href)
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, setHtmlId, setLabel, setXpath

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

ClickLink

public ClickLink()

Method Detail

getHref

public String getHref()

setHref

public void setHref(String href)

findTarget

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

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

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

locateWebLink

protected com.gargoylesoftware.htmlunit.html.HtmlAnchor locateWebLink(com.gargoylesoftware.htmlunit.html.HtmlPage page)
                                                               throws javax.xml.xpath.XPathException

Deprecated. Use AbstractIdOrLabelTarget.findClickableElement(com.gargoylesoftware.htmlunit.html.HtmlPage) .

get the link corresponding to the indications defined in the class

Parameters:

page -

Returns:

null if no link found

Throws:

javax.xml.xpath.XPathException

findClickableElementByAttribute

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

Specified by:

findClickableElementByAttribute in class AbstractIdOrLabelTarget

getLinkWithImageText

protected static com.gargoylesoftware.htmlunit.html.HtmlAnchor getLinkWithImageText(com.gargoylesoftware.htmlunit.html.HtmlPage htmlPage,
                                                                                    String text)

Returns the first link which contains an image with the specified text as its 'alt' attribute.

Parameters:

htmlPage -

text -

Returns:

null if none found

locateTextLink

protected com.gargoylesoftware.htmlunit.html.HtmlAnchor locateTextLink(com.gargoylesoftware.htmlunit.html.HtmlPage currentResponse)

Returns:

null if not found

isMatching

protected boolean isMatching(com.gargoylesoftware.htmlunit.html.HtmlAnchor link)

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