com.jauntium

Class Form

java.lang.Object

com.jauntium.Form

public class Form
extends Object

A utility component that makes it easy to locate and fill-out the input fields of a particular HTML form; convenience methods allow for reading/setting input fields (eg textfields, dropdown menus, checkboxes, etc), and for submitting the form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Form.LabelSide Represents whether a label is on the left or right side of a checkbox/radiobutton/etc.

Field Summary

Fields

Modifier and Type	Field and Description
Element	element

Method Summary

Modifier and Type	Method and Description
Form	apply(Object... args) Applies the specified parameters in succession to the form's editable (ie, visible and non-disabled) inputs, starting from the input after the most recently edited input, or starting from the first input, if the form has not yet been edited.
boolean	checkBoxIsChosen(String label, Form.LabelSide labelSide) Examines the checkbox with the specified text label and returns true if it is checked, otherwise returns false.
Form	chooseCheckBox(String label) Selects the checkbox that has the specified text label on the right side.
Form	chooseCheckBox(String label, Form.LabelSide labelSide) Selects the checkbox with the specified text label.
Form	chooseMenuItem(String label, String menuItemText) Locates the dropdown menu that has the specified text label and selects the menuItem that matches the specified menuItemText.
Form	chooseRadioButton(String label) Selects the radiobutton that has the specified text label on the right side.
Form	chooseRadioButton(String label, Form.LabelSide labelSide) Selects the radiobutton with the specified text label.
String	getChosenMenuItem(String label) Locates the dropdown menu that has the specified text label and returns the text of the selected menu item.
String	getFieldValue(String label) Returns the value of the textfield, password field, or textarea field that has the specified text label.
boolean	menuItemIsChosen(String label, String menuItemText) Locates the dropdown menu that has the specified text label and determines whether the menuitem that matches the specified text is selected, returning true/false correspondingly.
boolean	radioButtonIsChosen(String label, Form.LabelSide labelSide) Examines the radiobutton with the specified text label and returns true if it is checked, otherwise returns false.
Form	setFieldValue(String label, String value) Locates the textfield, password field, or textarea field that has the specified text label and fills the field with the specified text value.
Document	submit() Submits the the form without clicking on any particular submit button.
Document	submit(String buttonText) Submits the the form by clicking the first submit button who's value (ie, text label) matches the specified (case-insensitive) buttonText and throws a NotFound Exception if it does not exist.
String	toString() Returns the outerHTML of the form element.
Form	unchooseCheckBox(String label) Deselects the checkbox that has the specified text label on the right side.
Form	unchooseCheckBox(String label, Form.LabelSide labelSide) Deselects the checkbox with the specified text label.
Form	unchooseRadioButton(String label) Deselects the radiobutton that has the specified text label on the right side.
Form	unchooseRadioButton(String label, Form.LabelSide labelSide) Deselects the radiobutton with the specified text label.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

element

public Element element

Method Detail

setFieldValue

public Form setFieldValue(String label,
                          String value)
                   throws JauntiumException

Locates the textfield, password field, or textarea field that has the specified text label and fills the field with the specified text value.

Parameters:

