Class CollectionCursor
Extends
baja.Cursor.
Cursor for a Collection.
Defined in: coll.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| <inner> |
| Method Attributes | Method Name and Description |
|---|---|
|
after(func)
When the cursor is iterated, the before function will be called
just after iteration has finished.
|
|
|
before(func)
When the cursor is iterated, the before function will be called
just before iteration starts.
|
|
|
each(func)
Iterate through the Cursor and call 'each' for every item.
|
|
|
get()
Return the current row.
|
|
|
Return the underlying Cursor's Collection.
|
Method Detail
after(func)
When the cursor is iterated, the before function will be called
just after iteration has finished.
When the function is called, 'this' refers to the Cursor. The Cursor is also passed in as a argument to this function.
- Parameters:
- {Function} func
- the before function.
before(func)
When the cursor is iterated, the before function will be called
just before iteration starts.
When the function is called, 'this' refers to the Cursor. The Cursor is also passed in as a argument to this function.
- Parameters:
- {Function} func
- the before function.
each(func)
Iterate through the Cursor and call 'each' for every item.
When the function is called, 'this' refers to the Cursor.
- Parameters:
- {Function} func
- function called on every iteration with the current row used as the argument.
get()
Return the current row.
- Returns:
- the cursor value (null if none available)
{baja.coll.BoxCollection}
getCollection()
Return the underlying Cursor's Collection.
- Returns:
- {baja.coll.BoxCollection}