com.threerings.gwt.util

Class WindowUtil

java.lang.Object

com.threerings.gwt.util.WindowUtil

public class WindowUtil
extends Object

Utility methods related to the JavaScript "window".

Constructor Summary

Constructors

Constructor and Description
WindowUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,String>	getQueryParams() Returns the query parameters tacked onto our URL as a mapping from key to value.
static int	getScrollIntoView(Widget target) Returns the vertical scroll position needed to place the specified target widget in view, while trying to minimize scrolling.
static int	getScrollToMiddle(Widget target) Returns the vertical scroll position needed to center the target widget vertically in the browser viewport.
static boolean	isFullyScrolledIntoView(Widget target) Returns true if the target widget is fully vertically visible.
static boolean	isScrolledIntoView(Widget target) Returns true if the target widget is at least partially scrolled into view.
static boolean	isScrolledIntoView(Widget target, int minPixels) Returns true if the target widget is vertically scrolled into view.
static void	scrollIntoView(Widget target) Scrolls the window to place the specified target widget in view, while trying to minimize scrolling.
static void	scrollTo(Widget target) Scrolls the window to place the specified target widget at the top (or as close as possible given the height of the browser).
static void	scrollToMiddle(Widget target) Centers the target widget vertically in the browser viewport.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowUtil

public WindowUtil()

Method Detail

getQueryParams

public static Map<String,String> getQueryParams()

Returns the query parameters tacked onto our URL as a mapping from key to value. Parameters that have no value will be mapped to "true". For example: ?foo=bar&biff=baz&boink will be returned in a map with { foo -> bar, biff -> baz, boink -> true }.

scrollTo

public static void scrollTo(Widget target)

Scrolls the window to place the specified target widget at the top (or as close as possible given the height of the browser).

getScrollIntoView

public static int getScrollIntoView(Widget target)

Returns the vertical scroll position needed to place the specified target widget in view, while trying to minimize scrolling.

scrollIntoView

public static void scrollIntoView(Widget target)

Scrolls the window to place the specified target widget in view, while trying to minimize scrolling.

getScrollToMiddle

public static int getScrollToMiddle(Widget target)

Returns the vertical scroll position needed to center the target widget vertically in the browser viewport. If the widget is taller than the viewport, its top is returned.

scrollToMiddle

public static void scrollToMiddle(Widget target)

Centers the target widget vertically in the browser viewport. If the widget is taller than the viewport, its top is aligned with the top of the viewport.

isScrolledIntoView

public static boolean isScrolledIntoView(Widget target)

Returns true if the target widget is at least partially scrolled into view. At least 10 pixels of the widget must be visible.

isScrolledIntoView

public static boolean isScrolledIntoView(Widget target,
                         int minPixels)

Returns true if the target widget is vertically scrolled into view.

Parameters:

minPixels - the minimum number of pixels that must be visible to count as "in view".

isFullyScrolledIntoView

public static boolean isFullyScrolledIntoView(Widget target)

Returns true if the target widget is fully vertically visible. This will always return false if the widget is taller than the window viewport, so don't call this in a feedback loop in a misdirected attempt to scroll the widget into view.