Module: deliteful/list/PageableList

deliteful/list/PageableList

require(["deliteful/list/PageableList"], function (PageableList) {
  new PageableList();
});

A widget that renders a scrollable list of items and provides paging.

This widget allows displaying the content of a list in pages of items instead of rendering all items at once.

See the user documentation for more details.

Source:

Extends

Show inherited

Members

<protected> _keyNavCodes :Object

Hash mapping key code (arrow keys and home/end key) to functions to handle those keys. Usually not used directly, as subclasses can instead override _onLeftArrow() etc. Must be set before postCreate().

Type:
  • Object
Inherited From:
Source:

<protected> _started :boolean

Set to true when startup() has completed.

Type:
  • boolean
Inherited From:
Source:

allowRemap :boolean

Whether the created render items will be updated when call the remap() function on the component allowing the consuming component to re-perform the mapping on demand. This property must not be changed after the initialization cycle.

Type:
  • boolean
Inherited From:
Default Value:
  • false
Source:

autoPaging :boolean

Indicates whether or not to use auto paging. If true, automatically loads the next or previous page when the scrolling reaches the bottom or the top of the list content.

Type:
  • boolean
Default Value:
  • false
Source:

baseClass :string

The base class that defines the style of the list. Available values are:

  • "d-list" (default): render a list with no rounded corners and no left and right margins;
  • "d-round-rect-list": render a list with rounded corners and left and right margins.
Type:
  • string
Inherited From:
Default Value:
  • "d-list"
Source:

categoryAttr :string

Name of the list item attribute that define the category of a list item. If falsy and categoryFunc is also falsy, the list is not categorized.

Type:
  • string
Inherited From:
Default Value:
  • ""
Source:

categoryFunc

A function (or the name of a function) that extracts the category of a list item from the following input parameters:

  • item: the list item from the store
  • store: the store If falsy and categoryAttr is also falsy, the list is not categorized. see delite/StoreMap
Inherited From:
Default Value:
  • null
Source:

categoryRenderer :module:deliteful/list/CategoryRenderer

The widget class to use to render category headers when the list items are categorized. It MUST extend deliteful/list/CategoryRenderer.

Type:
Inherited From:
Default Value:
  • module:deliteful/list/CategoryRenderer
Source:

copyAllItemProps :boolean

If true, in addition to the mapped properties copy all the other properties of the store item into the render item with direct mapping. This property must not be changed after the initialization cycle.

Type:
  • boolean
Inherited From:
Default Value:
  • false
Source:

<protected> focused :boolean

This widget or a widget it contains has focus, or is "active" because it was recently clicked.

Type:
  • boolean
Inherited From:
Default Value:
  • false
Source:

<protected, readonly> focusedChild :Element

The currently focused descendant, or null if there isn't one

Type:
  • Element
Inherited From:
Source:

hideOnPageLoad :boolean

Indicates whether or not to hide the content of the list when loading a new page. If true, the content of the list is hidden by a loading panel (displaying a progress indicator and an optional label defined with the property loadingMessage) while its content is updated with a new page of data. This attribute is ignored if autoPaging is true.

Type:
  • boolean
Default Value:
  • false
Source:

iconclassAttr :string

Default mapping between the attribute of the item retrieved from the store and the icon attribute expected by the default renderer

Type:
  • string
Inherited From:
Default Value:
  • "iconclass"
Source:

isAriaListbox :boolean

Indicates whether the list has a WAI-ARIA role of listbox or its default WAI-ARIA role of grid. If this indicator is set to true:

  • The WAI-ARIA role of the list is set to listbox;
  • The sectionMode property cannot take the value none anymore. Its default value becomes single;
  • The itemRenderer and categoryRenderer widget are not allowed to provide internal navigation.
Type:
  • boolean
Inherited From:
Default Value:
  • false
Source:

itemRenderer :module:deliteful/list/ItemRenderer

The widget class to use to render list items. It MUST extend deliteful/list/ItemRenderer.

Type:
Inherited From:
Default Value:
  • module:deliteful/list/ItemRenderer
Source:

labelAttr :string

Default mapping between the attribute of the item retrieved from the store and the label attribute expected by the default renderer

