Class sap.ui.vk.StepNavigationModule: sap/ui/vk/StepNavigation

extends Control

Enables capabilities for navigating and activating procedures and steps contained in a single 3D scene.

Experimental API:Since 1.32.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.StepNavigation(sId?, mSettings?)Constructor for a new StepNavigation.
Event Summary
resize(oControlEvent)
stepChanged(oControlEvent)Raised each time a step starts, changes, or finishes.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vk.StepNavigation.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.StepNavigation with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.StepNavigation.getMetadata()Returns a metadata object for class sap.ui.vk.StepNavigation.
attachResize(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the resize event of this sap.ui.vk.StepNavigation.
attachStepChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the stepChanged event of this sap.ui.vk.StepNavigation.
clear()Clears the content of the Step Navigation control.
destroyLayout()Destroys the layout in the aggregation layout.
destroyProcedureItemTemplate()Destroys the procedureItemTemplate in the aggregation procedureItemTemplate.
destroyStepInfoPopup()Destroys the stepInfoPopup in the aggregation stepInfoPopup.
destroyThumbnailsContainer()Destroys the thumbnailsContainer in the aggregation thumbnailsContainer.
detachResize(fnFunction, oListener)Detaches event handler fnFunction from the resize event of this sap.ui.vk.StepNavigation.
detachStepChanged(fnFunction, oListener)Detaches event handler fnFunction from the stepChanged event of this sap.ui.vk.StepNavigation.
fireResize(mArguments?)Fires event resize to attached listeners.
fireStepChanged(mArguments?)Fires event stepChanged to attached listeners.
getHeight()Gets current value of property height.
getLayout()Gets content of aggregation layout.
getNextStep(procedureIndex?)Cycles through steps and procedures for the lastLoadedScene and returns the step that follows after the currentStepId.
getPreviousStep(procedureIndex?)Cycles through steps and procedures for the last loaded scene (lastLoadedScene), and returns the step preceding the current step (currentStepId.
getProcedureItemTemplate()Gets content of aggregation procedureItemTemplate.
getProceduresAndSteps()Returns the procedures list with steps for the current scene, and appends base64 data as thumbnailData and an image type as thumbnailType.
getSettings()Gets current value of property settings.
getShowStepInfo()Gets current value of property showStepInfo.
getShowThumbnails()Gets current value of property showThumbnails.
getShowToolbar()Gets current value of property showToolbar.
getStep(relIndex, procedureIndex?, specificStepId)Gets a step based on a positive or negative integer, which is used as an index relative to the index of the current step.
getStepInfoPopup()Gets content of aggregation stepInfoPopup.
getThumbnailsContainer()Gets content of aggregation thumbnailsContainer.
getWidth()Gets current value of property width.
pauseStep()Pauses the step that is currently playing.
playAllSteps(procedureId?)Plays all the steps in the specified procedure.
playStep(stepId, fromTheBeginning, continueToTheNext)Plays the specified procedure step.
refresh(oScene)Rebuilds the content of the Step Navigation control from the current Scene.
setGraphicsCore(graphicsCore)Attaches or detaches the Step Navigation control to the GraphicsCore object.
setHeight(sHeight)Sets a new value for property height.
setLayout(oLayout)Sets the aggregated layout.
setProcedureItemTemplate(oProcedureItemTemplate)Sets the aggregated procedureItemTemplate.
setScene(scene)Attaches a Scene object to the Step Navigation control so that it can access the Scene’s procedures and steps.
setSettings(oSettings)Sets a new value for property settings.
setShowStepInfo(bShowStepInfo)Sets a new value for property showStepInfo.
setShowThumbnails(bShowThumbnails)Sets a new value for property showThumbnails.
setShowToolbar(bShowToolbar)Sets a new value for property showToolbar.
setStepInfoPopup(oStepInfoPopup)Sets the aggregated stepInfoPopup.
setThumbnailsContainer(oThumbnailsContainer)Sets the aggregated thumbnailsContainer.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, 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, 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.vk.StepNavigation(sId?, mSettings?)
Constructor for a new StepNavigation.

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:

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

Parameters:
{string}sId? ID for the new control. This ID is generated automatically if no ID is provided.
{object}mSettings? Initial settings for the new Step Navigation control.
Event Detail
resize(oControlEvent)
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
stepChanged(oControlEvent)
Raised each time a step starts, changes, or finishes.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.vk.StepNavigation.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.StepNavigation 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.Control.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.vk.StepNavigation.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.StepNavigation.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachResize(oData?, fnFunction, oListener?): sap.ui.vk.StepNavigation
Attaches event handler fnFunction to the resize event of this sap.ui.vk.StepNavigation.

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.vk.StepNavigation itself.

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.vk.StepNavigation itself
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
attachStepChanged(oData?, fnFunction, oListener?): sap.ui.vk.StepNavigation
Attaches event handler fnFunction to the stepChanged event of this sap.ui.vk.StepNavigation.

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.vk.StepNavigation itself.

Raised each time a step starts, changes, or finishes.

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.vk.StepNavigation itself
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
clear(): boolean
Clears the content of the Step Navigation control.
Returns:
{boolean} Returns true if the method was called successfully.
destroyLayout(): sap.ui.vk.StepNavigation
Destroys the layout in the aggregation layout.
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
destroyProcedureItemTemplate(): sap.ui.vk.StepNavigation
Destroys the procedureItemTemplate in the aggregation procedureItemTemplate.
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
destroyStepInfoPopup(): sap.ui.vk.StepNavigation
Destroys the stepInfoPopup in the aggregation stepInfoPopup.
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
destroyThumbnailsContainer(): sap.ui.vk.StepNavigation
Destroys the thumbnailsContainer in the aggregation thumbnailsContainer.
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
detachResize(fnFunction, oListener): sap.ui.vk.StepNavigation
Detaches event handler fnFunction from the resize event of this sap.ui.vk.StepNavigation.

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.vk.StepNavigation} Reference to this in order to allow method chaining
detachStepChanged(fnFunction, oListener): sap.ui.vk.StepNavigation
Detaches event handler fnFunction from the stepChanged event of this sap.ui.vk.StepNavigation.

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.vk.StepNavigation} Reference to this in order to allow method chaining
fireResize(mArguments?): sap.ui.vk.StepNavigation
Fires event resize to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
fireStepChanged(mArguments?): sap.ui.vk.StepNavigation
Fires event stepChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Height of the Step Navigation control.

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property height
getLayout(): sap.m.Toolbar
Gets content of aggregation layout.

