db.Cursor Extends goog.events.EventTarget
Creates a new IDBCursor wrapper object. Should not be created directly, access cursor through object store.

Inheritance

Constructor

goog.db.Cursor()

Instance Methods

Public Protected Private
Defined in goog.db.Cursor
getKey() IDBKeyType
No description.
Returns: IDBKeyType  The key for the value at the cursor's position. If the cursor is outside its range, this is undefined.
code »
getValue() *
No description.
Returns: *  The value for the value at the cursor's position. Undefined if no current value, or null if value has just been deleted.
code »
next(opt_key)
Advances the cursor to the next position along its direction. When new data is available, 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.
Arguments:
opt_key : IDBKeyType=
The optional key to advance to.
code »
remove() !goog.async.Deferred
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.
code »
update(value) !goog.async.Deferred
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.
Arguments:
value : *
The value to be stored.
Returns: !goog.async.Deferred  The resulting deferred request.
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

Defined in goog.db.Cursor
constructor :
No description.
Code »
cursor_ :
Underlying IndexedDB cursor object.
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 Methods

goog.db.Cursor.openCursor(sourceopt_rangeopt_direction) !goog.db.Cursor
Opens a value cursor from IDBObjectStore or IDBIndex over the specified key range. Returns a cursor object which is able to iterate over the given range.
Arguments:
source : !(IDBObjectStore | IDBIndex)
Data source to open cursor.
opt_range : !goog.db.KeyRange=
The key range. If undefined iterates over the whole data source.
opt_direction : !goog.db.Cursor.Direction=
The direction. If undefined moves in a forward direction with duplicates.
Returns: !goog.db.Cursor  The cursor.
code »

Static Properties

goog.db.Cursor.superClass_ :
No description.
Code »

Enumerations

goog.db.Cursor.Direction :
Possible cursor directions.
Constants:
NEXT
No description.
NEXT_NO_DUPLICATE
No description.
PREV
No description.
PREV_NO_DUPLICATE
No description.
Code »
goog.db.Cursor.EventType :
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 available, and ERROR if an error occurred.
Constants:
COMPLETE
No description.
ERROR
No description.
NEW_DATA
No description.
Code »

Package db

Package Reference