ui.ActivityMonitor Extends goog.events.EventTarget
Once initialized with a document, the activity monitor can be queried for the current idle time.

Inheritance

Constructor

goog.ui.ActivityMonitor(opt_domHelperopt_useBubble)

Parameters

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.

Instance Methods

Public Protected Private
addDocument(doc)
Adds a document to those being monitored by this class.
Arguments:
doc : Document
Document to monitor.
code »
disposeInternal()
No description.
code »
getIdleTime(opt_now) number
Returns the amount of time the user has been idle.
Arguments:
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.
code »
getLastEventTime() number
Returns the time of the last event
Returns: number  last event time.
code »
getLastEventType() string
Returns the type of the last user event.
Returns: string  event type.
code »
handleEvent_(e)
Updates the last event time when a user action occurs.
Arguments:
e : goog.events.BrowserEvent
Event object.
code »
removeDocument(doc)
Removes a document from those being monitored by this class.
Arguments:
doc : Document
Document to monitor.
code »
resetTimer()
Updates the last event time to be the present time, useful for non-DOM events that should update idle time.
code »
updateIdleTime(eventTimeeventType)
Updates the idle time and fires an event if time has elapsed since the last update.
Arguments:
eventTime : number
Time (in MS) of the event that cleared the idle timer.
eventType : string
Type of the event, used only for debugging.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
documents_ :
Array of documents that are being listened to.
Code »
eventHandler_ : goog.events.EventHandler
The event handler.
Code »
isIframe_ :
Whether the current window is an iframe. TODO(user): Move to goog.dom.
Code »
lastEventTime_ :
The time (in milliseconds) of the last user event.
Code »
lastEventType_ :
The last event type that was detected.
Code »
lastMouseX_ :
The mouse x-position after the last user event.
Code »
lastMouseY_ :
The mouse y-position after the last user event.
Code »
minEventTime_ :
The earliest time that another throttled ACTIVITY event will be dispatched
Code »
useBubble_ :
Whether to use the bubble phase to listen for events.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.ui.ActivityMonitor.MIN_EVENT_SPACING :
Minimum amount of time in ms between throttled ACTIVITY events
Code »
goog.ui.ActivityMonitor.superClass_ :
No description.
Code »
goog.ui.ActivityMonitor.userEventTypesBody_ :
If a user executes one of these events, s/he is considered not idle.
Code »
goog.ui.ActivityMonitor.userEventTypesDocuments_ :
If a user executes one of these events, s/he is considered not idle.
Code »
goog.ui.ActivityMonitor.userTouchEventTypesBody_ :
If a user executes one of these events, s/he is considered not idle. Note: monitoring touch events within iframe cause problems in iOS.
Code »

Enumerations

goog.ui.ActivityMonitor.Event :
Event constants for the activity monitor.
Constants:
ACTIVITY
No description.
Code »

Package ui

Package Reference