FHIRTreeBinding

.r4. FHIRTreeBinding

Tree binding implementation for the FHIRModel

Constructor

new FHIRTreeBinding(oModel, sPath, oContextopt, aFiltersopt, mParametersopt, aSortersopt)

Constructor for a new FHIRTreeBinding

Version:
  • 2.4.0
Since:
  • 1.0.0
Author:
  • SAP SE
Source:
Parameters:
Name Type Attributes Description
oModel sap.fhir.model.r4.FHIRModel

The FHIRModel
sPath string

The binding path in the model
oContext sap.fhir.model.r4.Context <optional>

The parent context which is required as base for a relative path
aFilters sap.ui.model.Filter | Array.<sap.ui.model.Filter> <optional>

The dynamic application filters to be used initially (can be either a filter or an array of filters)
mParameters object <optional>

The map which contains additional parameters for the binding

Name Type Attributes Default Description
groupId string <optional>

The group id
operationMode sap.fhir.model.r4.OperationMode <optional>

The operation mode, how to handle operations like filtering and sorting
rootSearch string <optional>

The search parameter to identify the root node, e.g. 'base'
rootValue string <optional>

The value of the search parameter to identify the root node, e.g. 'http://hl7.org/fhir/StructureDefinition/DomainResource'
rootProperty string <optional>

The property of a FHIR resource which represents the link to the parent in the tree, e.g. 'baseDefinition'
nodeProperty string <optional>

The property of a FHIR resource which identifies the resource as a node in the tree, e.g. 'url', Note: The rootProperty of a child, is the value of the nodeProperty of the parent
displayRootNode boolean <optional>
 false

Determines if the root node of the tree is displayed or not
collapseRecursive boolean <optional>
 true

Determines if all sub nodes of a single node will be collapsed also, if this single node is collapsed
numberOfExpandedLevels number <optional>
 0

Determines the number of levels, which will be auto-expanded initially
aSorters sap.ui.model.Sorter | Array.<sap.ui.model.Sorter> <optional>

The dynamic sorters to be used initially (can be either a sorter or an array of sorters)

Extends

  • sap.ui.model.TreeBinding

Methods

attachTreeLoadingCompleted(oDataopt, fnFunction, oListeneropt) → {sap.fhir.model.r4.FHIRTreeBinding}

Attach event-handler fnFunction to the treeLoadingCompleted event of this sap.fhir.model.r4.FHIRTreeBinding.

Since:
  • 1.0.0
Source:
Parameters:
Name Type Attributes Description
oData object <optional>

The object, that should be passed along with the event-object when firing the event.
fnFunction function

The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
oListener object <optional>

Object on which to call the given function. If empty, the global context (window) is used.
Returns:
Type:
sap.fhir.model.r4.FHIRTreeBinding

this to allow method chaining

attachTreeLoadingStarted(oDataopt, fnFunction, oListeneropt) → {sap.fhir.model.r4.FHIRTreeBinding}

Attach event-handler fnFunction to the treeLoadingStarted event of this sap.fhir.model.r4.FHIRTreeBinding.

Since:
  • 1.0.0
Source:
Parameters:
Name Type Attributes Description
oData object <optional>

The object, that should be passed along with the event-object when firing the event.
fnFunction function

The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
oListener object <optional>

Object on which to call the given function. If empty, the global context (window) is used.
Returns:
Type:
sap.fhir.model.r4.FHIRTreeBinding

this to allow method chaining

detachTreeLoadingCompleted(fnFunction, oListener) → {sap.fhir.model.r4.FHIRTreeBinding}

Detach event-handler fnFunction from the treeLoadingCompleted event of this sap.fhir.model.r4.FHIRTreeBinding. The passed function and listener object must match the ones previously used for event registration.

Since:
  • 1.0.0
Source:
Parameters:
Name Type Description
fnFunction function

The function to call, when the event occurs.
oListener object

Object on which the given function had to be called.
Returns:
Type:
sap.fhir.model.r4.FHIRTreeBinding

this to allow method chaining

detachTreeLoadingStarted(fnFunction, oListener) → {sap.fhir.model.r4.FHIRTreeBinding}

Detach event-handler fnFunction from the treeLoadingStarted event of this sap.fhir.model.r4.FHIRTreeBinding. The passed function and listener object must match the ones previously used for event registration.

Since:
  • 1.0.0
Source:
Parameters:
Name Type Description
fnFunction function

The function to call, when the event occurs.
oListener object

Object on which the given function had to be called.
Returns:
Type:
sap.fhir.model.r4.FHIRTreeBinding

this to allow method chaining

filter(aFiltersopt, sFilterType)

Filters the actual list binding depending on the given aFilters

Since:
  • 1.0.0
Source:
Parameters:
Name Type Attributes Description
aFilters Array.<sap.ui.model.Filter> <optional>

The filters defined for the list binding
sFilterType sap.ui.model.FilterType

Type of the filter which should be adjusted, if it is not given, the standard behaviour applies

getLength() → {number}

Determines the number of entities contained by the actual tree binding

Since:
  • 1.0.0
Source:
Returns:
Type:
number

The number of entities contained by the current list binding

refresh(sChangeReason)

Refreshes the tree binding

Since:
  • 1.0.0
Source:
Parameters:
Name Type Description
sChangeReason sap.ui.model.ChangeReason

The reason for refreshing the binding

sort(aSorters, bRefresh)

Sorts the actual list binding based on the given aSorters

Since:
  • 1.0.0
Source:
Parameters:
Name Type Description
aSorters Array.<sap.ui.model.Sorter>

The sorters defined for the list binding
bRefresh boolean

If the binding should directly send a call or wait for the filters, for p13ndialog

Type Definitions

Parameter

Properties:
Name Type Attributes Description
urlParameters object <optional>

The parameters that will be passed as query strings
Since:
  • 1.0.0
Source:
Type:
  • object

Events

treeLoadingCompleted

Fired, when the tree binding has finished requesting tree items from the FHIR server

Source:
Parameters:
Name Type Description
oEvent sap.ui.base.Event
Name Type Description
getSource sap.ui.base.EventProvider

treeLoadingStarted

Fired, when the tree binding starts to request tree items from the FHIR server

Source:
Parameters:
Name Type Description
oEvent sap.ui.base.Event
Name Type Description
getSource sap.ui.base.EventProvider