sap.m.Panel used to render the entire Step Navigation control's content.

Returns:
{sap.m.Toolbar}
getNextStep(procedureIndex?): JSON
Cycles through steps and procedures for the lastLoadedScene and returns the step that follows after the currentStepId.
Parameters:
{number}procedureIndex? Optional integer representing the index of the target procedure in the procedures list.
Returns:
{JSON} The step that follows after the current step.
getPreviousStep(procedureIndex?): JSON
Cycles through steps and procedures for the last loaded scene (lastLoadedScene), and returns the step preceding the current step (currentStepId.
Parameters:
{number}procedureIndex? Optional integer representing the index of the target procedure in the procedures list.
Returns:
{JSON} The step preceding the current step.
getProcedureItemTemplate(): sap.ui.core.Item
Gets content of aggregation procedureItemTemplate.

Template control for Procedure items.

Returns:
{sap.ui.core.Item}
getProceduresAndSteps(): JSON
Returns the procedures list with steps for the current scene, and appends base64 data as thumbnailData and an image type as thumbnailType.
Returns:
{JSON} For example: {sceneId : string, hasThumbnails : boolean, "procedures" : [id:string, name: string, steps: [{id: string, name: string, thumnailData: string, thumbnailType: string}], "portfolios": [] }
getSettings(): object
Gets current value of property settings.

Managed settings and properties for Step Navigation events.

Returns:
{object} Value of property settings
getShowStepInfo(): boolean
Gets current value of property showStepInfo.

Indicates that the Step Navigation control should display a popup containing information around the step that is playing. If set to true, then the popup is rendered. If set to false, the popup is hidden.

Default value is false.

Returns:
{boolean} Value of property showStepInfo
getShowThumbnails(): boolean
Gets current value of property showThumbnails.

Indicates that the Step Navigation control should display thumbnails. If set to true, then thumbnails are rendered. If set to false, then thumbnails are hidden.

Default value is true.

Returns:
{boolean} Value of property showThumbnails
getShowToolbar(): boolean
Gets current value of property showToolbar.

Indicates that the Step Navigation control should display a toolbar. If set to true, then the toolbar is rendered. If set to false, then the toolbar is hidden.

Default value is true.

Returns:
{boolean} Value of property showToolbar
getStep(relIndex, procedureIndex?, specificStepId): JSON
Gets a step based on a positive or negative integer, which is used as an index relative to the index of the current step. An index value of 0 can be used to retrieve the details of the current step.
Parameters:
{number}relIndex Positive or negative integer representing the number to add or subtract from the index of the current step to return the desired step; for example, //next 1, current 0, previous -1
{number}procedureIndex? Optional integer representing the index of the target procedure in the procedures list.
{string}specificStepId The ID of the step that we want to retrieve.
Returns:
{JSON} step
getStepInfoPopup(): sap.ui.core.Control
Gets content of aggregation stepInfoPopup.

sap.ui.core.Popup used to render step information in a popup.

Returns:
{sap.ui.core.Control}
getThumbnailsContainer(): sap.m.Panel
Gets content of aggregation thumbnailsContainer.

sap.m.Panel used to render a list of thumbnails for the available steps.

Returns:
{sap.m.Panel}
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the Step Navigation control.

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
pauseStep(): void
Pauses the step that is currently playing.
playAllSteps(procedureId?): void
Plays all the steps in the specified procedure.
Parameters:
{string}procedureId? The ID of the procedure for which to play all steps. If procedureId == null, then only the first step is played.
playStep(stepId, fromTheBeginning, continueToTheNext): void
Plays the specified procedure step.
Parameters:
{string}stepId The ID of the procedure step to play.
{boolean}fromTheBeginning Default: true If true, tells the Viewer to play the step from the first frame.
{boolean}continueToTheNext Default: false If true, tells the Viewer to play the next step in sequence.
refresh(oScene): boolean
Rebuilds the content of the Step Navigation control from the current Scene.
Parameters:
{object}oScene The scene object to be used.
Returns:
{boolean} Returns true if the content of the Step Navigation control was rebuilt successfully.
setGraphicsCore(graphicsCore): sap.ui.vk.StepNavigation
Attaches or detaches the Step Navigation control to the GraphicsCore object.

If the parameter graphicsCore is not null, a rendering object corresponding to the Viewport is created. If the parameter graphicsCore is null, the rendering object corresponding to the Viewport is destroyed.

Parameters:
{sap.ui.vk.GraphicsCore}graphicsCore The GraphicsCore object, or null.
Returns:
{sap.ui.vk.StepNavigation}this to allow method chaining.
setHeight(sHeight): sap.ui.vk.StepNavigation
Sets a new value for property height.

Height of the Step Navigation control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 100%.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setLayout(oLayout): sap.ui.vk.StepNavigation
Sets the aggregated layout.
Parameters:
{sap.m.Toolbar}oLayout The layout to set
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setProcedureItemTemplate(oProcedureItemTemplate): sap.ui.vk.StepNavigation
Sets the aggregated procedureItemTemplate.
Parameters:
{sap.ui.core.Item}oProcedureItemTemplate The procedureItemTemplate to set
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setScene(scene)
Attaches a Scene object to the Step Navigation control so that it can access the Scene’s procedures and steps.
Parameters:
{object}scene The Scene object to attach to the Step Navigation control.
setSettings(oSettings): sap.ui.vk.StepNavigation
Sets a new value for property settings.

Managed settings and properties for Step Navigation events.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{object}oSettings New value for property settings
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setShowStepInfo(bShowStepInfo): sap.ui.vk.StepNavigation
Sets a new value for property showStepInfo.

Indicates that the Step Navigation control should display a popup containing information around the step that is playing. If set to true, then the popup is rendered. If set to false, the popup is hidden.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bShowStepInfo New value for property showStepInfo
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setShowThumbnails(bShowThumbnails): sap.ui.vk.StepNavigation
Sets a new value for property showThumbnails.

Indicates that the Step Navigation control should display thumbnails. If set to true, then thumbnails are rendered. If set to false, then thumbnails are hidden.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowThumbnails New value for property showThumbnails
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setShowToolbar(bShowToolbar): sap.ui.vk.StepNavigation
Sets a new value for property showToolbar.

Indicates that the Step Navigation control should display a toolbar. If set to true, then the toolbar is rendered. If set to false, then the toolbar is hidden.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bShowToolbar New value for property showToolbar
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setStepInfoPopup(oStepInfoPopup): sap.ui.vk.StepNavigation
Sets the aggregated stepInfoPopup.
Parameters:
{sap.ui.core.Control}oStepInfoPopup The stepInfoPopup to set
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setThumbnailsContainer(oThumbnailsContainer): sap.ui.vk.StepNavigation
Sets the aggregated thumbnailsContainer.
Parameters:
{sap.m.Panel}oThumbnailsContainer The thumbnailsContainer to set
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.vk.StepNavigation
Sets a new value for property width.

Width of the Step Navigation control.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 100%.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.vk.StepNavigation} Reference to this in order to allow method chaining