com.canoo.webtest.extension
Class StoreElementAttribute

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.canoo.webtest.steps.Step
              com.canoo.webtest.steps.store.BaseStoreStep
                  com.canoo.webtest.extension.StoreElementAttribute

All Implemented Interfaces:

IComputeValue, Serializable, Cloneable

public class StoreElementAttribute
extends BaseStoreStep

StoreElementAttribute

Author:

Paul King

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

StoreElementAttribute()

Method Summary

void	doExecute() Locate all applicable html elements, check their number (size == 1) and store the value of the attribute.
static com.gargoylesoftware.htmlunit.html.HtmlElement	findElement(com.gargoylesoftware.htmlunit.Page currentResp, String id, String xpathStr, org.apache.log4j.Logger log, Step step) Search for the element by id or xpath.
String	getAttributeName()
String	getHtmlId()
String	getXpath()
void	setAttributeName(String name) Sets the name of the attribute of interest.
void	setHtmlId(String str) Sets the id attribute of the element of interest.
void	setPropertyName(String name) Deprecated. since 03.2007. Use BaseStoreStep.setProperty(String)
void	setXpath(String path) Sets the XPath used to identify the element of interest.
protected void	verifyParameters() Verifies the parameters.

Methods inherited from class com.canoo.webtest.steps.store.BaseStoreStep

getComputedValue, getProperty, getPropertyType, isPerformingAction, setProperty, setPropertyType, storeProperty, storeProperty

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, 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

Constructor Detail

StoreElementAttribute

public StoreElementAttribute()

Method Detail

doExecute

public void doExecute()
               throws Exception

Locate all applicable html elements, check their number (size == 1) and store the value of the attribute.

Specified by:

doExecute in class Step

Throws:

StepFailedException - if no applicable button was found

Exception

findElement

public static com.gargoylesoftware.htmlunit.html.HtmlElement findElement(com.gargoylesoftware.htmlunit.Page currentResp,
                                                                         String id,
                                                                         String xpathStr,
                                                                         org.apache.log4j.Logger log,
                                                                         Step step)
                                                                  throws StepFailedException

Search for the element by id or xpath.

Parameters:

currentResp - the html page in which to search

id -

xpathStr -

log -

step -

Returns:

the element

Throws:

StepFailedException - if no element is found

setHtmlId

public void setHtmlId(String str)

Sets the id attribute of the element of interest.

Parameters:

str - the new value

getHtmlId

public String getHtmlId()

setXpath

public void setXpath(String path)

Sets the XPath used to identify the element of interest.

Parameters:

path - the new value

getXpath

public String getXpath()

setAttributeName

public void setAttributeName(String name)

Sets the name of the attribute of interest.

Parameters:

name - Sets the name of the attribute.

getAttributeName

public String getAttributeName()

setPropertyName

public void setPropertyName(String name)

Deprecated. since 03.2007. Use BaseStoreStep.setProperty(String)

Sets the Name of the Property.

Parameters:

name - The Property Name

verifyParameters

protected void verifyParameters()

Verifies the parameters.

Overrides:

verifyParameters in class Step