com.meterware.httpunit
Class SubmitButton

java.lang.Object
  extended by com.meterware.httpunit.FormControl
      extended by com.meterware.httpunit.Button
          extended by com.meterware.httpunit.SubmitButton
All Implemented Interfaces:
HTMLElement, ScriptingEventHandler

public class SubmitButton
extends Button

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
protected  void addValues(ParameterProcessor processor, java.lang.String characterSet)
          addValues if not disabled and pressed
 void 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 Action
 boolean doEvent(java.lang.String eventScript)
          Deprecated. since 1.7 - use doEventScript instead
 boolean doEventScript(java.lang.String eventScript)
          optional do the event if it's defined
 boolean equals(java.lang.Object o)
           
 java.lang.String getAttribute(java.lang.String name)
          get the Attribute with the given name - by delegating to NodeUtils
protected  java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
           
 java.lang.String getClassName()
          Returns the class associated with this element.
 java.lang.String getID()
          Returns the ID associated with this element.
 java.lang.String getName()
          Returns the name associated with this element.
 org.w3c.dom.Node getNode()
          Returns the DOM node underlying this element.
 ScriptingHandler getScriptingHandler()
          Returns a scriptable object which can act as a proxy for this control.
 java.lang.String getTagName()
          Returns the tag name of this node.
 java.lang.String getText()
          Returns the text value of this block.
 java.lang.String getTitle()
          Returns the title associated with this element.
 java.lang.String getType()
          Return the type of the control, as seen from JavaScript.
protected  java.lang.String[] getValues()
          Returns the current value(s) associated with this control.
 boolean handleEvent(java.lang.String eventName)
          handle the event with the given name by getting the attribute and then executing the eventScript for it
 int hashCode()
           
static boolean isAllowUnnamedImageButton()
           
 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 during WebForm.submitNoButton() call.
 boolean isImageButton()
          Returns true if this submit button is an image map.
 boolean isSupportedAttribute(java.lang.String name)
          Returns true if this element may have an attribute with the specified name.
 boolean isValidImageButton()
          return whether this is a validImageButton
 java.lang.String positionParameterName(java.lang.String direction)
          return the name of the positionParameter for this button (if this is an image Button)
 void removeAttribute(java.lang.String name)
          remove the Attribute with the given name - by delegating to NodeUtils
static void setAllowUnnamedImageButton(boolean allowUnnamedImageButton)
           
 void setAttribute(java.lang.String name, java.lang.Object value)
          set the Attribute with the given name - by delegating to NodeUtils
protected  void supportAttribute(java.lang.String name)
           
 void throwDisabledException()
          throw an exception that I'm disbled
 java.lang.String toString()
           
 
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
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getType

public java.lang.String getType()
Description copied from class: FormControl
Return the type of the control, as seen from JavaScript.

Overrides:
getType in class Button

isImageButton

public boolean isImageButton()
Returns true if this submit button is an image map.


click

public void click(int x,
                  int y)
           throws java.io.IOException,
                  org.xml.sax.SAXException
Performs the action associated with clicking this button after running any 'onClick' script. For a submit button this typically submits the form.

Throws:
java.io.IOException
org.xml.sax.SAXException
Since:
1.6

doButtonAction

protected void doButtonAction(int x,
                              int y)
                       throws java.io.IOException,
                              org.xml.sax.SAXException
do the button Action

Overrides:
doButtonAction in class Button
Parameters:
x - - x coordinate
y - - y coordinate
Throws:
java.io.IOException
org.xml.sax.SAXException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

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 during WebForm.submitNoButton() call.

Returns:
- whether this button is a faked button inserted by httpunit

getValues

protected java.lang.String[] getValues()
Returns the current value(s) associated with this control. These values will be transmitted to the server if the control is 'successful'.

Overrides:
getValues in class Button

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

public java.lang.String positionParameterName(java.lang.String direction)
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(ParameterProcessor processor,
                         java.lang.String characterSet)
                  throws java.io.IOException
addValues if not disabled and pressed

Overrides:
addValues in class Button
Parameters:
processor - - the ParameterProcessor used
characterSet - - the active character set
Throws:
java.io.IOException - if addValues fails

throwDisabledException

public void throwDisabledException()
Description copied from class: Button
throw an exception that I'm disbled

Overrides:
throwDisabledException in class Button

getID

public java.lang.String getID()
Description copied from interface: HTMLElement
Returns the ID associated with this element. IDs are unique throughout the HTML document.

Specified by:
getID in interface HTMLElement

getClassName

public java.lang.String getClassName()
Description copied from interface: HTMLElement
Returns the class associated with this element.

Specified by:
getClassName in interface HTMLElement

getTitle

public java.lang.String getTitle()
Description copied from interface: HTMLElement
Returns the title associated with this element.

Specified by:
getTitle in interface HTMLElement

getName

public java.lang.String getName()
Description copied from interface: HTMLElement
Returns the name associated with this element.

Specified by:
getName in interface HTMLElement

getScriptingHandler

public ScriptingHandler getScriptingHandler()
Returns a scriptable object which can act as a proxy for this control.

Specified by:
getScriptingHandler in interface HTMLElement

doEvent

public boolean doEvent(java.lang.String eventScript)
Deprecated. since 1.7 - use doEventScript instead

handle the event that has the given script attached by compiling the eventScript as a function and executing it

Specified by:
doEvent in interface ScriptingEventHandler
Parameters:
eventScript - - the script to use
Returns:
true if the script is empty or the result of the script

doEventScript

public boolean doEventScript(java.lang.String eventScript)
optional do the event if it's defined

Specified by:
doEventScript in interface ScriptingEventHandler
Returns:
true if the script is empty or the result of the script

handleEvent

public boolean handleEvent(java.lang.String eventName)
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 interface ScriptingEventHandler
Returns:
the result of doEventScript

getText

public java.lang.String getText()
Returns the text value of this block.

Specified by:
getText in interface HTMLElement

getTagName

public java.lang.String getTagName()
Description copied from interface: HTMLElement
Returns the tag name of this node.

Specified by:
getTagName in interface HTMLElement

getAttribute

public java.lang.String getAttribute(java.lang.String name)
get the Attribute with the given name - by delegating to NodeUtils

Specified by:
getAttribute in interface HTMLElement
Parameters:
name - - the name of the attribute to get
Returns:
the attribute

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
set the Attribute with the given name - by delegating to NodeUtils

Specified by:
setAttribute in interface HTMLElement
Parameters:
name - - the name of the attribute to set
value - - the value to set

removeAttribute

public void removeAttribute(java.lang.String name)
remove the Attribute with the given name - by delegating to NodeUtils

Specified by:
removeAttribute in interface HTMLElement
Parameters:
name - - the name of the attribute to remove

isSupportedAttribute

public boolean isSupportedAttribute(java.lang.String name)
Description copied from interface: HTMLElement
Returns true if this element may have an attribute with the specified name.

Specified by:
isSupportedAttribute in interface HTMLElement

getAttribute

protected java.lang.String getAttribute(java.lang.String name,
                                        java.lang.String defaultValue)

getNode

public org.w3c.dom.Node getNode()
Description copied from interface: HTMLElement
Returns the DOM node underlying this element.

Specified by:
getNode in interface HTMLElement

supportAttribute

protected void supportAttribute(java.lang.String name)


Copyright © 2011. All Rights Reserved.