Class: PagingTableDataSource

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

QuickNav

Fields

PagingTableDataSource extends oj.TableDataSource

Version:
  • 5.0.0
Since:
  • 1.0
Module:
  • ojpagingtabledatasource
Object representing data that supports paging functionality. This data source can be used by ListView, PagingControl, and Table.

This class implements the oj.PagingModel interface and publish all of the oj.PagingModel event types, which can be listened to using the on() method.

See the Paging Control - Paging Table demo for an example.

Refer to oj.TableDataSource for other data sources that represent tabular data.

Constructor

new PagingTableDataSource(dataSource, options)

Parameters:
Name Type Description
dataSource Object
options Object | null Options for the PagingTableDataSource. No option is currently supported.

Fields

(static) EventType :string

Properties:
Name Type Default Description
ADD string add Triggered when a Row is added to a PagingDataSource
REMOVE string remove Triggered when a Row is removed from a PagingDataSource
RESET string reset Triggered when a PagingDataSource is reset
SYNC string sync Triggered when a PagingDataSource has been updated by a fetch
REFRESH string refresh Triggered when a PagingDataSource has been refreshed
SORT string sort Triggered when a PagingDataSource has been sorted
CHANGE string change Triggered when a Row's attributes have been changed
REQUEST string request Triggered when a PagingDataSource has sent a fetch request.
ERROR string error Triggered when an error occurred on the PagingDataSource

sortCriteria :Object

The sort criteria. Whenever sort() is called with the criteria parameter, that value is copied to this property. If sort() is called with empty sort criteria then the criteria set in this property is used.
Properties:
Name Type Description
criteria.key * The key that identifies which field to sort
criteria.direction 'ascending' | 'descending' | 'none' the sort direction, valid values are "ascending", "descending", "none" (default)
Inherited From:

Methods

at(index, options) → {Promise}

Return the row data found at the given index.
Parameters:
Name Type Argument Description
index number Index for which to return the row data.
options Object <optional>
Options to control the at.
Properties
Name Type Description
fetchSize number fetch size to use if the call needs to fetch more records from the server, if virtualized. Overrides the overall fetchSize setting

Returns:
Promise resolves to a compound object which has the structure below. If the index is out of range, Promise resolves to null.

dataThe raw row data
indexThe index for the row
keyThe key value for the row

Type
Promise

fetch(options) → {Promise}

Fetch the row data.
Parameters:
Name Type Argument Description
options Object <optional>
Options to control fetch
Properties
Name Type Description
startIndex number The index at which to start fetching records.
silent boolean If set, do not fire a sync event.
Returns:
Promise object resolves to a compound object which contains an array of row data objects, an array of ids, and the startIndex triggering done when complete.

The structure of the resolved compound object is:

dataAn array of raw row data
keysAn array of key values for the rows
startIndexThe startIndex for the returned set of rows

Type
Promise

get(id, options) → {Promise}

Return the first row data whose id value is the given id
Parameters:
Name Type Argument Description
id string ID for which to return the row data, if found.
options Object <optional>
Options to control the get.
Returns:
Promise which resolves to a compound object which has the structure below where the id matches the given id. If none are found, resolves to null.

dataThe raw row data
indexThe index for the row
keyThe key value for the row

Type
Promise

getCapability(feature) → {string|null}

Determines whether this TableDataSource supports certain feature.
Parameters:
Name Type Description
feature string the feature in which its capabilities is inquired. Currently the only valid feature is "sort".
Returns:
the name of the feature. For "sort", the valid return values are: "full", "none". Returns null if the feature is not recognized.
Type
string | null

getEndItemIndex() → {number}

Get the current page end index. If there are no rows in the current page then return -1.
Returns:
The current page end index
Type
number

getPage() → {number}

Get the current page
Returns:
The current page
Type
number

getPageCount() → {number}

Get the page count
Returns:
The total number of pages
Type
number

getStartItemIndex() → {number}

Get the current page start index
Returns:
The current page start index
Type
number

getWrappedDataSource() → {Object}

Retrieves the underlying DataSource.
Returns:
the underlying oj.DataSource.
Type
Object

handleEvent(eventType, event) → {boolean}

Handle the event
Parameters:
Name Type Description
eventType string event type
event Object event
Inherited From:
Returns:
Returns false if event is cancelled
Type
boolean

Init() → {undefined}

Initializes the instance.
Inherited From:
Returns:
Type
undefined

off(eventType, eventHandler) → {void}

Detach an event handler from the datasource
Parameters:
Name Type Description
eventType string eventType supported by the datasource
eventHandler function(Object) event handler function
Returns:
Type
void

on(eventType, eventHandler) → {void}

Attach an event handler to the datasource
Parameters:
Name Type Description
eventType string eventType supported by the datasource.

In addition to this class's event types, it can also be one of the oj.PagingModel event types.

eventHandler function(Object) event handler function
Returns:
Type
void

setPage(value, options) → {Promise}

Set the current page
Parameters:
Name Type Argument Description
value number The current page
options Object <optional>
Options

pageSize: The page size.

Returns:
promise object triggering done when complete..
Type
Promise

sort(criteria) → {Promise}

Performs a sort on the data source.
Parameters:
Name Type Description
criteria Object the sort criteria.
Properties
Name Type Description
key Object The key that identifies which field to sort
direction string the sort direction, valid values are "ascending", "descending", "none" (default)
Returns:
promise object triggering done when complete.
Type
Promise

totalSize() → {number}

Return the total size of data available, including server side if not local.
Returns:
total size of data
Type
number

totalSizeConfidence() → {string}

Returns the confidence for the totalSize value.
Returns:
"actual" if the totalSize is the time of the fetch is an exact number "estimate" if the totalSize is an estimate "atLeast" if the totalSize is at least a certain number "unknown" if the totalSize is unknown
Type
string