com.gargoylesoftware.htmlunit.javascript.host

Class Window

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Window

All Implemented Interfaces:

ScriptableWithFallbackGetter, Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class Window
extends SimpleScriptable
implements ScriptableWithFallbackGetter

A JavaScript object for a Window.

Version:

$Revision: 2155 $

Author:

Mike Bowler, Chen Jun, David K. Taylor, Christian Sell, Darrell DeBoer, Marc Guillemot, Dierk Koenig, Daniel Gredler, David D. Kilzer, Chris Erskine, Ahmed Ashour

See Also:

MSDN documentation, Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
Window(JavaScriptEngine scriptEngine) Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
Object	custom_eval(String scriptCode) Executes the specified script code in the scope of this window.
Object	get(String name, org.mozilla.javascript.Scriptable start) Get a named property from the object.
JavaScriptEngine	getJavaScriptEngine() Gets the Javascript Engine responsible for this object.
org.mozilla.javascript.Scriptable	getPrototype(Class jsClass) Returns the prototype object corresponding to the specified HtmlUnit class inside the window scope.
WebWindow	getWebWindow() Return the WebWindow associated with this Window
Object	getWithFallback(String name) Looks at attributes with the given name Fallback called when no configured property is found with the given name on the Scriptable object.
void	initialize() Initialize the object.
void	initialize(Page enclosedPage) Initialize the object.
void	initialize(WebWindow webWindow) Initialize the object.
void	jsxFunction_addEventListener(String type, org.mozilla.javascript.Function listener, boolean useCapture) Allows the registration of event listeners on the event target
void	jsxFunction_alert(Object message) The javascript function "alert()"
boolean	jsxFunction_attachEvent(String type, org.mozilla.javascript.Function listener) Allows the registration of event listeners on the event target
void	jsxFunction_blur() Remove focus from this element
void	jsxFunction_captureEvents(String type) Does nothing special anymore...
void	jsxFunction_clearInterval(int intervalID) Cancels the interval previously started using the setInterval method.
void	jsxFunction_clearTimeout(int timeoutId) Cancels a time-out previously set with the setTimeout method.
void	jsxFunction_close() Close this window
boolean	jsxFunction_confirm(String message) The javascript function "confirm()"
static Popup	jsxFunction_createPopup(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scriptable, Object[] args, org.mozilla.javascript.Function function) Creates a popup window Open a new window
void	jsxFunction_detachEvent(String type, org.mozilla.javascript.Function listener) Allows the removal of event listeners on the event target
Object	jsxFunction_execScript(String script, String language) Executes the specified script code as long as the laguage is JavaScript or JScript.
void	jsxFunction_focus() Set the focus to this element.
Object	jsxFunction_getComputedStyle(Node element, String pseudoElt) Returns computed style of the element.
void	jsxFunction_moveBy(int x, int y) Does nothing.
void	jsxFunction_moveTo(int x, int y) Does nothing.
static Object	jsxFunction_open(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scriptable, Object[] args, org.mozilla.javascript.Function function) Opens a new window.
void	jsxFunction_print() Prints the current page.
String	jsxFunction_prompt(String message) The javascript function "prompt()"
void	jsxFunction_removeEventListener(String type, org.mozilla.javascript.Function listener, boolean useCapture) Allows the removal of event listeners on the event target
void	jsxFunction_resizeBy(int width, int height) Does nothing.
void	jsxFunction_resizeTo(int width, int height) Does nothing.
void	jsxFunction_scroll(int x, int y) Does nothing.
void	jsxFunction_scrollBy(int x, int y) Does nothing.
void	jsxFunction_scrollByLines(int lines) Does nothing.
void	jsxFunction_scrollByPages(int pages) Does nothing.
void	jsxFunction_scrollTo(int x, int y) Does nothing.
static int	jsxFunction_setInterval(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scriptable, Object[] args, org.mozilla.javascript.Function function) Set a chunk of javascript to be invoked each time a specified number of milliseconds has elapsed Current implementation does nothing.
static int	jsxFunction_setTimeout(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scriptable, Object[] args, org.mozilla.javascript.Function function) Set a chunk of javascript to be invoked at some specified time later.
boolean	jsxGet_closed() Indicates if this window is closed
Document	jsxGet_document() Return the javascript property "document"
Object	jsxGet_event() Return the current event
Object	jsxGet_frameElement() Return the (i)frame in which the window is contained.
HTMLCollection	jsxGet_frames() Return the value of the frames property.
History	jsxGet_history() Return the "history" property
int	jsxGet_innerHeight() Return the innerHeight.
int	jsxGet_innerWidth() Return the innerWidth.
Location	jsxGet_location() Return the location property
String	jsxGet_name() Return the value of the name property
Navigator	jsxGet_navigator() Return the javascript property "navigator"
Object	jsxGet_onclick() Return the onclick property (caution this is not necessary a function if something else has been set)
Object	jsxGet_ondblclick() Return the ondblclick property (caution this is not necessary a function if something else has been set)
String	jsxGet_onerror() Return the value of the onerror property
Object	jsxGet_onload() Return the onload property (caution this is not necessary a function if something else has been set)
Object	jsxGet_opener() Return the value of the opener property.
int	jsxGet_outerHeight() Return the outer height.
int	jsxGet_outerWidth() Return the outerWidth.
SimpleScriptable	jsxGet_parent() Return the value of the parent property
Screen	jsxGet_screen() Return the "screen" property
Window	jsxGet_self() Return the "self" property
String	jsxGet_status() Return the text from the status line.
SimpleScriptable	jsxGet_top() Return the value of the top property
Window	jsxGet_window() Return the window property.
void	jsxSet_location(String newLocation) Set the location property.
void	jsxSet_name(String newName) Set the value of the newName property
void	jsxSet_onclick(Object newOnload) Set the value of the onclick event handler.
void	jsxSet_ondblclick(Object newHandler) Set the value of the ondblclick event handler.
void	jsxSet_onerror(String newValue) Set the value of the onerror property
void	jsxSet_onload(Object newOnload) Set the value of the onload event handler.
void	jsxSet_status(String message) Set the text from the status line.
void	setEvent(Object event) Sets the current event
void	setPrototypes(Map map) Sets the prototypes for HtmlUnit host classes

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, makeScriptableFor, setDomNode, setDomNode, setHtmlElement

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.Scriptable

