com.google.gwt.user.client
Class Window

java.lang.Object
  extended bycom.google.gwt.user.client.Window

public class Window
extends Object

This class provides access to the browser window's methods, properties, and events.


Field Summary
 
Fields inherited from class java.lang.Object
typeId, typeName
 
Constructor Summary
Window()
           
 
Method Summary
static void addWindowCloseListener(WindowCloseListener listener)
          Adds a listener to receive window closing events.
static void addWindowResizeListener(WindowResizeListener listener)
          Adds a listener to receive window resize events.
static void alert(String msg)
          Displays a message in a modal dialog box.
static boolean confirm(String msg)
          Displays a message in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.
static void enableScrolling(boolean enable)
          Use this method to explicitly disable the window's scrollbars.
static int getClientHeight()
          Gets the height of the browser window's client area.
static int getClientWidth()
          Gets the width of the browser window's client area.
 String getTitle()
          Gets the browser window's current title.
static void open(String url, String name, String features)
          Opens a new browser window.
static void removeWindowCloseListener(WindowCloseListener listener)
          Removes a window closing listener.
static void removeWindowResizeListener(WindowResizeListener listener)
          Removes a window resize listener.
static void setMargin(String size)
          Sets the size of the margins used within the window's client area.
 void setTitle(String title)
          Sets the browser window's title.
 
Methods inherited from class java.lang.Object
equals, finalize, hashCode, toString
 

Constructor Detail

Window

public Window()
Method Detail

addWindowCloseListener

public static void addWindowCloseListener(WindowCloseListener listener)
Adds a listener to receive window closing events.

Parameters:
listener - the listener to be informed when the window is closing

addWindowResizeListener

public static void addWindowResizeListener(WindowResizeListener listener)
Adds a listener to receive window resize events.

Parameters:
listener - the listener to be informed when the window is resized

alert

public static void alert(String msg)
Displays a message in a modal dialog box.


confirm

public static boolean confirm(String msg)
Displays a message in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.

Returns:
true if 'OK' is clicked, false if 'Cancel' is clicked.

enableScrolling

public static void enableScrolling(boolean enable)
Use this method to explicitly disable the window's scrollbars. Applications that choose to resize their user-interfaces to fit within the window's client area will normally want to disable window scrolling.

Parameters:
enable - false to disable window scrolling

getClientHeight

public static int getClientHeight()
Gets the height of the browser window's client area.

Returns:
the window's client height

getClientWidth

public static int getClientWidth()
Gets the width of the browser window's client area.

Returns:
the window's client width

open

public static void open(String url,
                        String name,
                        String features)
Opens a new browser window. The "name" and "features" arguments are specified here.

Parameters:
url - the URL that the new window will display
name - the name of the window (e.g. "_blank")
features - the features to be enabled/disabled on this window

removeWindowCloseListener

public static void removeWindowCloseListener(WindowCloseListener listener)
Removes a window closing listener.

Parameters:
listener - the listener to be removed

removeWindowResizeListener

public static void removeWindowResizeListener(WindowResizeListener listener)
Removes a window resize listener.

Parameters:
listener - the listener to be removed

setMargin

public static void setMargin(String size)
Sets the size of the margins used within the window's client area. It is sometimes necessary to do this because some browsers, such as Internet Explorer, add margins by default, which can confound attempts to resize panels to fit exactly within the window.

Parameters:
size - the window's new margin size, in CSS units.

getTitle

public String getTitle()
Gets the browser window's current title.

Returns:
the window's title.

setTitle

public void setTitle(String title)
Sets the browser window's title.

Parameters:
title - the new window title.


This javadoc distribution was not produced by Google. The official documentation is here.