Interface: IndexerModel

Oracle® JavaScript Extension Toolkit (JET)
2.0.0

E70325-01

QuickNav

Fields

oj. IndexerModel

Version:
  • 2.0.0
The interface for oj.IndexerModel which should be implemented by all object instances bound to the data parameter for ojIndexer. oj.IndexerModel implementations should also support event subscription by extending oj.EventSource or oj.DataSource.
Source:

Fields

<static> EventType :string

Properties:
Name Type Default Description
CHANGE string change Triggered when the underlying model has changed.
Source:

.PREFIX_OTHERS

Constant for the prefix that represents all non-letters including numbers and symbols.
Source:

Methods

#getIndexablePrefixes() → {Array.<string>}

Returns the prefixes displayed by the Indexer. For example, the alphabets of a particular language.
Source:
Returns:
an array of prefixes
Type
Array.<string>

#getPrefixes() → {Array.<string>}

Returns the prefixes that are currently available. When associated with a ListView, these prefixes are the ones that have a corresponding group header. Note that this set is based on the group headers that are currently fetched so it might not be complete.
Source:
Returns:
an array of prefixes that are available.
Type
Array.<string>

#setPrefix(prefix) → {Promise}

Sets the current prefix. When associated with a ListView, this will scroll the ListView to the corresponding group header.
Parameters:
Name Type Description
prefix String the current prefix
Source:
Returns:
a Promise object which when resolve will return the prefix that the IndexerModel actually sets as current.
Type
Promise