delete, delete, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, has, hasInstance, put, put, setParentScope, setPrototype

Constructor Detail

Window

public Window(JavaScriptEngine scriptEngine)

Creates an instance.

Parameters:

scriptEngine - The JavaScript engine responsible for the new window instance.

Method Detail

getJavaScriptEngine

public JavaScriptEngine getJavaScriptEngine()

Gets the Javascript Engine responsible for this object.

Returns:

the javascript engine

getPrototype

public org.mozilla.javascript.Scriptable getPrototype(Class jsClass)

Returns the prototype object corresponding to the specified HtmlUnit class inside the window scope.

Overrides:

getPrototype in class SimpleScriptable

Parameters:

jsClass - the class whose prototype is to be returned

Returns:

the prototype object corresponding to the specified class inside the specified scope

setPrototypes

public void setPrototypes(Map map)

Sets the prototypes for HtmlUnit host classes

Parameters:

map - a Map of (Class, Scriptable)

jsxFunction_alert

public void jsxFunction_alert(Object message)

The javascript function "alert()"

Parameters:

message - The message

jsxFunction_confirm

public boolean jsxFunction_confirm(String message)

The javascript function "confirm()"

Parameters:

message - The message

Returns:

true if ok was pressed, false if cancel was pressed

jsxFunction_prompt

public String jsxFunction_prompt(String message)

The javascript function "prompt()"

Parameters:

message - The message

Returns:

true if ok was pressed, false if cancel was pressed

jsxGet_document

public Document jsxGet_document()

Return the javascript property "document"

Returns:

The document

jsxGet_event

public Object jsxGet_event()

Return the current event

Returns:

null if no event is currently available

setEvent

public void setEvent(Object event)

Sets the current event

Parameters:

event - the event

jsxFunction_open

