Class Index | File Index

Classes


Class sap.ui2.etc.DataContextAPI


Defined in: DataContextAPI.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
API to the DataContext
This class is experimental, location might change in the future
already registers for events (but for subscribers, the api is a singleton, as all information is managed on the prototype!)
usage:
var dca = new DataContextAPI();
Method Summary
Method Attributes Method Name and Description
 
Invoke this function to remove registered internal and external handlers
 
Obtain the DataContext instance
 
noDisconnect(fFunctionOrsFunctionName)
Invoke this function to disable supression of updates when the com.sap.lsapi.sidePanel::disconnected(true)/com.sap.lsapi.sidePanel::disconnected(false) events are received.
 
Publish changes to the local data context object to the world
 
subscribeOnDataContextChanged(fFunctionOrsFunctionName, oCallbackObject)
On a change of the DataContext from outside or from this screen (using publishChanges!), the registered handler will be invoked.
Class Detail
sap.ui2.etc.DataContextAPI()
API to the DataContext
This class is experimental, location might change in the future
already registers for events (but for subscribers, the api is a singleton, as all information is managed on the prototype!)
usage:
var dca = new DataContextAPI();
Since:
1.16.0
Method Detail
destroy()
Invoke this function to remove registered internal and external handlers

getDataContext()
Obtain the DataContext instance
Returns:
the data context instance

noDisconnect(fFunctionOrsFunctionName)
Invoke this function to disable supression of updates when the com.sap.lsapi.sidePanel::disconnected(true)/com.sap.lsapi.sidePanel::disconnected(false) events are received. noDisconnect() or noDisconnect(true) disables it.
noDisconnect(false) resets it to the default (com.sap.lsapi.sidePanel.sidePanel::disconnect events disable the changedWithXML event receival). Note that publishing Changes is not affected by the disconnection and the DataContext instance can be manipulated and read in a disconnected state.
Parameters:
{boolean} fFunctionOrsFunctionName
a function object or a name of a method *

publishChanges()
Publish changes to the local data context object to the world

{string} subscribeOnDataContextChanged(fFunctionOrsFunctionName, oCallbackObject)
On a change of the DataContext from outside or from this screen (using publishChanges!), the registered handler will be invoked.
Parameters:
{function|string} fFunctionOrsFunctionName
a function object or a name of a method
{Object} oCallbackObject Optional
an optional callback object to invoke the method on.
Returns:
{string} registration id

©Copyright (c) 2009-2014 SAP SE, All Rights Reserved
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Mar 14 2017 08:48:14 GMT-0000 (UTC)