Class: DocumentListRelations

XV. DocumentListRelations

A control that displays a list of scrolling rows.
Use to provide the list of related data to the XV.DocumentsBox.

new DocumentListRelations()

Source:

Extends

Methods

destroy()

Clear all bindings.
Inherited From:
Source:

fetchRelated()

Inherited From:
Source:
To Do:
  • Document the fetchRelated method.

formatDescription()

Source:
To Do:
  • Document the formatDescription method.

formatNumber()

Source:
To Do:
  • Document the formatNumber method.

formatPurpose()

Source:
To Do:
  • Document the formatPurpose method.

formatType()

Source:
To Do:
  • Document the formatType method.

getFirstSelected()

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

getInfoModel()

Source:
To Do:
  • Document getInfoModel method.

getModel(Index, Return)

Parameters:
Name Type Description
Index Integer
Return Boolean InfoModel (default = true)
Source:

getParent()

Inherited From:
Source:
To Do:
  • Document the getParent method.

hasMore()

Inherited From:
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.
Inherited From:
Source:

modelAdded()

Inherited From:
Source:
To Do:
  • Document the modelAdded method.

openWindow()

Source:
To Do:
  • Document the openWindow method.

orderByChanged()

Inherited From:
Source:
To Do:
  • Document the orderByChanged method.

parentStatusChanged()

Inherited From:
Source:
To Do:
  • Document the parentStatusChanged method.

readyModels()

Returns an array of the models whose status is not destroyed.
Inherited From:
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.
Inherited From:
Source:

scroll()

Inherited From:
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.
Inherited From:
Source:

statusChanged()

Inherited From:
Source:
To Do:
  • Document the statusChanged method.

valueChanged()

Inherited From:
Source:
To Do:
  • Document the valueChanged method.