Starts with no held controls/widgets.
Adds a tag contents to the form.
Absolute URL of the target.
ID field of form for unique identification.
string
getId
()
Accessor for form action.
string
getMethod
()
Extracts current value from form.
string
getValue
(string $name)
-
string
$name: Keyed by widget name.
Extracts current value from form by the ID.
string
getValueById
(string/integer $id)
-
string/integer
$id: Keyed by widget ID attribute.
Reads the current form values as a hash of submitted parameters. Repeated parameters appear as a list.
hash
getValues
()
Test to see if a form has a submittable image with this ID attribute.
boolean
hasImageId
(string $id)
-
string
$id: Button ID attribute to search for.
Test to see if a form has a submit button with this name attribute.
boolean
hasImageLabel
(string $label)
-
string
$label: Button alt attribute to search for or nearest equivalent.
Test to see if a form has a submittable image with this field name.
boolean
hasImageName
(string $name)
-
string
$name: Image name to search for.
Test to see if a form has a submit button with this ID attribute.
boolean
hasSubmitId
(string $id)
-
string
$id: Button ID attribute to search for.
Test to see if a form has a submit button with this value attribute.
boolean
hasSubmitLabel
(string $label)
-
string
$label: Button label to search for.
Test to see if a form has a submit button with this name attribute.
boolean
hasSubmitName
(string $name)
-
string
$name: Name to look for.
Sets the frame target within a frameset.
void
setDefaultTarget
(string $frame)
-
string
$frame: Name of frame.
Sets a widget value within the form.
boolean
setField
(string $name, string $value)
-
string
$name: Name of widget tag.
-
string
$value: Value to input into the widget.
Sets a widget value within the form by using the ID.
boolean
setFieldById
(string/integer $id, string $value)
-
string/integer
$id: Name of widget tag.
-
string
$value: Value to input into the widget.
Simply submits the form without the submit button value. Used when there is only one button or it is unimportant.
hash
submit
()
Gets the submit values for a button identified by the ID.
hash
submitButtonById
(string $id)
-
string
$id: Button ID attribute to search for.
Gets the submit values for a named button.
hash
submitButtonByLabel
(string $label)
-
string
$label: Button label to search for.
Gets the submit values for a named button.
hash
submitButtonByName
(string $name)
-
string
$name: Button label to search for.
Gets the submit values for an image identified by the ID.
hash
submitImageById
(string/integer $id, integer $x, integer $y)
-
string/integer
$id: Button ID attribute to search for.
-
integer
$x: X-coordinate of click.
-
integer
$y: Y-coordinate of click.
Gets the submit values for an image identified by the alt tag or nearest equivalent.
hash
submitImageByLabel
(string $label, integer $x, integer $y)
-
string
$label: Button label to search for.
-
integer
$x: X-coordinate of click.
-
integer
$y: Y-coordinate of click.
Gets the submit values for an image identified by the ID.
hash
submitImageByName
(string $name, integer $x, integer $y)
-
string
$name: Image name to search for.
-
integer
$x: X-coordinate of click.
-
integer
$y: Y-coordinate of click.
Adds a checkbox, making it a group on a repeated name.
Adds a radio button, building a group if necessary.
Combined action attribute with current location to get an absolute form target.
-
string
$action: Action attribute from form tag.
-
SimpleUrl
$base: Page location.
Sets the widget into the form, grouping radio buttons if any.