com.gargoylesoftware.htmlunit.html
Class FrameWindow

java.lang.Object
  com.gargoylesoftware.htmlunit.WebWindowImpl
      com.gargoylesoftware.htmlunit.html.FrameWindow

All Implemented Interfaces:

WebWindow

public class FrameWindow
extends WebWindowImpl

The web window for a frame or iframe.

Version:

$Revision: 1.3 $

Author:

Brad Clarke

Method Summary

HtmlPage	getEnclosingPage() Return the html page in which the <frame> or <iframe> tag is contained for this frame window.
BaseFrame	getFrameElement() Gets the DOM node of the (i)frame containing this window.
java.lang.String	getName() Return the name of this window. A FrameWindow shares it's name with it's containing frame.
WebWindow	getParentWindow() Return the window that contains this window.
WebWindow	getTopWindow() Return the top level window that contains this window.
void	setName(java.lang.String name) Set the name of this window. A FrameWindow shares it's name with it's containing frame.
java.lang.String	toString() Gives a basic representation for debugging purposes

Methods inherited from class com.gargoylesoftware.htmlunit.WebWindowImpl

addChildWindow, getEnclosedPage, getScriptObject, getThreadManager, getWebClient, setEnclosedPage, setScriptObject

Methods inherited from class java.lang.Object

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

Method Detail

getEnclosingPage

public HtmlPage getEnclosingPage()

Return the html page in which the <frame> or <iframe> tag is contained for this frame window. This is a facility method for (HtmlPage) (getParentWindow().getEnclosedPage()).

Returns:

the page in the parent window.

getFrameElement

public BaseFrame getFrameElement()

Gets the DOM node of the (i)frame containing this window.

Returns:

the dom node

getName

public java.lang.String getName()

Return the name of this window. A FrameWindow shares it's name with it's containing frame.

Specified by:

getName in interface WebWindow

Overrides:

getName in class WebWindowImpl

Returns:

The name of this window.

getParentWindow

public WebWindow getParentWindow()

Return the window that contains this window. If this is a top level window, then return this window.

Returns:

The parent window or this window if there is no parent.

getTopWindow

public WebWindow getTopWindow()

Return the top level window that contains this window. If this is a top level window, then return this window.

Returns:

The top level window that contains this window or this window if there is no parent.

setName

public void setName(java.lang.String name)

Set the name of this window. A FrameWindow shares it's name with it's containing frame.

Specified by:

setName in interface WebWindow

Overrides:

setName in class WebWindowImpl

Parameters:

name - The new window name.

toString

public java.lang.String toString()

Gives a basic representation for debugging purposes

Overrides:

toString in class java.lang.Object

Returns:

a basic representation