• index
• goog
• ui
• search: Go

The goog.ui.ActivityMonitor Class

goog.ui.ActivityMonitor
> goog.events.EventTarget
> goog.Disposable

goog.ui.ActivityMonitor(opt_domHelper, opt_useBubble)

Once initialized with a document, the activity monitor can be queried for the current idle time.

opt_domHelper {goog.dom.DomHelper|Array.<goog.dom.DomHelper>=}

DomHelper which contains the document(s) to listen to. If null, the default document is usedinstead.

opt_useBubble {boolean=}

Whether to use the bubble phase to listen for events. By default listens on the capture phase so that it won't miss events that get stopPropagation/cancelBubble'd. However, this can cause problems in IE8 if the page loads multiple scripts that include the closure event handling code.

The goog.ui.ActivityMonitor.Event Enum

Event constants for the activity monitor. … more

.MIN_EVENT_SPACING {number}

Minimum amount of time in ms between throttled ACTIVITY events

.addDocument(doc)

Adds a document to those being monitored by this class.

doc {Document}

Document to monitor.

.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
};

.getIdleTime(opt_now)

Returns the amount of time the user has been idle.

opt_now {number=}

The current time can optionally be passed in for the computation to avoid an extra Date allocation.

returns {number}

The amount of time in ms that the user has been idle.

.getLastEventTime()

Returns the time of the last event

returns {number}

last event time.

.getLastEventType()

Returns the type of the last user event.

returns {string}

event type.

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

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

.removeDocument(doc)

Removes a document from those being monitored by this class.

doc {Document}

Document to monitor.

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

.resetTimer()

Updates the last event time to be the present time, useful for non-DOM events that should update idle time.

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