goog.Disposable | |
goog.events.EventTarget | goog.Disposable |
goog.ui.IdleTimer | goog.events.EventTarget |
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.
|
![]()
Transitions from the idle state to the active state
|
code » | ||
![]()
Transitions from the active state to the idle state
|
code » | ||
![]()
No description.
|
code » | ||
No description.
Returns: goog.ui.ActivityMonitor
the activity monitor keeping track of user
interaction.
|
code » | ||
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 » | ||
No description.
Returns: number
the amount of time at which we consider the user has gone
idle in ms.
|
code » | ||
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 » | ||
![]()
Removes the reference to the default activity monitor. If there are no more
references then the default activity monitor gets disposed.
|
code » | ||
![]()
Checks whether the user is active. If the user is still active, then a timer
is started to check again later.
|
code » | ||
![]()
Handler for the timeout used for checking ongoing activity
|
code » | ||
![]()
Handler for idle timer events when the user does something interactive
Arguments:
|
code » | ||
![]()
Removes the activity listener, if necessary
|
code » |
![]()
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:
|
code » | |||||
![]()
Asserts that the event target instance is initialized properly.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
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 » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
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 » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
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:
|
code » | |||||
![]()
Sets the parent of this event target to use for capture/bubble
mechanism.
Arguments:
|
code » | |||||
![]()
Sets the target to be used for
event.target when firing
event. Mainly used for testing. For example, see
goog.testing.events.mixinListenable .
Arguments:
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » |
![]()
Invokes a callback function when this object is disposed. Callbacks are
invoked in the order in which they were added.
Arguments:
|
code » | |||
![]()
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 » | |||
![]()
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 » | |||
Use
#isDisposed instead.
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
![]()
Associates a disposable object with this object so that they will be disposed
together.
Arguments:
|
code » |
The activity monitor keeping track of user interaction
|
Code » | |
![]()
Cached onActivityTick_ bound to the object for later use
|
Code » | |
![]()
No description.
|
Code » | |
![]()
Whether a listener is currently registered for an idle timer event. On
initialization, the user is assumed to be active.
|
Code » | |
![]()
The amount of time in ms at which we consider the user has gone idle
|
Code » | |
![]()
Whether the user is currently idle
|
Code » | |
![]()
Handle to the timer ID used for checking ongoing activity, or null
|
Code » |
The object to use for event.target. Useful when mixing in an
EventTarget to another object.
|
Code » | |
![]()
No description.
|
Code » | |
Maps of event type to an array of listeners.
|
Code » | |
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 » |
The idle timers that currently reference the default activity monitor
|
Code » | |
The default activity monitor created by this class, if any
|
Code » | |
![]()
No description.
|
Code » |
![]()
Event constants for the idle timer event target
Constants:
|
Code » |