• index
• goog
• dom
• search: Go

The goog.dom.ViewportSizeMonitor Class

goog.dom.ViewportSizeMonitor
> goog.events.EventTarget
> goog.Disposable

goog.dom.ViewportSizeMonitor(opt_window)

This class can be used to monitor changes in the viewport size. Instances dispatch a {@link goog.events.EventType.RESIZE} event when the viewport size changes. Handlers can call {@link goog.dom.ViewportSizeMonitor#getSize} to get the new viewport size. Use this class if you want to execute resize/reflow logic each time the user resizes the browser window. This class is guaranteed to only dispatch {@code RESIZE} events when the pixel dimensions of the viewport change. (Internet Explorer fires resize events if any element on the page is resized, even if the viewport dimensions are unchanged, which can lead to infinite resize loops.) Example usage:

    var vsm = new goog.dom.ViewportSizeMonitor();
    goog.events.listen(vsm, goog.events.EventType.RESIZE, function(e) {
      alert('Viewport size changed to ' + vsm.getSize());
    });
  

opt_window {Window=}

The window to monitor; defaults to the window in which this code is executing.

.WINDOW_SIZE_POLL_RATE {number}

Rate in milliseconds at which to poll the window size on browsers that need polling.

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.getInstanceForWindow(opt_window)

Returns a viewport size monitor for the given window. A new one is created if it doesn't exist already. This prevents the unnecessary creation of multiple spooling monitors for a window.

opt_window {Window=}

The window to monitor; defaults to the window in which this code is executing.

returns {goog.dom.ViewportSizeMonitor}

Monitor for the given window.

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.getSize()

Returns the most recently recorded size of the viewport, in pixels. May return null if no window resize event has been handled yet.

returns {goog.math.Size}

The viewport dimensions, in pixels.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.removeInstanceForWindow(opt_window)

Removes and disposes a viewport size monitor for the given window if one exists.

opt_window {Window=}

The window whose monitor should be removed; defaults to the window in which this code is executing.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.