Class: ListRelations

XV. ListRelations

A control that displays a list of scrolling rows.
Use to attach to a workspace to present related data.
A superkind of XV.DocumentListRelations.
Derived from enyo.List.

new ListRelations()

Source:

Extends

  • enyo.List

Methods

destroy()

Clear all bindings.
Source:

fetchRelated()

Source:
To Do:
  • Document the fetchRelated method.

getFirstSelected()

Returns the selected index as a string that looks like a number, e.g. "1"
Source:

getModel()

Source:
To Do:
  • Document the getModel method.

getParent()

Source:
To Do:
  • Document the getParent method.

hasMore()

Source:
To Do:
  • Document the hasMore method.

lengthChanged()

We want the count of the the list to be the number of READY models, so this function enforces that trimming. It needs to be called even when other kinds (e.g. childWorkspaces) affect the collection.
Source:

modelAdded()

Source:
To Do:
  • Document the modelAdded method.

orderByChanged()

Source:
To Do:
  • Document the orderByChanged method.

parentStatusChanged()

Source:
To Do:
  • Document the parentStatusChanged method.

readyModels()

Returns an array of the models whose status is not destroyed.
Source:

refreshModel()

This version of refresh model refreshes the entire model tree since it is likely child models are nested only and can not be fetched independently.
Source:

scroll()

Source:
To Do:
  • Document the scroll method. How does it differ from the implementation for XV.List? XXX #refactor

setupItem()

Render the list. Note that we render readyModels here. This assumes that all the models in the collection are ready, or that the length has been specially trimmed with the lengthChanged function. If the count of the list is greater than the length of readyModels then this will error.
Source:

statusChanged()

Source:
To Do:
  • Document the statusChanged method.

valueChanged()

Source:
To Do:
  • Document the valueChanged method.