label - the text label to the immediate left side of the field (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

value - the value with which to fillout the field.

Throws:

JauntiumException

getFieldValue

public String getFieldValue(String label)
                     throws JauntiumException

Returns the value of the textfield, password field, or textarea field that has the specified text label.

Parameters:

label - the text label to the immediate left side of the field (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

chooseMenuItem

public Form chooseMenuItem(String label,
                           String menuItemText)
                    throws JauntiumException

Locates the dropdown menu that has the specified text label and selects the menuItem that matches the specified menuItemText.

Parameters:

label - the text label to the immediate left side of the dropdown menu (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

menuItemText - the text of the menuItem to be selected, matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

menuItemIsChosen

public boolean menuItemIsChosen(String label,
                                String menuItemText)
                         throws JauntiumException

Locates the dropdown menu that has the specified text label and determines whether the menuitem that matches the specified text is selected, returning true/false correspondingly.

Parameters:

label - the text label to the immediate left side of the dropdown menu (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

menuItemText - the text of the menuItem, matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

getChosenMenuItem

public String getChosenMenuItem(String label)
                         throws JauntiumException

Locates the dropdown menu that has the specified text label and returns the text of the selected menu item.

Parameters:

label - the text label to the immediate left side of the dropdown menu (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

chooseRadioButton

public Form chooseRadioButton(String label,
                              Form.LabelSide labelSide)
                       throws JauntiumException

Selects the radiobutton with the specified text label.

Parameters:

label - the text label to the immediate side of the radiobutton (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the radiobutton.

Throws:

JauntiumException

chooseCheckBox

public Form chooseCheckBox(String label,
                           Form.LabelSide labelSide)
                    throws JauntiumException

Selects the checkbox with the specified text label.

Parameters:

label - the text label to the immediate side of the checkbox (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the checkbox.

Throws:

JauntiumException

chooseRadioButton

public Form chooseRadioButton(String label)
                       throws JauntiumException

Selects the radiobutton that has the specified text label on the right side.

Parameters:

label - the text label to the immediate left side of the radiobutton (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

chooseCheckBox

public Form chooseCheckBox(String label)
                    throws JauntiumException

Selects the checkbox that has the specified text label on the right side.

Parameters:

label - the text label to the immediate left side of the checkbox (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

unchooseRadioButton

public Form unchooseRadioButton(String label,
                                Form.LabelSide labelSide)
                         throws JauntiumException

Deselects the radiobutton with the specified text label.

Parameters:

label - the text label to the immediate side of the radiobutton (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the radiobutton.

Throws:

JauntiumException

unchooseCheckBox

public Form unchooseCheckBox(String label,
                             Form.LabelSide labelSide)
                      throws JauntiumException

Deselects the checkbox with the specified text label.

Parameters:

label - the text label to the immediate side of the checkbox (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the checkbox.

Throws:

JauntiumException

unchooseRadioButton

public Form unchooseRadioButton(String label)
                         throws JauntiumException

Deselects the radiobutton that has the specified text label on the right side.

Parameters:

label - the text label to the immediate side of the radiobutton (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

unchooseCheckBox

public Form unchooseCheckBox(String label)
                      throws JauntiumException

Deselects the checkbox that has the specified text label on the right side.

Parameters:

label - the text label to the immediate side of the checkbox (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

Throws:

JauntiumException

radioButtonIsChosen

public boolean radioButtonIsChosen(String label,
                                   Form.LabelSide labelSide)
                            throws JauntiumException

Examines the radiobutton with the specified text label and returns true if it is checked, otherwise returns false.

Parameters:

label - the text label to the immediate side of the radiobutton (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the radioButton

Throws:

JauntiumException

checkBoxIsChosen

public boolean checkBoxIsChosen(String label,
                                Form.LabelSide labelSide)
                         throws JauntiumException

Examines the checkbox with the specified text label and returns true if it is checked, otherwise returns false.

Parameters:

label - the text label to the immediate side of the checkbox (including colon or any other punctuation), matched in a case-insensitive, whitespace-insensitive manner.

labelSide - whether the label is on the left of right side of the checkbox.

Throws:

JauntiumException

apply

public Form apply(Object... args)
           throws JauntiumException

Applies the specified parameters in succession to the form's editable (ie, visible and non-disabled) inputs, starting from the input after the most recently edited input, or starting from the first input, if the form has not yet been edited.

Parameters:

args - an arg of type String will populate a textfield/textarea/passwordField OR select the matching menuItem in a dropdown menu OR select the matching right-side label of a radiobutton (unless the string is "\t", in which case it will skip to the next form component); a Boolean param will check/uncheck a checkbox; any other type of param will be treated as a String by calling its toString() method; If number of args exceeds the number of form controls, the extra arguments are ignored.

Throws:

JauntiumException

submit

public Document submit(String buttonText)
                throws NotFound

Submits the the form by clicking the first submit button who's value (ie, text label) matches the specified (case-insensitive) buttonText and throws a NotFound Exception if it does not exist.

Returns:

Document corresponding to the page retrieved after submitting the form.

Throws:

NotFound

submit

public Document submit()

Submits the the form without clicking on any particular submit button.

Returns:

Document corresponding to the page retrieved after submitting the form.

toString

public String toString()

Returns the outerHTML of the form element.

Overrides:

toString in class Object