Type:
  • string
Inherited From:
Default Value:
  • "label"
Source:

loadingMessage :string

Optional message to display, with a progress indicator, when the list is loading its content.

Type:
  • string
Inherited From:
Default Value:
  • ""
Source:

loadNextMessage :string

The message displayed on the next page loader when it can be clicked to load the next page. This message can contains placeholder for the List attributes to be replaced by their runtime value. For example, the message can include the value of the pageLength attribute by using the placeholder ${pageLength}.

Type:
  • string
Default Value:
  • localized version of "Click to load ${pageLength} more items"
Source:

loadPreviousMessage :string

The message displayed on the previous page loader when it can be clicked to load the previous page. This message can contains placeholder for the List attributes to be replaced by their runtime value. For example, the message can include the value of the pageLength attribute by using the placeholder ${pageLength}.

Type:
  • string
Default Value:
  • localized version of "Click to load ${pageLength} more items"
Source:

maxPages :number

The maximum number of pages to display at the same time. If a new page is loaded while the maximum number of pages is already displayed, another page will be unloaded from the list to make room for the new page.

Type:
  • number
Default Value:
  • 0
Source:

pageLength :number

if > 0, enable paging while defining the number of items to display per page.

Type:
  • number
Default Value:
  • 0
Source:

query :Object

Query to pass to the store to retrieve the items to render in the list.

Type:
  • Object
Inherited From:
Default Value:
  • {}
Source:

renderItems :Array.<Object>

The render items corresponding to the store items for this widget. This is filled from the store and is not supposed to be modified directly. Initially null.

Type:
  • Array.<Object>
Inherited From:
Default Value:
  • null
Source:

righticonclassAttr :string

Default mapping between the attribute of the item retrieved from the store and the righticon attribute expected by the default renderer

Type:
  • string
Inherited From:
Default Value:
  • "righticonclass"
Source:

righttextAttr :string

Default mapping between the attribute of the item retrieved from the store and the righttext attribute expected by the default renderer

Type:
  • string
Inherited From:
Default Value:
  • "righttext"
Source:

scrollableNode :Element

Designates the descendant node of this widget which is made scrollable.

If not set otherwise before the buildRendering() method of the mixin is executed, it is set by default to this widget itself (this).

Note that this property can be set only at construction time, at latest in the buildRendering() method of the host widget into which this class is mixed. It should not be changed afterwards. Typically, this property can be set by a host widget which needs scrolling capabilities on one its descendant nodes.

Type:
  • Element
Inherited From:
Default Value:
  • null
Source:

scrollDirection :string

Defines the scroll direction: "vertical" for a scrollable List, "none" for a non scrollable List.

Type:
  • string
Inherited From:
Default Value:
  • "vertical"
Source:

selectedItem :Object

In single selection mode, the selected item or in multiple selection mode the last selected item.

Type:
  • Object
Inherited From:
Default Value:
  • null
Source:

selectedItems :Array.<Object>

The list of selected items.

Type:
  • Array.<Object>
Inherited From:
Default Value:
  • null
Source:

selectionMode :string

The selection mode for list items (see delite/Selection).

Type:
  • string
Inherited From:
Default Value:
  • "none"
Source:

store :module:dstore/Store

Dojo object store that contains the items to render in the list. If no value is provided for this attribute, the List will initialize it with an internal store implementation. Note that this internal store implementation ignores any query options and returns all the items from the store, in the order they were added to the store.

Type:
  • module:dstore/Store
Inherited From:
Default Value:
  • null
Source:

<protected> template :function

Value returned by delite/handlebars! or compatible template engine. Specifies how to build the widget DOM initially and also how to update the DOM when widget properties change.

Type:
  • function
Inherited From:
Source:

<protected, constant> widgetId :number

Unique id for this widget, separate from id attribute (which may or may not be set). Useful when widget creates subnodes that need unique id's.

Type:
  • number
Inherited From:
Source:

Methods

<protected> _get(name) → {*}

Internal helper for directly accessing an attribute value.

Directly get the value of an attribute on an object, bypassing any accessor getter. It is designed to be used by descendant class if they want to access the value in their custom getter before returning it.