public static Object jsxFunction_open(org.mozilla.javascript.Context context,
                      org.mozilla.javascript.Scriptable scriptable,
                      Object[] args,
                      org.mozilla.javascript.Function function)

Opens a new window.

Parameters:

context - The javascript Context

scriptable - The object that the function was called on.

args - The arguments passed to the function.

function - The function object that was invoked.

Returns:

the newly opened window, or null if popup windows have been disabled

See Also:

WebClient.isPopupBlockerEnabled()

jsxFunction_createPopup

public static Popup jsxFunction_createPopup(org.mozilla.javascript.Context context,
                            org.mozilla.javascript.Scriptable scriptable,
                            Object[] args,
                            org.mozilla.javascript.Function function)

Creates a popup window Open a new window

Parameters:

context - The javascript Context

scriptable - The object that the function was called on.

args - The arguments passed to the function.

function - The function object that was invoked.

Returns:

The created popup

See Also:

MSDN documentation

jsxFunction_setTimeout

public static int jsxFunction_setTimeout(org.mozilla.javascript.Context context,
                         org.mozilla.javascript.Scriptable scriptable,
                         Object[] args,
                         org.mozilla.javascript.Function function)

Set a chunk of javascript to be invoked at some specified time later. The invocation occurs only if the window is opened after the delay and does not contain an other page than the one that originated the setTimeout. JavaScript param 1: The code to execute, either a String or a Function. JavaScript param 2: the delay in milliseconds to wait before executing the code.

Parameters:

context - The javascript Context

scriptable - The object that the function was called on.

args - The arguments passed to the function.

function - The function object that was invoked.

Returns:

the id of the created timer

jsxFunction_clearTimeout

public void jsxFunction_clearTimeout(int timeoutId)

Cancels a time-out previously set with the setTimeout method.

Parameters:

timeoutId - identifier for the timeout to clear (returned by setTimeout)

jsxGet_navigator

public Navigator jsxGet_navigator()

Return the javascript property "navigator"

Returns:

The document

jsxGet_window

public Window jsxGet_window()

Return the window property. This is a synonym for "self"

Returns:

A reference to this

jsxGet_self

public Window jsxGet_self()

Return the "self" property

Returns:

this

jsxGet_location

public Location jsxGet_location()

Return the location property

Returns:

The location property

jsxSet_location

public void jsxSet_location(String newLocation)
                     throws IOException

Set the location property. This will cause a reload of the window.

Parameters:

newLocation - The url of the new content.

Throws:

IOException - when location loading fails

jsxGet_screen

public Screen jsxGet_screen()

Return the "screen" property

Returns:

the screen property

jsxGet_history

public History jsxGet_history()

Return the "history" property

Returns:

the "history" property

initialize

public void initialize(WebWindow webWindow)
                throws Exception

Initialize the object.

Parameters:

webWindow - The web window containing the javascript.

Throws:

Exception - If an error occurs.

initialize

public void initialize(Page enclosedPage)

Initialize the object.

Parameters:

enclosedPage - The page containing the javascript.

initialize

public void initialize()

Initialize the object. Only call for Windows with no contents.

jsxGet_top

public SimpleScriptable jsxGet_top()

Return the value of the top property

Returns:

The value of "top"

jsxGet_parent

public SimpleScriptable jsxGet_parent()

Return the value of the parent property

Returns:

the value of window.parent

jsxGet_opener

public Object jsxGet_opener()

Return the value of the opener property.

Returns:

the value of window.opener, null for a top level window

jsxGet_frameElement

public Object jsxGet_frameElement()

Return the (i)frame in which the window is contained.

Returns:

null for a top level window

jsxGet_frames

public HTMLCollection jsxGet_frames()

Return the value of the frames property.

Returns:

The live collection of frames

getWebWindow

public WebWindow getWebWindow()

Return the WebWindow associated with this Window

Returns:

The WebWindow

jsxFunction_focus

public void jsxFunction_focus()

Set the focus to this element.

jsxFunction_blur

public void jsxFunction_blur()

Remove focus from this element

jsxFunction_close

public void jsxFunction_close()

Close this window

jsxGet_closed

public boolean jsxGet_closed()

