ui.IdleTimer Extends goog.events.EventTarget
Event target that will give notification of state changes between active and idle. This class is designed to require few resources while the user is active.

Inheritance

Constructor

goog.ui.IdleTimer(idleThresholdopt_activityMonitor)

Parameters

idleThreshold : number
Amount of time in ms at which we consider the user has gone idle.
opt_activityMonitor : goog.ui.ActivityMonitor=
The activity monitor keeping track of user interaction. Defaults to a default-constructed activity monitor. If a default activity monitor is used then this class will dispose of it. If an activity monitor is passed in then the caller remains responsible for disposing of it.

Instance Methods

Public Protected Private
becomeActive_()
Transitions from the idle state to the active state
code »
becomeIdle_()
Transitions from the active state to the idle state
code »
disposeInternal()
No description.
code »
getActivityMonitor() goog.ui.ActivityMonitor
No description.
Returns: goog.ui.ActivityMonitor  the activity monitor keeping track of user interaction.
code »
getDefaultActivityMonitor_() !goog.ui.ActivityMonitor
Gets the default activity monitor used by this class. If a default has not been created yet, then a new one will be created.
Returns: !goog.ui.ActivityMonitor  The default activity monitor.
code »
getIdleThreshold() number
No description.
Returns: number  the amount of time at which we consider the user has gone idle in ms.
code »
isIdle() boolean
Returns true if there has been no user action for at least the specified interval, and false otherwise
Returns: boolean  true if the user is idle, false otherwise.
code »
maybeDisposeDefaultActivityMonitor_()
Removes the reference to the default activity monitor. If there are no more references then the default activity monitor gets disposed.
code »
maybeStillActive_()
Checks whether the user is active. If the user is still active, then a timer is started to check again later.
code »
onActivityTick_()
Handler for the timeout used for checking ongoing activity
code »
onActivity_(e)
Handler for idle timer events when the user does something interactive
Arguments:
e : goog.events.Event
The event object.
code »
removeActivityListener_()
Removes the activity listener, if necessary
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

activityMonitor_ : goog.ui.ActivityMonitor
The activity monitor keeping track of user interaction
Code »
boundOnActivityTick_ :
Cached onActivityTick_ bound to the object for later use
Code »
constructor :
No description.
Code »
hasActivityListener_ :
Whether a listener is currently registered for an idle timer event. On initialization, the user is assumed to be active.
Code »
idleThreshold_ :
The amount of time in ms at which we consider the user has gone idle
Code »
isIdle_ :
Whether the user is currently idle
Code »
onActivityTimerId_ :
Handle to the timer ID used for checking ongoing activity, or null
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.IdleTimer.defaultActivityMonitorReferences_ : goog.structs.Set
The idle timers that currently reference the default activity monitor
Code »
goog.ui.IdleTimer.defaultActivityMonitor_ : goog.ui.ActivityMonitor
The default activity monitor created by this class, if any
Code »
goog.ui.IdleTimer.superClass_ :
No description.
Code »

Enumerations

goog.ui.IdleTimer.Event :
Event constants for the idle timer event target
Constants:
BECOME_ACTIVE
No description.
BECOME_IDLE
No description.
Code »

Package ui

Package Reference