Parameters:
Name Type Description
name string

Name of property.
Inherited From:
Source:
Returns:

Value of property.

Type
*

<protected> _handleSelection(event)

Event handler that performs items (de)selection.

Parameters:
Name Type Description
event Event

The event the handler was called for.
Inherited From:
Source:

<protected> _itemRemoved(event)

When the store is observed and an item is removed in the store this method is called to remove the corresponding render item. This can be redefined but must not be called directly.

Parameters:
Name Type Description
event Event

The "remove" dstore/Trackable event.
Inherited From:
Source:

<protected> _onBlur()

This is where widgets do processing for when they stop being active, such as changing CSS classes. See onBlur() for more details.

Inherited From:
Source:

<protected> _onFocus()

This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.

Inherited From:
Source:

Called on left arrow key, or right arrow key if widget is in RTL mode. Should go back to the previous child in horizontal container widgets like Toolbar.

Inherited From:
Source:

Called on right arrow key, or left arrow key if widget is in RTL mode. Should go to the next child in horizontal container widgets like Toolbar.

Inherited From:
Source:

<protected> _parseAttr(name, value)

Helper for _mapAttributes(). Interpret a given attribute specified in markup, returning either:

  • undefined: ignore
  • {prop: prop, value: value}: set this[prop] = value
  • {event: event, callback: callback}: call this.on(event, callback);
Parameters:
Name Type Description
name string

Attribute name.
value string

Attribute value.
Inherited From:
Source:

<protected> _parseFunctionAttr(value, params)

Helper to parse function attribute in markup. Unlike _parsePrototypeAttr(), does not require a corresponding widget property. Functions can be specified as global variables or as inline javascript:

Parameters:
Name Type Description
value string

Value of the attribute.
params Array.<string>

When generating a function from inline javascript, give it these parameter names.
Inherited From:
Source:

<protected> _set(name, value)

Internal helper for directly setting a property value without calling the custom setter.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also notifies callbacks registered via observe(). Custom setters should call _set to actually record the new value.

Parameters:
Name Type Description
name string

The property to set.
value *

Value to set the property to.
Inherited From:
Source:

<protected> attachedCallback()

Called when the widget is first inserted into the document. If widget is created programatically then app must call startup() to trigger this method.

Inherited From:
Source:

<protected> buildRendering()

Construct the UI for this widget, filling in subnodes and/or text inside of this. Most widgets will leverage delite/handlebars! to set template, rather than defining this method.

Inherited From:
Source:

computeProperties(newValues, oldValues)

Callback function to calculate computed properties upon property changes.

Parameters:
Name Type Description
newValues Object

The hash table of new property values, keyed by property names.
oldValues Object

The hash table of old property values, keyed by property names.
Inherited From:
Source:

<protected> createdCallback()

Kick off the life-cycle of a widget.

Calls a number of widget methods (preCreate(), buildRendering(), and postCreate()), some of which of you'll want to override.

Of course, adventurous developers could override createdCallback entirely, but this should only be done as a last resort.

Inherited From:
Source:

<protected> defer(fcn, delay) → {Object}

Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed.

Parameters:
Name Type Description
fcn function

Function to be executed after specified delay (or 0ms if no delay specified).
delay number

Delay in ms, defaults to 0.
Inherited From:
Source:
Returns:

Handle with a remove method that deschedules the callback from being called.

Type
Object

deliver()

Synchronously deliver change records for computed properties and then UI rendering so that refreshingRendering() is called if there are pending change records.

Inherited From:
Source:

deliverComputing()

Synchronously deliver change records for computed properties so that refreshingComputing() is called if there are pending change records.

Inherited From:
Source:

destroy()

Destroy this widget and its descendants.

Inherited From:
Source:

discardChanges()

Discard change records.

Inherited From:
Source:

discardComputing()

Discard change records for computed properties.

Inherited From:
Source:

<protected> dispatchSelectionChange(oldSelectedItem, newSelectedItem, renderer, triggerEvent)

Dispatch a selection change event.

Parameters:
Name Type Description
oldSelectedItem Object

The previously selected item.
newSelectedItem Object

The new selected item.
renderer Object

The visual renderer of the selected/deselected item.
triggerEvent Event