Indicates if this window is closed

Returns:

true if this window is closed

jsxFunction_moveTo

public void jsxFunction_moveTo(int x,
                      int y)

Does nothing.

Parameters:

x - The horizontal position

y - The vertical position

jsxFunction_moveBy

public void jsxFunction_moveBy(int x,
                      int y)

Does nothing.

Parameters:

x - The horizontal position

y - The vertical position

jsxFunction_resizeBy

public void jsxFunction_resizeBy(int width,
                        int height)

Does nothing.

Parameters:

width - The width offset

height - The height offset.

jsxFunction_resizeTo

public void jsxFunction_resizeTo(int width,
                        int height)

Does nothing.

Parameters:

width - The width of the Window in pixel after resize.

height - The height of the Window in pixel after resize.

jsxFunction_scroll

public void jsxFunction_scroll(int x,
                      int y)

Does nothing.

Parameters:

x - The horizontal position to scroll to

y - The vertical position to scroll to

jsxFunction_scrollBy

public void jsxFunction_scrollBy(int x,
                        int y)

Does nothing.

Parameters:

x - The horizontal distance to scroll by

y - The vertical distance to scroll by

jsxFunction_scrollByLines

public void jsxFunction_scrollByLines(int lines)

Does nothing.

Parameters:

lines - The number of lines to scroll down

jsxFunction_scrollByPages

public void jsxFunction_scrollByPages(int pages)

Does nothing.

Parameters:

pages - The number of pages to scroll down

jsxFunction_scrollTo

public void jsxFunction_scrollTo(int x,
                        int y)

Does nothing.

Parameters:

x - The horizontal position to scroll to

y - The vertical position to scroll to

jsxSet_onload

public void jsxSet_onload(Object newOnload)

Set the value of the onload event handler.

Parameters:

newOnload - The new handler

jsxSet_onclick

public void jsxSet_onclick(Object newOnload)

Set the value of the onclick event handler.

Parameters:

newOnload - The new handler

jsxGet_onclick

public Object jsxGet_onclick()

Return the onclick property (caution this is not necessary a function if something else has been set)

Returns:

the onclick property

jsxSet_ondblclick

public void jsxSet_ondblclick(Object newHandler)

Set the value of the ondblclick event handler.

Parameters:

newHandler - The new handler

jsxGet_ondblclick

public Object jsxGet_ondblclick()

Return the ondblclick property (caution this is not necessary a function if something else has been set)

Returns:

the ondblclick property

jsxGet_onload

public Object jsxGet_onload()

Return the onload property (caution this is not necessary a function if something else has been set)

Returns:

the onload property

jsxFunction_attachEvent

public boolean jsxFunction_attachEvent(String type,
                              org.mozilla.javascript.Function listener)

Allows the registration of event listeners on the event target

Parameters:

type - the event type to listen for (like "load")

listener - the event listener

Returns:

true if the listener has been added

See Also:

MSDN documentation

jsxFunction_addEventListener

public void jsxFunction_addEventListener(String type,
                                org.mozilla.javascript.Function listener,
                                boolean useCapture)

Allows the registration of event listeners on the event target

Parameters:

type - the event type to listen for (like "onload")

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture (not yet implemented)

See Also:

Mozilla documentation

jsxFunction_detachEvent

public void jsxFunction_detachEvent(String type,
                           org.mozilla.javascript.Function listener)

Allows the removal of event listeners on the event target

Parameters:

type - the event type to listen for (like "onload")

listener - the event listener

See Also:

MSDN documentation

jsxFunction_removeEventListener

public void jsxFunction_removeEventListener(String type,
                                   org.mozilla.javascript.Function listener,
                                   boolean useCapture)

Allows the removal of event listeners on the event target

Parameters:

type - the event type to listen for (like "load")

listener - the event listener

useCapture - If true, indicates that the user wishes to initiate capture (not yet implemented)

See Also:

Mozilla documentation

jsxGet_name

public String jsxGet_name()

Return the value of the name property

Returns:

The window name

jsxSet_name

public void jsxSet_name(String newName)

Set the value of the newName property

Parameters:

