class sap.ui.vk.StepNavigation

Control sample: sap.ui.vk.StepNavigation
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/StepNavigation
Application Component: CA-UI5-VTK

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


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.StepNavigation(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control. This ID is generated automatically if no ID is provided.

mSettings? object

Initial settings for the new Step Navigation control.


Properties

Name Type Default Value Description
height sap.ui.core.CSSSize 100%

Height of the Step Navigation control.

Visibility: public
settings object

Managed settings and properties for Step Navigation events.

Visibility: public
showStepInfo boolean false

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.

Visibility: public
showThumbnails boolean true

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.

Visibility: public
showToolbar boolean true

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.

Visibility: public
width sap.ui.core.CSSSize 100%

Width of the Step Navigation control.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
layout 0..1 sap.m.Toolbar

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

procedureItemTemplate 0..1 sap.ui.core.Item

Template control for Procedure items.

stepInfoPopup 0..1 sap.ui.core.Control

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

thumbnailsContainer 0..1 sap.m.ScrollContainer

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


Associations

Name Cardinality Type Description
contentConnector 0..1 sap.ui.vk.ContentConnector

Events Overview

Event Description
resize
stepChanged

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

resize

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
oldSize object
size object

stepChanged

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
clientId object

The ID of the rendering client that raised the event.

type object

The type of sap.ve.dvl.DVLSTEPEVENT that has been raised; for example, DVLSTEPEVENT_FINISHED, DVLSTEPEVENT_SWITCHED, DVLSTEPEVENT_STARTED, DVLSTEPEVENT_PLAYING.

stepId object

The ID of the step affected by this stepId event.


Methods Overview

Method Description
attachResize

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.

attachStepChanged

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.

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

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.

detachStepChanged

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.

sap.ui.vk.StepNavigation.extend

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.

fireResize

Fires event resize to attached listeners.

fireStepChanged

Fires event stepChanged to attached listeners.

getContentConnector

ID of the element which is the current target of the association contentConnector, or null.

getHeight

Gets current value of property height.

Height of the Step Navigation control.

Default value is "100%".

getLayout

Gets content of aggregation layout.

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

sap.ui.vk.StepNavigation.getMetadata

Returns a metadata object for class sap.ui.vk.StepNavigation.

getNextStep

Cycles through steps and procedures for the lastLoadedScene and returns the step that follows after the currentStepId.

getPreviousStep

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.

Template control for Procedure items.

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.

Managed settings and properties for Step Navigation events.

getShowStepInfo

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.

getShowThumbnails

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.

getShowToolbar

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.

getStep

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.

getStepInfoPopup

Gets content of aggregation stepInfoPopup.

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

getThumbnailsContainer

Gets content of aggregation thumbnailsContainer.

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

getWidth

Gets current value of property width.

Width of the Step Navigation control.

Default value is "100%".

pauseStep

Pauses the step that is currently playing.

playAllSteps

Plays all the steps in the specified procedure.

playStep

Plays the specified procedure step.

refresh

Rebuilds the content of the Step Navigation control from the current Scene.

setContentConnector

Sets the associated contentConnector.

setHeight

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%".

setLayout

Sets the aggregated layout.

setProcedureItemTemplate

Sets the aggregated procedureItemTemplate.

setScene

Attaches a Scene object to the Step Navigation control so that it can access the Scene’s procedures and steps.

setSettings

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.

setShowStepInfo

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.

setShowThumbnails

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.

setShowToolbar

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.

setStepInfoPopup

Sets the aggregated stepInfoPopup.

setThumbnailsContainer

Sets the aggregated thumbnailsContainer.

setWidth

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%".

attachResize

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.StepNavigation itself

attachStepChanged

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.StepNavigation itself

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

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachStepChanged

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vk.StepNavigation.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireResize

Fires event resize to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

oldSize object
size object

fireStepChanged

Fires event stepChanged to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

clientId object

The ID of the rendering client that raised the event.

type object

The type of sap.ve.dvl.DVLSTEPEVENT that has been raised; for example, DVLSTEPEVENT_FINISHED, DVLSTEPEVENT_SWITCHED, DVLSTEPEVENT_STARTED, DVLSTEPEVENT_PLAYING.

stepId object

The ID of the step affected by this stepId event.

getContentConnector

ID of the element which is the current target of the association contentConnector, or null.

getHeight

Gets current value of property height.

Height of the Step Navigation control.

Default value is "100%".

getLayout

Gets content of aggregation layout.

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

sap.ui.vk.StepNavigation.getMetadata

Returns a metadata object for class sap.ui.vk.StepNavigation.

getNextStep

Cycles through steps and procedures for the lastLoadedScene and returns the step that follows after the currentStepId.

Param Type DefaultValue Description
procedureIndex number

Optional integer representing the index of the target procedure in the procedures list.

getPreviousStep

Cycles through steps and procedures for the last loaded scene (lastLoadedScene), and returns the step preceding the current step (currentStepId.

Param Type DefaultValue Description
procedureIndex number

Optional integer representing the index of the target procedure in the procedures list.

getProcedureItemTemplate

Gets content of aggregation procedureItemTemplate.

Template control for Procedure items.

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.

Managed settings and properties for Step Navigation events.

getShowStepInfo

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.

getShowThumbnails

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.

getShowToolbar

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.

getStep

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.

Param Type DefaultValue Description
relIndex number

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

procedureIndex number

Optional integer representing the index of the target procedure in the procedures list.

specificStepId string

The ID of the step that we want to retrieve.

getStepInfoPopup

Gets content of aggregation stepInfoPopup.

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

getThumbnailsContainer

Gets content of aggregation thumbnailsContainer.

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

getWidth

Gets current value of property width.

Width of the Step Navigation control.

Default value is "100%".

pauseStep

Pauses the step that is currently playing.

playAllSteps

Plays all the steps in the specified procedure.

Param Type DefaultValue Description
procedureId string

The ID of the procedure for which to play all steps. If procedureId == null, then only the first step is played.

playStep

Plays the specified procedure step.

Param Type DefaultValue Description
stepId string

The ID of the procedure step to play.

fromTheBeginning boolean

Default: true If true, tells the Viewer to play the step from the first frame.

continueToTheNext boolean

Default: false If true, tells the Viewer to play the next step in sequence.

refresh

Rebuilds the content of the Step Navigation control from the current Scene.

Param Type DefaultValue Description
oScene object

The scene object to be used.

setContentConnector

Sets the associated contentConnector.

Param Type DefaultValue Description
oContentConnector sap.ui.core.ID sap.ui.vk.ContentConnector

ID of an element which becomes the new target of this contentConnector association; alternatively, an element instance may be given

setHeight

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%".

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize "100%"

New value for property height

setLayout

Sets the aggregated layout.

Param Type DefaultValue Description
oLayout sap.m.Toolbar

The layout to set

setProcedureItemTemplate

Sets the aggregated procedureItemTemplate.

Param Type DefaultValue Description
oProcedureItemTemplate sap.ui.core.Item

The procedureItemTemplate to set

setScene

Attaches a Scene object to the Step Navigation control so that it can access the Scene’s procedures and steps.

Param Type DefaultValue Description
scene object

The Scene object to attach to the Step Navigation control.

setSettings

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.

Param Type DefaultValue Description
oSettings object

New value for property settings

setShowStepInfo

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.

Param Type DefaultValue Description
bShowStepInfo boolean false

New value for property showStepInfo

setShowThumbnails

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.

Param Type DefaultValue Description
bShowThumbnails boolean true

New value for property showThumbnails

setShowToolbar

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.

Param Type DefaultValue Description
bShowToolbar boolean true

New value for property showToolbar

setStepInfoPopup

Sets the aggregated stepInfoPopup.

Param Type DefaultValue Description
oStepInfoPopup sap.ui.core.Control

The stepInfoPopup to set

setThumbnailsContainer

Sets the aggregated thumbnailsContainer.

Param Type DefaultValue Description
oThumbnailsContainer sap.m.ScrollContainer

The thumbnailsContainer to set

setWidth

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%".

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize "100%"

New value for property width