The event that lead to the selection of the item.
Inherited From:
Source:

<protected> emit(type, eventObj) → {boolean}

Signal that a synthetic event occurred.

Emits an event of specified type, based on eventObj. Also calls onType() method, if present, and returns value from that method. Modifies eventObj by adding missing parameters (bubbles, cancelable, widget).

Parameters:
Name Type Argument Description
type string

Name of event.
eventObj Object <optional>

Properties to mix in to emitted event.
Inherited From:
Source:
Returns:

True if the event was not canceled, false if it was canceled.

Type
boolean
Example
myWidget.emit("query-success", {});

<protected> fetch(collection)

Called to perform the fetch operation on the collection.

Parameters:
Name Type Description
collection dstore/Collection

Items to be displayed.
Inherited From:
Source:

findCustomElements(root)

Search subtree under root returning custom elements found.

Parameters:
Name Type Argument Description
root Element <optional>

Node to search under.
Inherited From:
Source:

focus()

Default focus() implementation: focus the first child.

Inherited From:
Source:

<protected> focusChild(child, last)

Focus specified child Element.

Parameters:
Name Type Description
child Element

Reference to container's child.
last boolean

If true and if child has multiple focusable nodes, focus the last one instead of the first one.
Inherited From:
Source:

<protected> focusFirstChild()

Focus the first focusable child in the container.

Inherited From:
Source:

<protected> focusLastChild()

Focus the last focusable child in the container.

Inherited From:
Source:

<protected> getBottomDistance(node)

Returns the distance between the bottom of a node and the bottom of the scrolling container.

Parameters:
Name Type Description
node Node

the node
Inherited From:
Source:

getCurrentScroll() → {Object}

Returns the current amount of scroll, as an object with x and y properties for the horizontal and vertical scroll amount. This is a convenience method and it is not supposed to be overridden.

Inherited From:
Source:
Returns:
Type
Object

getEnclosingRenderer(node) → {module:deliteful/list/Renderer}

Returns the renderer enclosing a dom node.

Parameters:
Name Type Description
node Element

The dom node.
Inherited From:
Source:
Returns:
Type
module:deliteful/list/Renderer

getEnclosingWidget(node)

Returns the widget whose DOM tree contains the specified DOMNode, or null if the node is not contained within the DOM tree of any widget

Parameters:
Name Type Description
node Element
Inherited From:
Source:

<protected> getIdentity(item) → {Object}

Returns the identity of an item.

Parameters:
Name Type Description
item Object

The item
Inherited From:
Source:
Returns:
Type
Object

getItemRendererByIndex(index) → {module:deliteful/list/ItemRenderer}

Returns the item renderer at a specific index in the List.

Parameters:
Name Type Description
index number

The item renderer at the index (first item renderer index is 0).
Inherited From:
Source:
Returns:
Type
module:deliteful/list/ItemRenderer

getItemRendererIndex(renderer) → {number}

Returns the index of an item renderer in the List, or -1 if the item renderer is not found in the list.

Parameters:
Name Type Description
renderer Object

The item renderer.
Inherited From:
Source:
Returns:
Type
number

getParent()

Returns the parent widget of this widget.

Inherited From:
Source:

getRendererByItemId(id) → {module:deliteful/list/Renderer}

Returns the renderer currently displaying an item with a specific id.

Parameters:
Name Type Description
id Object

The id of the item displayed by the renderer.
Inherited From:
Source:
Returns:
Type
module:deliteful/list/Renderer

<protected> getTopDistance(node)

Returns the distance between the top of a node and the top of the scrolling container.

Parameters:
Name Type Description
node Node

the node
Inherited From:
Source:

<protected> hasSelectionModifier(event) → {boolean}

Always returns true so that no keyboard modifier is needed when selecting / deselecting items.

Parameters:
Name Type Description
event Event
Inherited From:
Source:
Returns:
Type
boolean

<protected> initItems(items)

Populate the list using the items retrieved from the store.

Parameters:
Name Type Description
items Array.<Object>

items retrieved from the store.
Inherited From:
Source:

isBottomScroll() → {boolean}

Returns true if container's scroll has reached the maximum limit at the bottom of the contents. Returns false otherwise.

