org.htmlunit.html

Class FrameWindow

java.lang.Object

org.htmlunit.WebWindowImpl

org.htmlunit.html.FrameWindow

All Implemented Interfaces:

Serializable, WebWindow

public class FrameWindow
extends WebWindowImpl

The web window for a frame or iframe.

Author:

Brad Clarke, Ahmed Ashour, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FrameWindow.PageDenied The different deny states.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this frame window.
HtmlPage	getEnclosingPage() Returns the HTML page in which the <frame> or <iframe> tag is contained for this frame window.
BaseFrameElement	getFrameElement() Gets the DOM node of the (i)frame containing this window.
String	getName() Returns the name of this window.
FrameWindow.PageDenied	getPageDenied()
WebWindow	getParentWindow() Returns the window that contains this window.
WebWindow	getTopWindow() Returns the top level window that contains this window.
protected boolean	isJavaScriptInitializationNeeded(Page page) Returns true if this window needs JavaScript initialization to occur when the enclosed page is set.
void	setEnclosedPage(Page page) Sets the currently loaded page.
void	setName(String name) Sets the name of this window.
void	setPageDenied(FrameWindow.PageDenied pageDenied) Marks that the page content as denied.
String	toString() Gives a basic representation for debugging purposes.

Methods inherited from class org.htmlunit.WebWindowImpl

addChildWindow, destroyChildren, getComputedStyle, getEnclosedPage, getHistory, getInnerHeight, getInnerWidth, getJobManager, getOuterHeight, getOuterWidth, getScreen, getScriptableObject, getWebClient, isClosed, performRegistration, removeChildWindow, setClosed, setInnerHeight, setInnerWidth, setJobManager, setOuterHeight, setOuterWidth, setScriptableObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Returns 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

setName

public void setName(String name)

Sets 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

getParentWindow

public WebWindow getParentWindow()

Returns 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()

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

isJavaScriptInitializationNeeded

protected boolean isJavaScriptInitializationNeeded(Page page)

Returns true if this window needs JavaScript initialization to occur when the enclosed page is set.

Specified by:

isJavaScriptInitializationNeeded in class WebWindowImpl

Parameters:

page - the page that will become the enclosing page

Returns:

true if this window needs JavaScript initialization to occur when the enclosed page is set

getEnclosingPage

public HtmlPage getEnclosingPage()

Returns 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

setEnclosedPage

public void setEnclosedPage(Page page)

Sets the currently loaded page.

Specified by:

setEnclosedPage in interface WebWindow

Overrides:

setEnclosedPage in class WebWindowImpl

Parameters:

page - the new page or null if there is no page (ie empty window)

getFrameElement

public BaseFrameElement getFrameElement()

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

Returns:

the DOM node

toString

public String toString()

Gives a basic representation for debugging purposes.

Overrides:

toString in class Object

Returns:

a basic representation

close

public void close()

Closes this frame window.

setPageDenied

public void setPageDenied(FrameWindow.PageDenied pageDenied)

Marks that the page content as denied.

Parameters:

pageDenied - the new state

getPageDenied

public FrameWindow.PageDenied getPageDenied()

Returns:

PageDenied if the page was denied