Class: XMLDataUpdateListener

bcdui.widget. XMLDataUpdateListener

This listener is an abstract base class for XML listeners registered to a targetModel and depending on the existence of a specific HTML element. When the HTML element disappears the listener de-registers itself from the target model.

abstractnew bcdui.widget.XMLDataUpdateListener()

widget/xmlDataUpdateListener.js, line 24

Members

constant_targetModelIdbcdui.core.DataProvider

The hidden referenceId of targetModel to be watched. will be needed when idRef will be removed from object.

constanthtmlElementIdString

The ID of the HTML element to be watched.

constantidString

The generated id of the listener.
The referenceId of targetModel to be watched.

isUnRegisteredBoolean

A flag which is set to false when the class has de-registered itself from the targetModel after the htmlElement has disappeared.

constanttrackingXPathString

The XPath within the targetModel that should be observed by the client class. It is not evaluated in this base class.

Methods

hasBeenUnRegistered(){Boolean}

widget/xmlDataUpdateListener.js, line 125
Tests, if the class has already unregistered itself from its target model. This happens when the listener is called, but the HTML element it is assigned to has disappeared.
Returns:
Type Description
Boolean True, if the class is unregistered.

unregister()

widget/xmlDataUpdateListener.js, line 135
This method removes this listener from the targetModel. It is called by the #callback method when the listener is triggered and the HTML element has disappeared.

Events

updateValue

widget/xmlDataUpdateListener.js, line 114
This method needs to be implemented by sub-classes to provide the functionality of the listener.