Inherited From:
Source:
Returns:
Type
boolean
Example
var scrollableNode = scrollableWidget.scrollableNode;
scrollableNode.on("scroll", function () {
  if (scrollableWidget.isBottomScroll()) {
    console.log("Scroll reached the maximum limit at the bottom");
  }
}

isLeftScroll() → {boolean}

Returns true if container's scroll has reached the maximum limit at the left of the contents. Returns false otherwise.

Inherited From:
Source:
Returns:
Type
boolean
Example
var scrollableNode = scrollableWidget.scrollableNode;
scrollableNode.on("scroll", function () {
  if (scrollableWidget.isLeftScroll()) {
    console.log("Scroll reached the maximum limit at the left");
  }
}

<protected> isLeftToRight() → {boolean}

Return this widget's explicit or implicit orientation (true for LTR, false for RTL).

Inherited From:
Source:
Returns:
Type
boolean

isRightScroll() → {boolean}

Returns true if container's scroll has reached the maximum limit at the right of the contents. Returns false otherwise.

Inherited From:
Source:
Returns:
Type
boolean
Example
var scrollableNode = scrollableWidget.scrollableNode;
scrollableNode.on("scroll", function () {
  if (scrollableWidget.isRightScroll()) {
    console.log("Scroll reached the maximum limit at the right");
  }
}

isSelected(object) → {Object}

Returns whether an item is selected or not.

Parameters:
Name Type Description
object item

The item to test.
Inherited From:
Source:
Returns:

The item to test the selection for.

Type
Object

isTopScroll() → {boolean}

Returns true if container's scroll has reached the maximum limit at the top of the contents. Returns false otherwise.

Inherited From:
Source:
Returns:
Type
boolean
Example
var scrollableNode = scrollableWidget.scrollableNode;
scrollableNode.on("scroll", function () {
  if (scrollableWidget.isTopScroll()) {
    console.log("Scroll reached the maximum limit at the top");
  }
}

<protected> itemMoved(previousIndex, newIndex, renderItem, renderItems)

This method is called when an item is moved in an observable store. The default implementation actually moves the renderItem in the renderItems array. This can be redefined but must not be called directly.

Parameters:
Name Type Description
previousIndex number

The previous index of the render item.
newIndex number

The new index of the render item.
renderItem Object

The render item to be moved.
renderItems Array.<Object>

The array of render items to render item to be moved is part of.
Inherited From:
Source:

<protected> itemRemoved(index, renderItems, keepSelection)

Function to call when an item is removed from the store, to update the content of the list widget accordingly.

Parameters:
Name Type Description
index number

The index of the render item to remove.
renderItems Array.<Object>

Ignored by this implementation.
keepSelection boolean

Set to true if the item should not be removed from the list of selected items.
Inherited From:
Source:

<protected> itemToRenderItem(item) → {Object}

Returns the widget internal item for a given store item based on the various mapped properties.

Parameters:
Name Type Description
item Object

The store item.
Inherited From:
Source:
Returns:
Type
Object

<protected> itemUpdated(index, renderItem, renderItems)

Function to call when an item is updated in the store, to update the content of the list widget accordingly.

Parameters:
Name Type Description
index number

The index of the render item to update.
renderItem Object

The render item data the render item must be updated with.
renderItems Array.<Object>

Ignored by this implementation.
Inherited From:
Source:

mix(hash)

Set a hash of properties on a Stateful instance.

Parameters:
Name Type Description
hash Object

Hash of properties.
Inherited From:
Source:
Example
myObj.mix({
    foo: "Howdy",
    bar: 3
});

notifyCurrentValue(name)

Notify current value to observers. Handy to manually schedule invocation of observer callbacks when there is no change in value.

Parameters:
Name Type Description
name string

The property name.
Inherited From:
Source:

observe(callback) → {module:decor/Stateful.PropertyListObserver}

Observe for change in properties. Callback is called at the end of micro-task of changes with a hash table of old values keyed by changed property. Multiple changes to a property in a micro-task is squashed .

Parameters:
Name Type Description
callback function

The callback.
Inherited From:
Source:
Returns:

The observer that can be used to stop observation or synchronously deliver/discard pending change records.

Type
module:decor/Stateful.PropertyListObserver
Example
var stateful = new (dcl(Stateful, {
        foo: undefined,
        bar: undefined,
        baz: undefined
    }))({
        foo: 3,
        bar: 5,
        baz: 7
    });
stateful.observe(function (oldValues) {
    // oldValues is {foo: 3, bar: 5, baz: 7}
});
stateful.foo = 4;
stateful.bar = 6;
stateful.baz = 8;
stateful.foo = 6;
stateful.bar = 8;
stateful.baz = 10;

on(type, func, node) → {Object}

Call specified function when event occurs.

Note that the function is not run in any particular scope, so if (for example) you want it to run in the widget's scope you must do myWidget.on("click", myWidget.func.bind(myWidget)).

Parameters:
Name Type Argument Description
type string | function

Name of event (ex: "click") or extension event like touch.press.
func function

Callback function.
node Element <optional>

Element to attach handler to, defaults to this.
Inherited From:
Source:
Returns:

Handle with remove() method to cancel the event.

Type
Object

onBlur()

Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.

Inherited From:
Source:

onFocus(evt)

Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.

Parameters:
Name Type Description
evt Event

A focus event.
Inherited From:
Source:

<protected> own() → {Array.<Object>}

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Inherited From:
Source:
Returns:

The array of specified handles, so you can do for example: var handle = this.own(on(...))[0];

Type
Array.<Object>

<protected> placeAt(reference, position) → {module:delite/Widget}

Place this widget somewhere in the dom, and allow chaining.

Parameters:
Name Type Argument Description
reference string | Element | DocumentFragment

Element, DocumentFragment, or id of Element to place this widget relative to.
position string | number <optional>

Numeric index or a string with the values:

  • number - place this widget as n'th child of reference node
  • "first" - place this widget as first child of reference node
  • "last" - place this widget as last child of reference node
  • "before" - place this widget as previous sibling of reference node
  • "after" - place this widget as next sibling of reference node
  • "replace" - replace specified reference node with this widget
  • "only" - replace all children of reference node with this widget
Inherited From:
Source:
Returns:

This widget, for chaining.

Type
module:delite/Widget
Examples
// create a Button with no srcNodeRef, and place it in the body:
var button = new Button({ label:"click" }).placeAt(document.body);
// place a new button as the first element of some div
var button = new Button({ label:"click" }).placeAt("wrapper","first");
// create a contentpane and add it to a TabContainer
var tc = document.getElementById("myTabs");
new ContentPane({ href:"foo.html", title:"Wow!" }).placeAt(tc)

<protected> postCreate()

Processing after the DOM fragment is created.

Called after the DOM fragment has been created, but not necessarily added to the document. Do not include any operations which rely on node dimensions or placement.

Inherited From:
Source:

<protected> preCreate()

Processing before buildRendering().

Inherited From:
Source:

<protected> processCollection(collection)

Called to process the items returned after querying the store.

Parameters:
Name Type Description
collection dstore/Collection

Items to be displayed.
Inherited From:
Source:

<protected> processConstructorParameters()

Called after Object is created to process parameters passed to constructor.

Inherited From:
Source:

processQueryResult()

A function that processes the collection returned by the store query and returns a new collection (to sort it, etc...). This processing is applied before potentially tracking the store for modifications (if Trackable). Changing this function on the instance will not automatically refresh the class.

Inherited From:
Default Value:
  • identity function
Source:

<protected> queryStoreAndInitItems(processQueryResult) → {Promise}

Queries the store, creates the render items and calls initItems() when ready. If an error occurs a 'query-error' event will be fired.

This method is not supposed to be called by application developer. It will be called automatically when modifying the store related properties or by the subclass if needed.

Parameters:
Name Type Description
processQueryResult

A function that processes the collection returned by the store query and returns a new collection (to sort it, etc...)., applied before tracking.
Inherited From:
Source:
Returns:

If store to be processed is not null a promise that will be resolved when the loading process will be finished.

Type
Promise

refreshRendering(newValues, oldValues)

Callback function to render UI upon property changes.

Parameters:
Name Type Description
newValues Object

The hash table of new property values, keyed by property names.
oldValues Object

The hash table of old property values, keyed by property names.
Inherited From:
Source:

remap()

If allowRemap is true, the method allows to perform again the mapping between the data item and the render items. This might be useful is mapping by function is used and the execution context of the mapping function as changed so that the results would need to be updated. It should not be called if allowRemap is false.

Inherited From:
Source:

renderItemToItem(renderItem) → {Promise}

Creates a store item based from the widget internal item based on the various mapped properties. Works asynchronously.

Parameters:
Name Type Description
renderItem Object

The render item.
Inherited From:
Source:
Returns:
Type
Promise

scrollBy(by, duration)

Scrolls by the given amount.

Parameters:
Name Type Description
by Object

The scroll amount. An object with x and/or y properties, for example {x: 0, y: -5} or {y: -29}.
duration number

Duration of scrolling animation in milliseconds. If 0 or unspecified, scrolls without animation.
Inherited From:
Source:

scrollTo(to, duration) → {module:dojo/_base/fx/Animation}

Scrolls to the given position.

Parameters:
Name Type Argument Description
to Object

The scroll destination position. An object with w and/or y properties, for example {x: 0, y: -5} or {y: -29}.
duration number <optional>

Duration of scrolling animation in milliseconds. If 0 or unspecified, scrolls without animation.
Inherited From:
Source:
Returns:
Type
module:dojo/_base/fx/Animation

<protected> selectFromEvent(event, item, renderer, dispatch) → {boolean}

Applies selection triggered by an user interaction.

Parameters:
Name Type Description
event Event

The source event of the user interaction.
item Object

The item that has been selected/deselected.
renderer Object

The visual renderer of the selected/deselected item.
dispatch boolean

Whether an event must be dispatched or not.
Inherited From:
Source:
Returns:

True if the selection has changed and false otherwise.

Type
boolean

<protected> setClassComponent(component, value, node)

Helper method to set a class (or classes) on a given node, removing the class (or classes) set by the previous call to setClassComponent() for the specified component and node. Used mainly by template.js to set classes without overwriting classes set by the user or other code (ex: CssState).

Parameters:
Name Type Argument Description
component string

Specifies the category.
value string

Class (or classes) to set.
node HTMLElement <optional>

The node to set the property on; defaults to widget root node.
Inherited From:
Source:

<protected> setOrRemoveAttribute(node, name, value)

Helper method to set/remove an attribute based on the given value:

  • If value is undefined, the attribute is removed. Useful for attributes like aria-valuenow.
  • If value is boolean, the attribute is set to "true" or "false". Useful for attributes like aria-selected.
  • If value is a number, it's converted to a string.
Parameters:
Name Type Description
node Element

The node to set the property on.
name string

Name of the property.
value string

Value of the property.
Inherited From:
Source:

setSelected(item, value)

Change the selection state of an item.

Parameters:
Name Type Description
item Object

The item to change the selection state for.
value boolean

True to select the item, false to deselect it.
Inherited From:
Source:

startup()

Processing after the DOM fragment is added to the document.

Called after a widget and its children have been created and added to the page, and all related widgets have finished their create() cycle, up through postCreate().

Note that startup() may be called while the widget is still hidden, for example if the widget is inside a hidden deliteful/Dialog or an unselected tab of a deliteful/TabContainer. For widgets that need to do layout, it's best to put that layout code inside resize(), and then extend delite/LayoutWidget so that resize() is called when the widget is visible.

Inherited From:
Source:

<protected> updateRenderers(items)

Updates renderers when the selection has changed.

Parameters:
Name Type Description
items Array.<Object>

The items which renderers must be updated.
Inherited From:
Source:

Events

selection-change

Selection change event. Dispatched after the selection has been modified through user interaction.

Properties:
Name Type Description
oldValue number

The previously selected item.
newValue- number

The new selected item.
renderer Object

The visual renderer of the selected/deselected item.
triggerEvent Event

The event that lead to the selection of the item.
Inherited From:
Source:
Example
widget.on("selection-change", function (evt) {
	console.log("old value: " + evt.oldValue);
	console.log("new value: " + evt.newValue);
}