Class sap.ui.vbm.Adapter3DModule: sap/ui/vbm/Adapter3D

extends Element

Provides the ability to load VBI JSON into sap.ui.vbm.Viewport control.

Constructor Summary
new sap.ui.vbm.Adapter3D(sId?, mSettings?)Constructor for a new Visual Business Adapter 3D.
Event Summary
submit(oControlEvent)This event is fired when interactions in the viewport happen.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Adapter3D.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Adapter3D with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Adapter3D.getMetadata()Returns a metadata object for class sap.ui.vbm.Adapter3D.
attachSubmit(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the submit event of this sap.ui.vbm.Adapter3D.
detachSubmit(fnFunction, oListener)Detaches event handler fnFunction from the submit event of this sap.ui.vbm.Adapter3D.
fireSubmit(mArguments?)Fires event submit to attached listeners.
getViewport()ID of the element which is the current target of the association viewport, or null.
load(data)Processes the various sections from the VBI JSON.
setViewport(oViewport)Sets the associated viewport.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.vbm.Adapter3D(sId?, mSettings?)
Constructor for a new Visual Business Adapter 3D.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Events
    • submit : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new object
Event Detail
submit(oControlEvent)
This event is fired when interactions in the viewport happen.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.data A string in the VBI JSON format.
Method Detail
sap.ui.vbm.Adapter3D.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Adapter3D with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.vbm.Adapter3D.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Adapter3D.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachSubmit(oData?, fnFunction, oListener?): sap.ui.vbm.Adapter3D
Attaches event handler fnFunction to the submit event of this sap.ui.vbm.Adapter3D.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vbm.Adapter3D itself.

This event is fired when interactions in the viewport happen.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.vbm.Adapter3D itself
Returns:
{sap.ui.vbm.Adapter3D} Reference to this in order to allow method chaining
detachSubmit(fnFunction, oListener): sap.ui.vbm.Adapter3D
Detaches event handler fnFunction from the submit event of this sap.ui.vbm.Adapter3D.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.vbm.Adapter3D} Reference to this in order to allow method chaining
fireSubmit(mArguments?): sap.ui.vbm.Adapter3D
Fires event submit to attached listeners.

Expects the following event parameters:

  • data of type stringA string in the VBI JSON format.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Adapter3D} Reference to this in order to allow method chaining
getViewport(): sap.ui.vbm.Viewport
ID of the element which is the current target of the association viewport, or null.
Returns:
{sap.ui.vbm.Viewport}
load(data): Promise
Processes the various sections from the VBI JSON.

The Resources, DataTypes, Scenes and Data sections from the VBI JSON are sequentially processed. Processing of the Data section would eventually lead to change in the content resources.

Parameters:
{object|string}data The VBI JSON.
Returns:
{Promise} A Promise object that is resolved when the VBI JSON is processed.
setViewport(oViewport): sap.ui.vbm.Adapter3D
Sets the associated viewport.
Parameters:
{sap.ui.vbm.Viewport}oViewport Id of an element which becomes the new target of this viewport association; alternatively, an element instance may be given
Returns:
{sap.ui.vbm.Adapter3D} Reference to this in order to allow method chaining