Package com.meterware.httpunit
Class SubmitButton
java.lang.Object
com.meterware.httpunit.FormControl
com.meterware.httpunit.Button
com.meterware.httpunit.SubmitButton
- All Implemented Interfaces:
HTMLElement
,ScriptingEventHandler
This class represents a submit button in an HTML form.
-
Field Summary
Fields inherited from class com.meterware.httpunit.Button
WITH_ID, WITH_LABEL
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
addValues if not disabled and pressedvoid
click
(int x, int y) Performs the action associated with clicking this button after running any 'onClick' script.protected void
doButtonAction
(int x, int y) do the button Actionboolean
Deprecated.since 1.7 - use doEventScript insteadboolean
doEventScript
(String eventScript) optional do the event if it's definedboolean
getAttribute
(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 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.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 itint
hashCode()
static boolean
boolean
isFake()
getter for the fake flag Returns true for synthetic submit buttons, created by HttpUnit in forms that contain no submit buttons, or used duringWebForm.submitNoButton()
call.boolean
Returns true if this submit button is an image map.boolean
isSupportedAttribute
(String name) Returns true if this element may have an attribute with the specified name.boolean
return whether this is a validImageButtonpositionParameterName
(String direction) return the name of the positionParameter for this button (if this is an image Button)void
removeAttribute
(String name) remove the Attribute with the given name - by delegating to NodeUtilsstatic void
setAllowUnnamedImageButton
(boolean allowUnnamedImageButton) void
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 disbledtoString()
Methods inherited from class com.meterware.httpunit.Button
click, doButtonAction, doOnClickSequence, getParentDelegate, getValue, isDisabled, newScriptable, rememberEnableState, verifyButtonEnabled
Methods 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
-
Method Details
-
getType
Description copied from class:FormControl
Return the type of the control, as seen from JavaScript. -
isImageButton
public boolean isImageButton()Returns true if this submit button is an image map. -
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
- Since:
- 1.6
-
doButtonAction
do the button Action- Overrides:
doButtonAction
in classButton
- Parameters:
x
- - x coordinatey
- - y coordinate- Throws:
IOException
SAXException
-
toString
-
hashCode
public int hashCode() -
equals
-
isFake
public boolean isFake()getter for the fake flag Returns true for synthetic submit buttons, created by HttpUnit in forms that contain no submit buttons, or used duringWebForm.submitNoButton()
call.- Returns:
- - whether this button is a faked button inserted by httpunit
-
getValues
Returns the current value(s) associated with this control. These values will be transmitted to the server if the control is 'successful'. -
isAllowUnnamedImageButton
public static boolean isAllowUnnamedImageButton()- Returns:
- the allowUnnamedImageButton
-
setAllowUnnamedImageButton
public static void setAllowUnnamedImageButton(boolean allowUnnamedImageButton) - Parameters:
allowUnnamedImageButton
- the allowUnnamedImageButton to set
-
isValidImageButton
public boolean isValidImageButton()return whether this is a validImageButton- Returns:
- true if it is an image Button
-
positionParameterName
return the name of the positionParameter for this button (if this is an image Button)- Parameters:
direction
- e.g. "x" or "y"- Returns:
- the name e.g. "image.x" or just "x"
-
addValues
protected void addValues(com.meterware.httpunit.protocol.ParameterProcessor processor, String characterSet) throws IOException addValues if not disabled and pressed- Overrides:
addValues
in classButton
- Parameters:
processor
- - the ParameterProcessor usedcharacterSet
- - the active character set- Throws:
IOException
- if addValues fails
-
throwDisabledException
public void throwDisabledException()Description copied from class:Button
throw an exception that I'm disbled- Overrides:
throwDisabledException
in classButton
-
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
- 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
- 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
-