Package com.google.gwt.user.client

Class Window

java.lang.Object
com.google.gwt.user.client.Window
public class Window extends Object
This class provides access to the browser window's methods, properties, and events.

  • Field Details

    • handlers

      static com.google.gwt.user.client.Window.WindowHandlers handlers

  • Method Details

    • addCloseHandler

      @Deprecated public static HandlerRegistration addCloseHandler(CloseHandler<Window> handler)
      Deprecated.
      This method requires the use of the unload browser event, which is deprecated in all browsers.
      Adds a CloseEvent handler.
      Parameters:
      handler - the handler
      Returns:
      returns the handler registration

    • addResizeHandler

      public static HandlerRegistration addResizeHandler(ResizeHandler handler)
      Adds a ResizeEvent handler.
      Parameters:
      handler - the handler
      Returns:
      returns the handler registration

    • addWindowCloseListener

      @Deprecated public static void addWindowCloseListener(WindowCloseListener listener)
      Deprecated.
      use addWindowClosingHandler(ClosingHandler) and addCloseHandler(CloseHandler) instead
      Adds a listener to receive window closing events.
      Parameters:
      listener - the listener to be informed when the window is closing

    • addWindowClosingHandler

      public static HandlerRegistration addWindowClosingHandler(Window.ClosingHandler handler)
      Adds a Window.ClosingEvent handler.
      Parameters:
      handler - the handler
      Returns:
      returns the handler registration

    • addWindowResizeListener

      @Deprecated public static void addWindowResizeListener(WindowResizeListener listener)
      Deprecated.
      use addResizeHandler(ResizeHandler) instead
      Adds a listener to receive window resize events.
      Parameters:
      listener - the listener to be informed when the window is resized

    • addWindowScrollHandler

      public static HandlerRegistration addWindowScrollHandler(Window.ScrollHandler handler)
      Adds a Window.ScrollEvent handler.
      Parameters:
      handler - the handler
      Returns:
      returns the handler registration

    • addWindowScrollListener

      @Deprecated public static void addWindowScrollListener(WindowScrollListener listener)
      Deprecated.
      use addWindowScrollHandler(ScrollHandler) instead
      Adds a listener to receive window scroll events.
      Parameters:
      listener - the listener to be informed when the window is scrolled

    • alert

      public static void alert(String msg)
      Displays a message in a modal dialog box.
      Parameters:
      msg - the message to be displayed.

    • confirm

      public static boolean confirm(String msg)
      Displays a message in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.
      Parameters:
      msg - the message to be displayed.
      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 excluding the scroll bar.
      Returns:
      the window's client height

    • getClientWidth

      public static int getClientWidth()
      Gets the width of the browser window's client area excluding the vertical scroll bar.
      Returns:
      the window's client width

    • getScrollLeft

      public static int getScrollLeft()
      Gets the window's scroll left.
      Returns:
      window's scroll left

    • getScrollTop

      public static int getScrollTop()
      Get the window's scroll top.
      Returns:
      the window's scroll top

    • getTitle

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

    • moveBy

      public static void moveBy(int dx, int dy)
      Moves a window's left and top edge to a specified number of pixels relative to its current coordinates.

      NOTE: In Chrome, this method only works with windows created by Window.open().

      Parameters:
      dx - A positive or a negative number that specifies how many pixels to move the left edge by
      dy - A positive or a negative number that specifies how many pixels to move the top edge by

    • moveTo

      public static void moveTo(int x, int y)
      Moves a window's left and top edge to the specified coordinates.

      NOTE: In Chrome, this method only works with windows created by Window.open().

      Parameters:
      x - The left coordinate
      y - The top coordinate

    • 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

    • print

      public static void print()
      Prints the document in the window, as if the user had issued a "Print" command.

    • prompt

      public static String prompt(String msg, String initialValue)
      Displays a request for information in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.
      Parameters:
      msg - the message to be displayed
      initialValue - the initial value in the dialog's text field
      Returns:
      the value entered by the user if 'OK' was pressed, or null if 'Cancel' was pressed

    • removeWindowCloseListener

      @Deprecated public static void removeWindowCloseListener(WindowCloseListener listener)
      Deprecated.
      Removes a window closing listener.
      Parameters:
      listener - the listener to be removed

    • removeWindowResizeListener

      @Deprecated public static void removeWindowResizeListener(WindowResizeListener listener)
      Deprecated.
      Removes a window resize listener.
      Parameters:
      listener - the listener to be removed

    • removeWindowScrollListener

      @Deprecated public static void removeWindowScrollListener(WindowScrollListener listener)
      Deprecated.
      Removes a window scroll listener.
      Parameters:
      listener - the listener to be removed

    • resizeBy

      public static void resizeBy(int width, int height)
      Resizes the window by the specified width and height. This method moves the bottom right corner of the window by the specified number of pixels defined. The top left corner will not be moved (it stays in its original coordinates).

      NOTE: In most modern browsers, this method only works with windows created by Window.open() with a supplied width and height.

      Parameters:
      width - A positive or a negative number that specifies how many pixels to resize the width by
      height - A positive or a negative number that specifies how many pixels to resize the height by

    • resizeTo

      public static void resizeTo(int width, int height)
      Resizes the window to the specified width and height.

      NOTE: In most modern browsers, this method only works with windows created by Window.open() with a supplied width and height.

      Parameters:
      width - The width of the window, in pixels
      height - The height of the window, in pixels

    • scrollTo

      public static void scrollTo(int left, int top)
      Scroll the window to the specified position.
      Parameters:
      left - the left scroll position
      top - the top scroll position

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

    • setStatus

      public static void setStatus(String status)
      Sets the status text for the window, if permitted by the browser's settings.
      Parameters:
      status - the new message to display.

    • setTitle

      public static void setTitle(String title)
      Sets the browser window's title.
      Parameters:
      title - the new window title.

    • onClosed

      static void onClosed()

    • onClosing

      static String onClosing()

    • onResize

      static void onResize()

    • onScroll

      static void onScroll()