com.gargoylesoftware.htmlunit.html
Class BaseFrame

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          com.gargoylesoftware.htmlunit.html.HtmlElement
              com.gargoylesoftware.htmlunit.html.StyledElement
                  com.gargoylesoftware.htmlunit.html.BaseFrame

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

HtmlFrame, HtmlInlineFrame

public abstract class BaseFrame
extends StyledElement

Base class for frame and iframe.

Version:

$Revision: 1.3 $

Author:

Mike Bowler, David K. Taylor, Christian Sell, Marc Guillemot, David D. Kilzer, Stefan Anzinger, Ahmed Ashour

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

HtmlElement.MapEntryWrappingIterator

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Method Summary

Page	getEnclosedPage() Return the currently loaded page in the enclosed window.
WebWindow	getEnclosedWindow() Gets the window enclosed in this frame.
java.lang.String	getFrameBorderAttribute() Return the value of the attribute "frameborder".
java.lang.String	getLongDescAttribute() Return the value of the attribute "longdesc".
java.lang.String	getMarginHeightAttribute() Return the value of the attribute "marginheight".
java.lang.String	getMarginWidthAttribute() Return the value of the attribute "marginwidth".
java.lang.String	getNameAttribute() Return the value of the attribute "name".
java.lang.String	getNoResizeAttribute() Return the value of the attribute "noresize".
java.lang.String	getOnLoadAttribute() Return the value of the attribute "onload".
java.lang.String	getScrollingAttribute() Return the value of the attribute "scrolling".
java.lang.String	getSrcAttribute() Return the value of the attribute "src".
void	setNameAttribute(java.lang.String name) Set the value of the "name" attribute.
void	setSrcAttribute(java.lang.String attribute) Set the value of the "src" attribute.

Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement

getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

addHtmlAttributeChangeListener, appendChildIfNoneExists, cloneDomNode, fireEvent, fireEvent, getAttributeEntriesIterator, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTagName, hasHtmlElementWithId, isAttributeDefined, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeValue, setEventHandler, setEventHandler, setId, toString

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addDomChangeListener, appendDomChild, asText, asXml, getAllHtmlChildElements, getByXPath, getChildIterator, getEndColumnNumber, getEndLineNumber, getFirstDomChild, getLastDomChild, getNextDomSibling, getNodeValue, getPage, getParentDomNode, getPreviousDomSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, remove, removeAllChildren, removeDomChangeListener, replace, setNodeValue, setReadyState, setScriptObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getEnclosedPage

public Page getEnclosedPage()

Return the currently loaded page in the enclosed window. This is a facility method for getEnclosedWindow().getEnclosedPage().

Returns:

The currently loaded page in the enclosed window or null if no page has been loaded.

See Also:

WebWindow.getEnclosedPage()

getEnclosedWindow

public WebWindow getEnclosedWindow()

Gets the window enclosed in this frame.

Returns:

the window

getFrameBorderAttribute

public final java.lang.String getFrameBorderAttribute()

Return the value of the attribute "frameborder". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "frameborder" or an empty string if that attribute isn't defined.

getLongDescAttribute

public final java.lang.String getLongDescAttribute()

Return the value of the attribute "longdesc". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "longdesc" or an empty string if that attribute isn't defined.

getMarginHeightAttribute

public final java.lang.String getMarginHeightAttribute()

Return the value of the attribute "marginheight". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "marginheight" or an empty string if that attribute isn't defined.

getMarginWidthAttribute

public final java.lang.String getMarginWidthAttribute()

Return the value of the attribute "marginwidth". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "marginwidth" or an empty string if that attribute isn't defined.

getNameAttribute

public final java.lang.String getNameAttribute()

Return the value of the attribute "name". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "name" or an empty string if that attribute isn't defined.

getNoResizeAttribute

public final java.lang.String getNoResizeAttribute()

Return the value of the attribute "noresize". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "noresize" or an empty string if that attribute isn't defined.

getOnLoadAttribute

public final java.lang.String getOnLoadAttribute()

Return the value of the attribute "onload". This attribute is not actually supported by the HTML specification however it is supported by the popular browsers.

Returns:

The value of the attribute "onload" or an empty string if that attribute isn't defined.

getScrollingAttribute

public final java.lang.String getScrollingAttribute()

Return the value of the attribute "scrolling". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "scrolling" or an empty string if that attribute isn't defined.

getSrcAttribute

public final java.lang.String getSrcAttribute()

Return the value of the attribute "src". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

The value of the attribute "src" or an empty string if that attribute isn't defined.

setNameAttribute

public final void setNameAttribute(java.lang.String name)

Set the value of the "name" attribute.

Parameters:

name - The new window name.

setSrcAttribute

public final void setSrcAttribute(java.lang.String attribute)

Set the value of the "src" attribute. Also load the frame with the specified url if possible.

Parameters:

attribute - The new value