org.htmlparser.tags

Class FrameSetTag

java.lang.Object

org.htmlparser.nodes.AbstractNode

org.htmlparser.nodes.TagNode

org.htmlparser.tags.CompositeTag

org.htmlparser.tags.FrameSetTag

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Node, Tag

public class FrameSetTag
extends CompositeTag

Identifies an frame set tag.

See Also:

Serialized Form

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

Constructors

Constructor and Description
FrameSetTag() Create a new frame set tag.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEndTagEnders() Return the set of end tag names that cause this tag to finish.
FrameTag	getFrame(java.lang.String name) Gets a frame by name.
FrameTag	getFrame(java.lang.String name, java.util.Locale locale) Gets a frame by name.
NodeList	getFrames() Returns the frames.
java.lang.String[]	getIds() Return the set of names handled by this tag.
void	setFrames(NodeList frames) Sets the frames (children of this tag).
java.lang.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

Methods inherited from class org.htmlparser.nodes.TagNode

breaksFlow, getAttribute, getAttributeEx, getAttributes, getAttributesEx, getEnders, getEndingLineNumber, getParsed, getRawTagName, getStartingLineNumber, getTagBegin, getTagEnd, getTagName, getThisScanner, isEmptyXmlTag, isEndTag, removeAttribute, setAttribute, setAttribute, setAttribute, setAttributeEx, setAttributes, setAttributesEx, setEmptyXmlTag, setTagBegin, setTagEnd, setTagName, setText, setThisScanner

Methods inherited from class org.htmlparser.nodes.AbstractNode

clone, doSemanticAction, getChildren, getEndPosition, getPage, getParent, getStartPosition, setChildren, setEndPosition, setPage, setParent, setStartPosition

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, getPage, getParent, getStartPosition, setChildren, setEndPosition, setPage, setParent, setStartPosition

Constructor Detail

FrameSetTag

public FrameSetTag()

Create a new frame set tag.

Method Detail

getIds

public java.lang.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.

getEndTagEnders

public java.lang.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.

toString

public java.lang.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 class CompositeTag

Returns:

A string with this tag's contents.

getFrames

public NodeList getFrames()

Returns the frames.

Returns:

The children of this tag.

getFrame

public FrameTag getFrame(java.lang.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(java.lang.String name,
                         java.util.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.

setFrames

public void setFrames(NodeList frames)

Sets the frames (children of this tag).

Parameters:

frames - The frames to set