jaxcent
Class HtmlForm

java.lang.Object
  extended byjaxcent.JaxcentObject
      extended byjaxcent.JaxcentHtmlElement
          extended byjaxcent.HtmlForm

public class HtmlForm
extends JaxcentHtmlElement

The class HtmlForm corresponds to FORM tags on the page.


Constructor Summary
HtmlForm(JaxcentPage page, SearchType searchType, java.lang.String str)
          Search for HTML element on page by specified search type and search string.
HtmlForm(JaxcentPage page, SearchType searchType, java.lang.String[] attributes, java.lang.String[] values)
          Create new HTML element on page using the specified attributes and values.
HtmlForm(JaxcentPage page, SearchType searchType, java.lang.String str, int index)
          Search for HTML Element on page by specified search type and search string, and search index.
HtmlForm(JaxcentPage page, SearchType searchType, java.lang.String tag, java.lang.String text)
          Create new HTML Element on page using the specified tag.
HtmlForm(JaxcentPage page, SearchType searchType, java.lang.String text, java.lang.String[] attributes, java.lang.String[] values)
          Create new HTML element on page using the specified text and attributes and values.
HtmlForm(JaxcentPage page, java.lang.String id)
          Search for HTML element on page by specified ID
 
Method Summary
 java.lang.String getAction()
          Retrieve the "action" property
 int getLength()
          Retrieve the "length" property
 java.lang.String getMethod()
          Retrieve the "method" property
 java.lang.String getName()
          Retrieve the "name" property
 java.lang.String getTarget()
          Retrieve the "target" property
protected  void onBlur()
          Override to handle the "blur" event
protected  void onClick()
          Override to handle the "click" event
protected  void onFocus()
          Override to handle the "focus" event
protected  void onMouseDown()
          Override to handle the "mouseDown" event
protected  void onMouseUp()
          Override to handle the "mouseUp" event
protected  void onReset()
          Override to handle the "reset" event
protected  void onSubmit()
          Override to handle the "submit" event
protected  void onSubmit(java.util.Map pageData)
          Override to handle the "submit" event and receive current page data
 void reset()
          Reset the form.
 void scrollIntoView(boolean top)
          Bring the element into view, by scrolling if necessary.
 void setAction(java.lang.String value)
          Set the "action" property
 void setMethod(java.lang.String value)
          Set the "method" property
 void setName(java.lang.String value)
          Set the "name" property
 void setTarget(java.lang.String value)
          Set the "target" property
 void submit()
          Submit the form.
 
Methods inherited from class jaxcent.JaxcentHtmlElement
getAttribute, getID, getInnerText, getStyle, getTag, hide, insertAfter, insertAtBeginning, insertAtBeginning, insertAtEnd, insertAtEnd, insertBefore, setAttribute, setInnerText, setStyle, setStyle, setStyle, setStyle, setVisible, show
 
Methods inherited from class jaxcent.JaxcentObject
addJavaScriptVerification, getId, getProperty, setId, setProperty, setProperty, setProperty, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HtmlForm

public HtmlForm(JaxcentPage page,
                java.lang.String id)
Search for HTML element on page by specified ID


HtmlForm

public HtmlForm(JaxcentPage page,
                SearchType searchType,
                java.lang.String str)
Search for HTML element on page by specified search type and search string. If the search returns multiple objects, use the first one.


HtmlForm

public HtmlForm(JaxcentPage page,
                SearchType searchType,
                java.lang.String str,
                int index)
Search for HTML Element on page by specified search type and search string, and search index. The search is expected to return multiple results. The search index is 0-based, and specifies the index in the multiple results. This constructor is not for use with createNew.


HtmlForm

public HtmlForm(JaxcentPage page,
                SearchType searchType,
                java.lang.String tag,
                java.lang.String text)
         throws Jaxception
Create new HTML Element on page using the specified tag. Search type must be createNew and tag must be "FORM". If text is non null, the new element is populated with that text.


HtmlForm

public HtmlForm(JaxcentPage page,
                SearchType searchType,
                java.lang.String[] attributes,
                java.lang.String[] values)
         throws Jaxception
Create new HTML element on page using the specified attributes and values. Search type must be createNew. Attributes and values arrays must have the same length.


HtmlForm

public HtmlForm(JaxcentPage page,
                SearchType searchType,
                java.lang.String text,
                java.lang.String[] attributes,
                java.lang.String[] values)
         throws Jaxception
Create new HTML element on page using the specified text and attributes and values. Search type must be createNew. Attributes and values arrays must have the same length.

Method Detail

onClick

protected void onClick()
Override to handle the "click" event


onMouseDown

protected void onMouseDown()
Override to handle the "mouseDown" event


onMouseUp

protected void onMouseUp()
Override to handle the "mouseUp" event


onReset

protected void onReset()
Override to handle the "reset" event


onSubmit

protected void onSubmit()
Override to handle the "submit" event


onSubmit

protected void onSubmit(java.util.Map pageData)
Override to handle the "submit" event and receive current page data


onFocus

protected void onFocus()
Override to handle the "focus" event


onBlur

protected void onBlur()
Override to handle the "blur" event


setName

public void setName(java.lang.String value)
             throws Jaxception
Set the "name" property

Throws:
Jaxception

getName

public java.lang.String getName()
                         throws Jaxception
Retrieve the "name" property

Throws:
Jaxception

getLength

public int getLength()
              throws Jaxception
Retrieve the "length" property

Throws:
Jaxception

setTarget

public void setTarget(java.lang.String value)
               throws Jaxception
Set the "target" property

Throws:
Jaxception

getTarget

public java.lang.String getTarget()
                           throws Jaxception
Retrieve the "target" property

Throws:
Jaxception

setAction

public void setAction(java.lang.String value)
               throws Jaxception
Set the "action" property

Throws:
Jaxception

getAction

public java.lang.String getAction()
                           throws Jaxception
Retrieve the "action" property

Throws:
Jaxception

setMethod

public void setMethod(java.lang.String value)
               throws Jaxception
Set the "method" property

Throws:
Jaxception

getMethod

public java.lang.String getMethod()
                           throws Jaxception
Retrieve the "method" property

Throws:
Jaxception

scrollIntoView

public void scrollIntoView(boolean top)
                    throws Jaxception
Bring the element into view, by scrolling if necessary. If top is true, the top of element is brought into view, otherwise the bottom of the element is scrolled into view.

Throws:
Jaxception

reset

public void reset()
           throws Jaxception
Reset the form.

Throws:
Jaxception

submit

public void submit()
            throws Jaxception
Submit the form.

Throws:
Jaxception