HTML Parser Home Page

org.htmlparser.tags
Class FormTag

java.lang.Object
  extended by org.htmlparser.nodes.AbstractNode
      extended by org.htmlparser.nodes.TagNode
          extended by org.htmlparser.tags.CompositeTag
              extended by org.htmlparser.tags.FormTag
All Implemented Interfaces:
Serializable, Cloneable, Node, Tag

public class FormTag
extends CompositeTag

Represents a FORM tag.

Author:
ili
See Also:
Serialized Form

Field Summary
static String GET
          The "GET" method.
protected  String mFormLocation
          This is the derived form location, based on action.
static String POST
          The "POST" method.
 
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[] getEnders()
          Return the set of tag names that cause this tag to finish.
 String[] getEndTagEnders()
          Return the set of end 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
 
Methods inherited from class org.htmlparser.nodes.TagNode
breaksFlow, getAttribute, getAttributeEx, getAttributesEx, getEndingLineNumber, getRawTagName, getStartingLineNumber, getTagBegin, getTagEnd, getTagName, getThisScanner, isEmptyXmlTag, isEndTag, removeAttribute, setAttribute, setAttribute, setAttribute, setAttributeEx, setAttributesEx, setEmptyXmlTag, setTagBegin, setTagEnd, setTagName, setText, setThisScanner
 
Methods inherited from class org.htmlparser.nodes.AbstractNode
clone, doSemanticAction, getChildren, getEndPosition, getFirstChild, getLastChild, getNextSibling, getPage, getParent, getPreviousSibling, getStartPosition, setChildren, setEndPosition, setPage, setParent, setStartPosition, toHtml
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.htmlparser.Node
clone, doSemanticAction, getChildren, getEndPosition, getFirstChild, getLastChild, getNextSibling, getPage, getParent, getPreviousSibling, getStartPosition, setChildren, setEndPosition, setPage, setParent, setStartPosition, toHtml
 

Field Detail

POST

public static final String POST
The "POST" method.

See Also:
getFormMethod(), Constant Field Values

GET

public static final String GET
The "GET" method.

See Also:
getFormMethod(), Constant Field Values

mFormLocation

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

Constructor Detail

FormTag

public FormTag()
Create a new form tag.

Method Detail

getIds

public String[] getIds()
Return the set of names handled by this tag.

Specified by:
getIds in interface Tag
Overrides:
getIds in class TagNode
Returns:
The names to be matched that create tags of this type.

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 class TagNode
Returns:
The names of following tags that stop further scanning.

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 class TagNode
Returns:
The names of following end tags that stop further scanning.

getFormInputs

public NodeList getFormInputs()
Get the list of input fields.

Returns:
Input elements in the form.

getFormTextareas

public NodeList getFormTextareas()
Get the list of text areas.

Returns:
Textarea elements in the form.

getFormLocation

public String getFormLocation()
Get the value of the action attribute.

Returns:
The submit url of the form.

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

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).

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

getFormName

public String getFormName()
Get the value of the name attribute.

Returns:
String The name of the form

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.

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 class CompositeTag
Returns:
A textual representation of the form tag.

extractFormLocn

public String extractFormLocn()
Extract the ACTION attribute as an absolute URL.

Returns:
The URL the form is to be submitted to.

© 2005 Derrick Oswald
Jun 10, 2006

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