org.htmlparser.tags

Class FormTag

Implemented Interfaces:
Cloneable, Node, Serializable, Tag

public class FormTag
extends CompositeTag

Represents a FORM tag.
Author:
ili

Field Summary

static String
GET
The method.
static String
POST
The method.
protected String
mFormLocation
This is the derived form location, based on action.

Fields inherited from class org.htmlparser.tags.CompositeTag

mDefaultCompositeScanner, mEndTag

Fields inherited from class org.htmlparser.nodes.TagNode

breakTags, mAttributes, mDefaultScanner

Fields inherited from class org.htmlparser.nodes.AbstractNode

children, mPage, nodeBegin, nodeEnd, parent

Constructor Summary

FormTag()
Create a new form tag.

Method Summary

String
extractFormLocn()
Extract the ACTION attribute as an absolute URL.
String[]
getEndTagEnders()
Return the set of end tag names that cause this tag to finish.
String[]
getEnders()
Return the set of tag names that cause this tag to finish.
NodeList
getFormInputs()
Get the list of input fields.
String
getFormLocation()
Get the value of the action attribute.
String
getFormMethod()
Returns the method of the form, GET or POST.
String
getFormName()
Get the value of the name attribute.
NodeList
getFormTextareas()
Get the list of text areas.
String[]
getIds()
Return the set of names handled by this tag.
InputTag
getInputTag(String name)
Get the input tag in the form corresponding to the given name
TextareaTag
getTextAreaTag(String name)
Find the textarea tag matching the given name
void
setFormLocation(String url)
Set the form location.
String
toString()
Return a string representation of the contents of this FORM tag suitable for debugging.

Methods inherited from class org.htmlparser.tags.CompositeTag

accept, childAt, children, collectInto, digupStringNode, elements, findPositionOf, findPositionOf, findPositionOf, getChild, getChildCount, getChildrenAsNodeArray, getChildrenHTML, getEndTag, getStringText, getText, putChildrenInto, putEndTagInto, removeChild, searchByName, searchFor, searchFor, searchFor, searchFor, setEndTag, toHtml, toPlainTextString, toString, toString

Methods inherited from class org.htmlparser.nodes.TagNode

accept, breaksFlow, getAttribute, getAttributeEx, getAttributesEx, getEndTag, getEndTagEnders, getEnders, getEndingLineNumber, getIds, getRawTagName, getStartingLineNumber, getTagBegin, getTagEnd, getTagName, getText, getThisScanner, isEmptyXmlTag, isEndTag, removeAttribute, setAttribute, setAttribute, setAttribute, setAttributeEx, setAttributesEx, setEmptyXmlTag, setEndTag, setTagBegin, setTagEnd, setTagName, setText, setThisScanner, toHtml, toPlainTextString, toString

Methods inherited from class org.htmlparser.nodes.AbstractNode

accept, clone, collectInto, doSemanticAction, getChildren, getEndPosition, getFirstChild, getLastChild, getNextSibling, getPage, getParent, getPreviousSibling, getStartPosition, getText, setChildren, setEndPosition, setPage, setParent, setStartPosition, setText, toHtml, toHtml, toPlainTextString, toString

Field Details

GET

public static final String GET
The method.

POST

public static final String POST
The method.

mFormLocation

protected String mFormLocation
This is the derived form location, based on action.

Constructor Details

FormTag

public FormTag()
Create a new form tag.

Method Details

extractFormLocn

public String extractFormLocn()
Extract the ACTION attribute as an absolute URL.
Returns:
The URL the form is to be submitted to.

getEndTagEnders

public String[] getEndTagEnders()
Return the set of end tag names that cause this tag to finish.
Specified by:
getEndTagEnders in interface Tag
Overrides:
getEndTagEnders in interface TagNode
Returns:
The names of following end tags that stop further scanning.

getEnders

public String[] getEnders()
Return the set of tag names that cause this tag to finish.
Specified by:
getEnders in interface Tag
Overrides:
getEnders in interface TagNode
Returns:
The names of following tags that stop further scanning.

getFormInputs

public NodeList getFormInputs()
Get the list of input fields.
Returns:
Input elements in the form.

getFormLocation

public String getFormLocation()
Get the value of the action attribute.
Returns:
The submit url of the form.

getFormMethod

public String getFormMethod()
Returns the method of the form, GET or POST.
Returns:
String The method of the form (GET if nothing is specified).

getFormName

public String getFormName()
Get the value of the name attribute.
Returns:
String The name of the form

getFormTextareas

public NodeList getFormTextareas()
Get the list of text areas.
Returns:
Textarea elements in the form.

getIds

public String[] getIds()
Return the set of names handled by this tag.
Specified by:
getIds in interface Tag
Overrides:
getIds in interface TagNode
Returns:
The names to be matched that create tags of this type.

getInputTag

public InputTag getInputTag(String name)
Get the input tag in the form corresponding to the given name
Parameters:
name - The name of the input tag to be retrieved
Returns:
Tag The input tag corresponding to the name provided

getTextAreaTag

public TextareaTag getTextAreaTag(String name)
Find the textarea tag matching the given name
Parameters:
name - Name of the textarea tag to be found within the form.
Returns:
The TEXTAREA tag with the matching name.

setFormLocation

public void setFormLocation(String url)
Set the form location. Modification of this element will cause the HTML rendering to change as well (in a call to toHTML()).
Parameters:
url - The new FORM location

toString

public String toString()
Return a string representation of the contents of this FORM tag suitable for debugging.
Specified by:
toString in interface Node
Overrides:
toString in interface CompositeTag
Returns:
A textual representation of the form tag.

HTML Parser is an open source library released under LGPL. SourceForge.net