class sap.ui.vk.ViewGallery

Control sample: sap.ui.vk.ViewGallery
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/ViewGallery
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 ViewGallery.

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.ViewGallery(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 View Gallery control.


Properties

Name Type Default Value Description
enableViewReordering boolean false

Indicates that the View Gallery control should allow view reordering

Visibility: public
enabled boolean true

If disabled, view gallery is non-interactive and greyed out

Visibility: public
selectedViewGroupIndex int -1

Index of selected view group

Visibility: public
selectedViewIndex int -1

Index of selected view

Visibility: public
showAnimationTimeSlider boolean true

Indicates that the View Gallery control should display animation slider showing time of animation in current view.

Visibility: public
showThumbnailContainer boolean true

Indicates that the View Gallery control should display thumbnails

Visibility: public
showToolbar boolean true

Indicates that the View Gallery control should display toolbar

Visibility: public
transparency float 1

Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% opaque

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
animationTimeSlider 0..1 sap.m.Slider
container 0..1 sap.m.ScrollContainer

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

toolbar 0..1 sap.m.Toolbar

sap.m.Toolbar used to render the entire View Gallery control's content.


Associations

Name Cardinality Type Description
animationPlayer 0..1 sap.ui.vk.AnimationPlayer
contentConnector 0..1 sap.ui.vk.ContentConnector
host 0..1 sap.ui.vk.ViewportBase
viewManager 0..1 sap.ui.vk.ViewManager

Events Overview

Event Description
selectionChange

Fires when selection is changed via user interaction inside the control.

viewOrderChange

Fires when views are reordered

selectionChange

Fires when selection is changed via user interaction inside the control.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
item sap.ui.core.Control

viewOrderChange

Fires when views are reordered

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
view sap.ui.vk.View
viewIndex int

Methods Overview

Method Description
attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.vk.ViewGallery.

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.ViewGallery itself.

Fires when selection is changed via user interaction inside the control.

attachViewOrderChange

Attaches event handler fnFunction to the viewOrderChange event of this sap.ui.vk.ViewGallery.

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.ViewGallery itself.

Fires when views are reordered

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.vk.ViewGallery.

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

detachViewOrderChange

Detaches event handler fnFunction from the viewOrderChange event of this sap.ui.vk.ViewGallery.

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

sap.ui.vk.ViewGallery.extend

Creates a new subclass of class sap.ui.vk.ViewGallery 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.

fireSelectionChange

Fires event selectionChange to attached listeners.

fireViewOrderChange

Fires event viewOrderChange to attached listeners.

getAnimationPlayer

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

getContentConnector

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

getEnabled

Gets current value of property enabled.

If disabled, view gallery is non-interactive and greyed out

Default value is true.

getEnableViewReordering

Gets current value of property enableViewReordering.

Indicates that the View Gallery control should allow view reordering

Default value is false.

getHost

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

sap.ui.vk.ViewGallery.getMetadata

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

getSelectedViewGroupIndex

Retrieves the index of the selected view group.

getSelectedViewIndex

Retrieves the index of the selected view.

getShowAnimationTimeSlider

Gets current value of property showAnimationTimeSlider.

Indicates that the View Gallery control should display animation slider showing time of animation in current view.

Default value is true.

getShowThumbnailContainer

Gets current value of property showThumbnailContainer.

Indicates that the View Gallery control should display thumbnails

Default value is true.

getShowToolbar

Gets current value of property showToolbar.

Indicates that the View Gallery control should display toolbar

Default value is true.

getTransparency

Gets current value of property transparency.

Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% opaque

Default value is 1.

getViewManager

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

setAnimationPlayer

Sets the associated animationPlayer.

setContentConnector

Sets the associated contentConnector.

setEnabled

Sets a new value for property enabled.

If disabled, view gallery is non-interactive and greyed out

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

Default value is true.

setEnableViewReordering

Sets a new value for property enableViewReordering.

Indicates that the View Gallery control should allow view reordering

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

Default value is false.

setHost

Sets the associated host.

setPlayingAnimation

Set if playing animation when activating view or playing procedure

setScene

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

setSelectedViewGroupIndex

Selects view group with given index. This will reload list of views.

setSelectedViewIndex

Selects view with given view index.

setShowAnimationTimeSlider

Sets a new value for property showAnimationTimeSlider.

Indicates that the View Gallery control should display animation slider showing time of animation in current view.

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

Default value is true.

setShowThumbnailContainer

Sets a new value for property showThumbnailContainer.

Indicates that the View Gallery control should display thumbnails

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 View Gallery control should display toolbar

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

Default value is true.

setTransparency

Sets a new value for property transparency.

Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% opaque

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

Default value is 1.

setViewManager

Sets the associated viewManager.

attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.vk.ViewGallery.

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.ViewGallery itself.

Fires when selection is changed via user interaction inside the control.

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.ViewGallery itself

attachViewOrderChange

Attaches event handler fnFunction to the viewOrderChange event of this sap.ui.vk.ViewGallery.

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.ViewGallery itself.

Fires when views are reordered

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.ViewGallery itself

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.vk.ViewGallery.

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

detachViewOrderChange

Detaches event handler fnFunction from the viewOrderChange event of this sap.ui.vk.ViewGallery.

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.ViewGallery.extend

Creates a new subclass of class sap.ui.vk.ViewGallery 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

fireSelectionChange

Fires event selectionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

item sap.ui.core.Control

fireViewOrderChange

Fires event viewOrderChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

view sap.ui.vk.View
viewIndex int

getAnimationPlayer

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

getContentConnector

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

getEnabled

Gets current value of property enabled.

If disabled, view gallery is non-interactive and greyed out

Default value is true.

getEnableViewReordering

Gets current value of property enableViewReordering.

Indicates that the View Gallery control should allow view reordering

Default value is false.

getHost

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

sap.ui.vk.ViewGallery.getMetadata

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

getSelectedViewGroupIndex

Retrieves the index of the selected view group.

getSelectedViewIndex

Retrieves the index of the selected view.

getShowAnimationTimeSlider

Gets current value of property showAnimationTimeSlider.

Indicates that the View Gallery control should display animation slider showing time of animation in current view.

Default value is true.

getShowThumbnailContainer

Gets current value of property showThumbnailContainer.

Indicates that the View Gallery control should display thumbnails

Default value is true.

getShowToolbar

Gets current value of property showToolbar.

Indicates that the View Gallery control should display toolbar

Default value is true.

getTransparency

Gets current value of property transparency.

Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% opaque

Default value is 1.

getViewManager

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

setAnimationPlayer

Sets the associated animationPlayer.

Param Type DefaultValue Description
oAnimationPlayer sap.ui.core.ID sap.ui.vk.AnimationPlayer

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

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

setEnabled

Sets a new value for property enabled.

If disabled, view gallery is non-interactive and greyed out

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
bEnabled boolean true

New value for property enabled

setEnableViewReordering

Sets a new value for property enableViewReordering.

Indicates that the View Gallery control should allow view reordering

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
bEnableViewReordering boolean false

New value for property enableViewReordering

setHost

Sets the associated host.

Param Type DefaultValue Description
oHost sap.ui.core.ID sap.ui.vk.ViewportBase

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

setPlayingAnimation

Set if playing animation when activating view or playing procedure

Param Type DefaultValue Description
play boolean

true if playing animation

setScene

Attaches a Scene object to the View Gallery 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 View Gallery control.

setSelectedViewGroupIndex

Selects view group with given index. This will reload list of views.

Param Type DefaultValue Description
index int

Index of view group to become selected.

viewIndex int

Index of view in view group to become selected

setSelectedViewIndex

Selects view with given view index.

Param Type DefaultValue Description
index int

Index of view to become selected.

setShowAnimationTimeSlider

Sets a new value for property showAnimationTimeSlider.

Indicates that the View Gallery control should display animation slider showing time of animation in current view.

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
bShowAnimationTimeSlider boolean true

New value for property showAnimationTimeSlider

setShowThumbnailContainer

Sets a new value for property showThumbnailContainer.

Indicates that the View Gallery control should display thumbnails

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
bShowThumbnailContainer boolean true

New value for property showThumbnailContainer

setShowToolbar

Sets a new value for property showToolbar.

Indicates that the View Gallery control should display toolbar

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

setTransparency

Sets a new value for property transparency.

Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% opaque

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

Default value is 1.

Param Type DefaultValue Description
fTransparency float 1

New value for property transparency

setViewManager

Sets the associated viewManager.

Param Type DefaultValue Description
oViewManager sap.ui.core.ID sap.ui.vk.ViewManager

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