D0301
HTML Application SDK  A0.101
Classes | Public Member Functions | Public Attributes | List of all members
Window Interface Reference

import"ApplicationManagerPlugin.idl";

Classes

interface  message
 

Public Member Functions

void activate ()
 
void addEventListener ([in] String event_name, [in] EventListener listener)
 
void bringToFront ()
 
void deactivate ()
 
void hide ()
 
void loadUrl ([in] String uri)
 
void moveAbove ([in] Window reference_window)
 
void moveBelow ([in] Window reference_window)
 
void postMessage ([in] String msg, [in] Window target_window)
 
void removeEventListener ([in] String event_name, [in] EventListener listener)
 
void removeEventListener ([in] String event_name)
 
void sendToBack ()
 
void show ()
 

Public Attributes

readonly attribute Boolean active
 
attribute Integer event_dispatch_priority
 
readonly attribute KeySet keySet
 
readonly attribute String name
 
readonly attribute String url
 
readonly attribute Boolean visible
 

Detailed Description

This is a class that implements global Window object.

Member Function Documentation

void Window.activate ( )

Make the window active.

testWindow.activate();
void Window.addEventListener ( [in] String  event_name,
[in] EventListener  listener 
)

Adds DOM2 event listener for specified event.

Possible values are: event_name: "message", listener: function that has arguments similar to the message interface properties.

Parameters
event_nameName of the event.
listenerjavascript function that has arguments like the properties listed in the listener's interface.
void Window.bringToFront ( )

Move the window to the front of the z-order.

1  var csp_win = ApplicationManager.getWindowByName("DEFAULT_CSP");
2  csp_win.bringToFront();
3  csp_win.activate();
void Window.deactivate ( )

Make the window deactivate.

testWindow.deactivate();
void Window.hide ( )

Make the window invisible.

testWindow.hide();
void Window.loadUrl ( [in] String  uri)

Load a webpage or application from the specified URL.

var relativePath = "windowTest.html";
var url = convertUrl(relativePath);
testWindow.loadUrl(url);
Parameters
uriUrl to load.
void Window.moveAbove ( [in] Window  reference_window)

Places a window above another window in the window stack.

1  var move_above_win = ApplicationManager.getWindowByName("DEFAULT_CSP");
2  var ref_win = ApplicationManager.getWindowByName("loadUrl_win");
3  move_above_win.moveAbove(ref_win);
Parameters
reference_windowThe handle of the reference window.
void Window.moveBelow ( [in] Window  reference_window)

Places a window below another window in the window stack.

var moveBelowWin = ApplicationManager.getWindowByName("DEFAULT_CSP");
var refWin = ApplicationManager.getWindowByName("loadUrl_win");
moveBelowWin.moveBelow(refWin);
Parameters
reference_windowThe handle of the reference window.
void Window.postMessage ( [in] String  msg,
[in] Window  target_window 
)

Post message to the listener which is a Window instance.

Parameters
msgMessage that is sent to target window.
target_windowTarget window
void Window.removeEventListener ( [in] String  event_name,
[in] EventListener  listener 
)

Removes single DOM2 event listener for specified event

Possible values are: event_name: "message", listener: function that has arguments similar to the message interface properties.

Parameters
event_nameName of the event
listenernamed javascript function that has arguments like the properties listed in the listener's interface.
void Window.removeEventListener ( [in] String  event_name)

Removes all DOM2 event listeners for specified event

Parameters
event_nameName of the event
See also
removeEventListener([in] String event_name, [in] EventListener listener);
void Window.sendToBack ( )

Move the window to the back of the z-order.

var defaultCsp = ApplicationManager.getWindowByName("DEFAULT_CSP");
defaultCsp.sendToBack();
void Window.show ( )

Make the window visible.

testWindow.show();

Member Data Documentation

readonly attribute Boolean Window.active

The active status

attribute Integer Window.event_dispatch_priority

The event dispatch priority of the window. It must be in the range of [0, 100].

readonly attribute KeySet Window.keySet

The object representing the user input events sent to the DAE application.

readonly attribute String Window.name

Name of the window

readonly attribute String Window.url

Current url loaded in the window

readonly attribute Boolean Window.visible

The visibility of the window


The documentation for this interface was generated from the following file: