org.htmlparser.tags

Class FrameSetTag

Implemented Interfaces:
Cloneable, Node, Serializable, Tag

public class FrameSetTag
extends CompositeTag

Identifies an frame set tag.

Field Summary

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

FrameSetTag()
Create a new frame set tag.

Method Summary

String[]
getEndTagEnders()
Return the set of end tag names that cause this tag to finish.
FrameTag
getFrame(String name)
Gets a frame by name.
FrameTag
getFrame(String name, Locale locale)
Gets a frame by name.
NodeList
getFrames()
Returns the frames.
String[]
getIds()
Return the set of names handled by this tag.
void
setFrames(NodeList frames)
Sets the frames (children of this tag).
String
toString()
Return a string representation of the contents of this FRAMESET 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

Constructor Details

FrameSetTag

public FrameSetTag()
Create a new frame set tag.

Method Details

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.

getFrame

public FrameTag getFrame(String name)
Gets a frame by name. Names are checked without case sensitivity and conversion to uppercase is performed with an English locale.
Parameters:
name - The name of the frame to retrieve.
Returns:
The specified frame or null if it wasn't found.

getFrame

public FrameTag getFrame(String name,
                         Locale locale)
Gets a frame by name. Names are checked without case sensitivity and conversion to uppercase is performed with the locale provided.
Parameters:
name - The name of the frame to retrieve.
locale - The locale to use when converting to uppercase.
Returns:
The specified frame or null if it wasn't found.

getFrames

public NodeList getFrames()
Returns the frames.
Returns:
The children of this tag.

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.

setFrames

public void setFrames(NodeList frames)
Sets the frames (children of this tag).
Parameters:
frames - The frames to set

toString

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

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