newName - The new window name

jsxGet_onerror

public String jsxGet_onerror()

Return the value of the onerror property

Returns:

The value

jsxSet_onerror

public void jsxSet_onerror(String newValue)

Set the value of the onerror property

Parameters:

newValue - The value

getWithFallback

public Object getWithFallback(String name)

Looks at attributes with the given name Fallback called when no configured property is found with the given name on the Scriptable object.

Specified by:

getWithFallback in interface ScriptableWithFallbackGetter

Parameters:

name - the name of the requested property

Returns:

the object value, Scriptable.NOT_FOUND if nothing is found

get

public Object get(String name,
         org.mozilla.javascript.Scriptable start)

Get a named property from the object. Normally HtmlUnit objects don't need to overwrite this method as properties are defined on the prototypes from the xml configuration. In some cases where "content" of object has priority compared to the properties consider using utility SimpleScriptable.getWithPreemption(String). For fallback case just implement ScriptableWithFallbackGetter.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class SimpleScriptable

jsxFunction_execScript

public Object jsxFunction_execScript(String script,
                            String language)

Executes the specified script code as long as the laguage is JavaScript or JScript. Does nothing if the language specified is VBScript.

Parameters:

script - the script code to execute

language - the language of the specified code ("JavaScript", "JScript" or "VBScript")

Returns:

this method always returns null, like Internet Explorer

See Also:

MSDN documentation

custom_eval

public Object custom_eval(String scriptCode)

Executes the specified script code in the scope of this window. This is used only when eval() is called on a Window other than the starting scope

Parameters:

scriptCode - some javascript code

Returns:

the evaluation result

jsxGet_status

public String jsxGet_status()

Return the text from the status line.

Returns:

the status line text

jsxSet_status

public void jsxSet_status(String message)

Set the text from the status line.

Parameters:

message - the status line text

jsxFunction_setInterval

public static int jsxFunction_setInterval(org.mozilla.javascript.Context context,
                          org.mozilla.javascript.Scriptable scriptable,
                          Object[] args,
                          org.mozilla.javascript.Function function)

Set a chunk of javascript to be invoked each time a specified number of milliseconds has elapsed Current implementation does nothing. JavaScript param 1: The code to execute, either a String or a Function. JavaScript param 2: the delay in milliseconds to wait before executing the code.

Parameters:

context - The javascript Context

scriptable - The object that the function was called on.

args - The arguments passed to the function.

function - The function object that was invoked.

Returns:

the id of the created interval

See Also:

MSDN documentation

jsxFunction_clearInterval

public void jsxFunction_clearInterval(int intervalID)

Cancels the interval previously started using the setInterval method. Current implementation does nothing.

Parameters:

intervalID - specifies the interval to cancel as returned by the setInterval method.

See Also:

MSDN documentation

jsxGet_innerWidth

public int jsxGet_innerWidth()

Return the innerWidth.

Returns:

a dummy value

See Also:

Mozilla doc

jsxGet_outerWidth

public int jsxGet_outerWidth()

Return the outerWidth.

Returns:

a dummy value

See Also:

Mozilla doc

jsxGet_innerHeight

public int jsxGet_innerHeight()

Return the innerHeight.

Returns:

a dummy value

See Also:

Mozilla doc

jsxGet_outerHeight

public int jsxGet_outerHeight()

Return the outer height.

Returns:

a dummy value

See Also:

Mozilla doc

jsxFunction_print

public void jsxFunction_print()

Prints the current page. The current implementation does nothing.

See Also:

Mozilla documentation, MSDN documentation

jsxFunction_captureEvents

public void jsxFunction_captureEvents(String type)

Does nothing special anymore... just like FF.

Parameters:

type - the type of events

jsxFunction_getComputedStyle

public Object jsxFunction_getComputedStyle(Node element,
                                  String pseudoElt)

Returns computed style of the element. Computed style represents the final computed values of all CSS properties for the element. This method's return value is of the same type as that of element.style, but the value returned by this method is read-only.

Parameters:

element - the element

pseudoElt - is a string specifying the pseudo-element to match, can be null.

Returns:

the computed style.