JsIDBIndex (GWT Elemental 2.8.0)

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - elemental.js.util.JsElementalBase
  - - elemental.js.dom.JsElementalMixinBase
    - - elemental.js.html.JsIDBIndex

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, IDBIndex, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber
```
public class JsIDBIndex
extends JsElementalMixinBase
implements IDBIndex
```

Field Summary
- Fields inherited from interface elemental.svg.SVGZoomAndPan
  SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors
Modifier Constructor and Description

protected JsIDBIndex()

Constructors
Modifier	Constructor and Description
`protected`	`JsIDBIndex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsIDBRequest`	`count()` Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.
`JsIDBRequest`	`count(IDBKeyRange range)` Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.
`JsIDBRequest`	`count(Object key)` Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range.
`JsIDBRequest`	`get(IDBKeyRange key)` Returns an IDBRequest object, and, in a separate thread, finds either:
`JsIDBRequest`	`getKey(IDBKeyRange key)` Returns an IDBRequest object, and, in a separate thread, finds either:
`JsIDBRequest`	`getKey(Object key)` Returns an IDBRequest object, and, in a separate thread, finds either:
`Object`	`getKeyPath()`
`String`	`getName()`
`JsIDBRequest`	`getObject(Object key)`
`JsIDBObjectStore`	`getObjectStore()`
`boolean`	`isMultiEntry()`
`boolean`	`isUnique()`
`JsIDBRequest`	`openCursor()` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(IDBKeyRange range)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(IDBKeyRange range, int direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(IDBKeyRange range, String direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(Object key)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(Object key, int direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openCursor(Object key, String direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range.
`JsIDBRequest`	`openKeyCursor()` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(IDBKeyRange range)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(IDBKeyRange range, int direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(IDBKeyRange range, String direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(Object key)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(Object key, int direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.
`JsIDBRequest`	`openKeyCursor(Object key, String direction)` Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index.

Methods inherited from class elemental.js.dom.JsElementalMixinBase
addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase
at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt
intAt, length

Methods inherited from interface elemental.util.IndexableNumber
numberAt

Constructor Detail
- JsIDBIndex
```
protected JsIDBIndex()
```

Method Detail

getKeyPath
```
public final Object getKeyPath()
```
Specified by:

getKeyPath in interface IDBIndex

isMultiEntry
```
public final boolean isMultiEntry()
```
Specified by:

isMultiEntry in interface IDBIndex

getName
```
public final String getName()
```
Specified by:

getName in interface IDBIndex

getObjectStore
```
public final JsIDBObjectStore getObjectStore()
```
Specified by:

getObjectStore in interface IDBIndex

isUnique
```
public final boolean isUnique()
```
Specified by:

isUnique in interface IDBIndex

count
```
public final JsIDBRequest count()
```
Description copied from interface: IDBIndex
Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range. For example, if you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following: var req = store.count(IDBKeyRange.bound(1000, 2000));
```
IDBRequest count (
  in optional any key
) raises (IDBDatabaseException);
```
Parameters

key

The key or key range that identifies the record to be counted.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise a IDBDatabaseException with the following code:

Attribute Description

DATA_ERR The key parameter was not a valid value.

NOT_ALLOWED_ERR The request was made on a source object that has been deleted or removed.
Specified by:

count in interface IDBIndex

Attribute	Description
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

count
```
public final JsIDBRequest count(IDBKeyRange range)
```
Description copied from interface: IDBIndex
Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range. For example, if you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following: var req = store.count(IDBKeyRange.bound(1000, 2000));
```
IDBRequest count (
  in optional any key
) raises (IDBDatabaseException);
```
Parameters

key

The key or key range that identifies the record to be counted.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise a IDBDatabaseException with the following code:

Attribute Description

DATA_ERR The key parameter was not a valid value.

NOT_ALLOWED_ERR The request was made on a source object that has been deleted or removed.
Specified by:

count in interface IDBIndex

Attribute	Description
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

count
```
public final JsIDBRequest count(Object key)
```
Description copied from interface: IDBIndex
Returns an IDBRequest object, and in a separate thread, returns the number of records within a key range. For example, if you want to see how many records are between keys 1000 and 2000 in an object store, you can write the following: var req = store.count(IDBKeyRange.bound(1000, 2000));
```
IDBRequest count (
  in optional any key
) raises (IDBDatabaseException);
```
Parameters

key

The key or key range that identifies the record to be counted.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise a IDBDatabaseException with the following code:

Attribute Description

DATA_ERR The key parameter was not a valid value.

NOT_ALLOWED_ERR The request was made on a source object that has been deleted or removed.
Specified by:

count in interface IDBIndex

Attribute	Description
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

get

public final JsIDBRequest get(IDBKeyRange key)

Description copied from interface: IDBIndex

Returns an IDBRequest object, and, in a separate thread, finds either:

The value in the referenced object store that corresponds to the given key.
The first corresponding value, if key is a key range.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

Note: This method produces the same result for: a) a record that doesn't exist in the database and b) a record that has an undefined value. To tell these situations apart, call the openCursor() method with the same key. That method provides a cursor if the record exists, and not if it does not.

IDBRequest get (
  in any key
) raises (IDBDatabaseException);

Parameters

key: The key or key range that identifies the record to be retrieved.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: get in interface IDBIndex

getObject

public final JsIDBRequest getObject(Object key)

Specified by:: getObject in interface IDBIndex

getKey

public final JsIDBRequest getKey(IDBKeyRange key)

Description copied from interface: IDBIndex

Returns an IDBRequest object, and, in a separate thread, finds either:

The value in the index that corresponds to the given key
The first corresponding value, if key is a key range.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

IDBRequest getKey (
  in any key
) raises (IDBDatabaseException);

Parameters

key: The key or key range that identifies the record to be retrieved.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise a IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: getKey in interface IDBIndex

getKey

public final JsIDBRequest getKey(Object key)

Description copied from interface: IDBIndex

Returns an IDBRequest object, and, in a separate thread, finds either:

The value in the index that corresponds to the given key
The first corresponding value, if key is a key range.

If a value is successfully found, then a structured clone of it is created and set as the result of the request object.

IDBRequest getKey (
  in any key
) raises (IDBDatabaseException);

Parameters

key: The key or key range that identifies the record to be retrieved.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise a IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: getKey in interface IDBIndex

openCursor

public final JsIDBRequest openCursor()

Description copied from interface: IDBIndex

Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range. The method sets the position of the cursor to the appropriate record, based on the specified direction.

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(IDBKeyRange range)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(IDBKeyRange range,
                                     String direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(Object key)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(Object key,
                                     String direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(IDBKeyRange range,
                                     int direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openCursor

public final JsIDBRequest openCursor(Object key,
                                     int direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to a structured clone of the referenced value.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor()

Description copied from interface: IDBIndex

Returns an IDBRequest object, and, in a separate thread, creates a cursor over the specified key range, as arranged by this index. The method sets the position of the cursor to the appropriate record, based on the specified direction.

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(IDBKeyRange range)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(IDBKeyRange range,
                                        String direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(Object key)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(Object key,
                                        String direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(IDBKeyRange range,
                                        int direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

openKeyCursor

public final JsIDBRequest openKeyCursor(Object key,
                                        int direction)

Description copied from interface: IDBIndex

If the key range is not specified or is null, then the range includes all the records.
If at least one record matches the key range, then a success event is fired on the result object, with its result set to the new IDBCursor object; the value of the cursor object is set to the value of the found record.
If no records match the key range, then then an error event is fired on the request object, with its code set to NOT_FOUND_ERR and a suitable message.

IDBRequest openKeyCursor (
  in optional any? range, 
  in optional unsigned short direction
) raises (IDBDatabaseException);

Parameters

range: Optional. The key range to use as the cursor's range.
direction: Optional. The cursor's required direction. See IDBCursor Constants for possible values.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Attribute	Description
`TRANSACTION_INACTIVE_ERR`	The index's transaction is not active.
`DATA_ERR`	The `key` parameter was not a valid value.
`NOT_ALLOWED_ERR`	The request was made on a source object that has been deleted or removed.

Specified by:: openKeyCursor in interface IDBIndex

Class JsIDBIndex

Field Summary

Fields inherited from interface elemental.svg.SVGZoomAndPan

Constructor Summary

Method Summary

Methods inherited from class elemental.js.dom.JsElementalMixinBase

Methods inherited from class elemental.js.util.JsElementalBase

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

Methods inherited from class java.lang.Object

Methods inherited from interface elemental.util.IndexableInt

Methods inherited from interface elemental.util.IndexableNumber

Constructor Detail

JsIDBIndex

Method Detail

getKeyPath

isMultiEntry

getName

getObjectStore

isUnique

count

Parameters

Returns

Exceptions

count

Parameters

Returns

Exceptions

count

Parameters

Returns

Exceptions

get

Parameters

Returns

Exceptions

getObject

getKey

Parameters

Returns

Exceptions

getKey

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openCursor

Parameters

Returns

Exceptions

openKeyCursor

Parameters

Returns

Exceptions

openKeyCursor

Parameters

Returns

Exceptions