• index
• goog
• db
• search: Go

The goog.db.Cursor Class

goog.db.Cursor
> goog.events.EventTarget
> goog.Disposable

goog.db.Cursor()

Creates a new IDBCursor wrapper object. Should not be created directly, access cursor through object store.

@see

goog.db.ObjectStore#openCursor

The goog.db.Cursor.Direction Enum

Possible cursor directions. … more

The goog.db.Cursor.EventType Enum

Event types that the cursor can dispatch. COMPLETE events are dispatched when a cursor is depleted of values, a NEW_DATA event if there is new data availible, and ERROR if an error occurred. … more

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

.getKey()

returns {*}

The key for the value at the cursor's position. If the cursor is outside its range, this is undefined.

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

.getValue()

returns {Object}

The value for the value at the cursor's position. Undefined if no current value, or null if value has just been deleted.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.next(opt_key)

Advances the cursor to the next position along its direction. When new data is availible, the NEW_DATA event will be fired. If the cursor has reached the end of the range it will fire the COMPLETE event. If opt_key is specified it will advance to the key it matches in its direction. This wraps the native #continue method on the underlying object.

opt_key {!Object=}

The optional key to advance to.

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

.remove()

Deletes the value at the cursor's position, without changing the cursor's position. Once the value is deleted, the cursor's value is set to null.

returns {!goog.async.Deferred}

The resulting deferred request.

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

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

.update(value)

Updates the value at the current position of the cursor in the object store. If the cursor points to a value that has just been deleted, a new value is created.

value {!Object}

The value to be stored.

returns {!goog.async.Deferred}

The resulting deferred request.

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