Package com.meterware.httpunit
Class Button
java.lang.Object
com.meterware.httpunit.FormControl
com.meterware.httpunit.Button
- All Implemented Interfaces:
HTMLElement
,ScriptingEventHandler
- Direct Known Subclasses:
ResetButton
,SubmitButton
A button in a form.
- Author:
- Russell Gold
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final HTMLElementPredicate
static final HTMLElementPredicate
Fields inherited from class com.meterware.httpunit.FormControl
BUTTON_TYPE, CHECKBOX_TYPE, FILE_TYPE, HIDDEN_TYPE, IMAGE_BUTTON_TYPE, MULTIPLE_TYPE, PASSWORD_TYPE, RADIO_BUTTON_TYPE, RESET_BUTTON_TYPE, SINGLE_TYPE, SUBMIT_BUTTON_TYPE, TEXT_TYPE, TEXTAREA_TYPE, UNDEFINED_TYPE
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
click()
Performs the action associated with clicking this button after running any 'onClick' script.protected void
Perform the normal action of this button.protected void
doButtonAction
(int x, int y) Perform the normal action of this button.boolean
Deprecated.since 1.7 - use doEventScript insteadboolean
doEventScript
(String eventScript) optional do the event if it's definedprotected boolean
doOnClickSequence
(int x, int y) the onClickSequence for this buttongetAttribute
(String name) get the Attribute with the given name - by delegating to NodeUtilsprotected String
getAttribute
(String name, String defaultValue) Returns the class associated with this element.getID()
Returns the ID associated with this element.getName()
Returns the name associated with this element.getNode()
Returns the DOM node underlying this element.Returns the scriptable delegate which can provide the scriptable delegate for this element.Returns a scriptable object which can act as a proxy for this control.Returns the tag name of this node.getText()
Returns the text value of this block.getTitle()
Returns the title associated with this element.getType()
Return the type of the control, as seen from JavaScript.getValue()
Returns the value associated with this button.protected String[]
Returns the current value(s) associated with this control.boolean
handleEvent
(String eventName) handle the event with the given name by getting the attribute and then executing the eventScript for itboolean
Returns true if this button is disabled, meaning that it cannot be clicked.boolean
isSupportedAttribute
(String name) Returns true if this element may have an attribute with the specified name.Creates and returns a scriptable object for this control.void
remember wether the button was enabledvoid
removeAttribute
(String name) remove the Attribute with the given name - by delegating to NodeUtilsvoid
setAttribute
(String name, Object value) set the Attribute with the given name - by delegating to NodeUtilsprotected void
supportAttribute
(String name) void
throw an exception that I'm disbledprotected void
verifyButtonEnabledMethods inherited from class com.meterware.httpunit.FormControl
claimUniqueValue, claimValueIsRequired, doOnChangeEvent, doOnClickEvent, doOnMouseDownEvent, doOnMouseUpEvent, emptyIfNull, getDisplayedOptions, getForm, getOptionValues, getValueAttribute, isHidden, isMultiValued, isReadOnly, reset, sendOnChangeEvent, sendOnClickEvent, sendOnMouseDownEvent, sendOnMouseUpEvent, setState, setValueAttribute, toggle
-
Field Details
-
WITH_ID
-
WITH_LABEL
-
-
Method Details
-
getType
Description copied from class:FormControl
Return the type of the control, as seen from JavaScript.- Specified by:
getType
in classFormControl
-
getValue
Returns the value associated with this button. -
doOnClickSequence
the onClickSequence for this button- Returns:
- true if the even was handled
- Throws:
IOException
SAXException
-
click
Performs the action associated with clicking this button after running any 'onClick' script. For a submit button this typically submits the form.- Throws:
IOException
SAXException
-
rememberEnableState
public void rememberEnableState()remember wether the button was enabled -
verifyButtonEnabled
protected void verifyButtonEnabled()verifyButtonEnabled -
throwDisabledException
public void throwDisabledException()throw an exception that I'm disbled -
isDisabled
public boolean isDisabled()Returns true if this button is disabled, meaning that it cannot be clicked.- Overrides:
isDisabled
in classFormControl
-
doButtonAction
Perform the normal action of this button.- Parameters:
x
- - the x coordinatey
- - the y coordinate- Throws:
IOException
SAXException
-
doButtonAction
Perform the normal action of this button. delegate to the x-y version- Throws:
IOException
SAXException
-
getValues
Description copied from class:FormControl
Returns the current value(s) associated with this control. These values will be transmitted to the server if the control is 'successful'.- Specified by:
getValues
in classFormControl
-
addValues
protected void addValues(com.meterware.httpunit.protocol.ParameterProcessor processor, String characterSet) throws IOException - Specified by:
addValues
in classFormControl
- Throws:
IOException
-
newScriptable
Description copied from class:FormControl
Creates and returns a scriptable object for this control. Subclasses should override this if they use a different implementation of Scriptable.- Specified by:
newScriptable
in interfaceHTMLElement
- Overrides:
newScriptable
in classFormControl
-
getParentDelegate
Description copied from interface:HTMLElement
Returns the scriptable delegate which can provide the scriptable delegate for this element.- Specified by:
getParentDelegate
in interfaceHTMLElement
- Overrides:
getParentDelegate
in classFormControl
-
getID
Description copied from interface:HTMLElement
Returns the ID associated with this element. IDs are unique throughout the HTML document.- Specified by:
getID
in interfaceHTMLElement
-
getClassName
Description copied from interface:HTMLElement
Returns the class associated with this element.- Specified by:
getClassName
in interfaceHTMLElement
-
getTitle
Description copied from interface:HTMLElement
Returns the title associated with this element.- Specified by:
getTitle
in interfaceHTMLElement
-
getName
Description copied from interface:HTMLElement
Returns the name associated with this element.- Specified by:
getName
in interfaceHTMLElement
-
getScriptingHandler
Returns a scriptable object which can act as a proxy for this control.- Specified by:
getScriptingHandler
in interfaceHTMLElement
-
doEvent
Deprecated.since 1.7 - use doEventScript insteadhandle the event that has the given script attached by compiling the eventScript as a function and executing it- Specified by:
doEvent
in interfaceScriptingEventHandler
- Parameters:
eventScript
- - the script to use- Returns:
- true if the script is empty or the result of the script
-
doEventScript
optional do the event if it's defined- Specified by:
doEventScript
in interfaceScriptingEventHandler
- Parameters:
eventScript
-- Returns:
- true if the script is empty or the result of the script
-
handleEvent
Description copied from interface:ScriptingEventHandler
handle the event with the given name by getting the attribute and then executing the eventScript for it- Specified by:
handleEvent
in interfaceScriptingEventHandler
- Parameters:
eventName
-- Returns:
- the result of doEventScript
-
getText
Returns the text value of this block.- Specified by:
getText
in interfaceHTMLElement
-
getTagName
Description copied from interface:HTMLElement
Returns the tag name of this node.- Specified by:
getTagName
in interfaceHTMLElement
-
getAttribute
get the Attribute with the given name - by delegating to NodeUtils- Specified by:
getAttribute
in interfaceHTMLElement
- Parameters:
name
- - the name of the attribute to get- Returns:
- the attribute
-
setAttribute
set the Attribute with the given name - by delegating to NodeUtils- Specified by:
setAttribute
in interfaceHTMLElement
- Parameters:
name
- - the name of the attribute to setvalue
- - the value to set
-
removeAttribute
remove the Attribute with the given name - by delegating to NodeUtils- Specified by:
removeAttribute
in interfaceHTMLElement
- Parameters:
name
- - the name of the attribute to remove
-
isSupportedAttribute
Description copied from interface:HTMLElement
Returns true if this element may have an attribute with the specified name.- Specified by:
isSupportedAttribute
in interfaceHTMLElement
-
getAttribute
-
getNode
Description copied from interface:HTMLElement
Returns the DOM node underlying this element.- Specified by:
getNode
in interfaceHTMLElement
-
supportAttribute
-