class sap.ui.vk.ViewGroup

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

Provides the interface for the view.


Constructor

Constructor for a new View Group.

The objects of this class contain necessary information about View Group

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.ViewGroup()

Properties

Name Type Default Value Description
description string Visibility: public
name string Visibility: public
viewGroupId string Visibility: public

Methods Overview

Method Description
addView

Add a view to the view group

sap.ui.vk.ViewGroup.extend

Creates a new subclass of class sap.ui.vk.ViewGroup 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.base.ManagedObject.extend.

getDescription

Gets current value of property description.

sap.ui.vk.ViewGroup.getMetadata

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

getName

Gets current value of property name.

getViewGroupId

Gets current value of property viewGroupId.

getViews

Gets a list of views

indexOfView

Gets index of a view in the view group

insertView

Inserts a view

removeView

Removes a view from the view group

removeViews

Removes all views from the view group

setDescription

Sets a new value for property description.

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

setName

Sets a new value for property name.

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

setViewGroupId

Sets a new value for property viewGroupId.

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

addView

Add a view to the view group

Param Type DefaultValue Description
view sap.ui.vk.View

view to add

sap.ui.vk.ViewGroup.extend

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

getDescription

Gets current value of property description.

sap.ui.vk.ViewGroup.getMetadata

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

getName

Gets current value of property name.

getViewGroupId

Gets current value of property viewGroupId.

getViews

Gets a list of views

indexOfView

Gets index of a view in the view group

Param Type DefaultValue Description
view sap.ui.vk.View

view to locate

insertView

Inserts a view

Param Type DefaultValue Description
view sap.ui.vk.View

view to insert

index int

index where to insert the view

removeView

Removes a view from the view group

Param Type DefaultValue Description
view sap.ui.vk.View

view to remove

removeViews

Removes all views from the view group

setDescription

Sets a new value for property description.

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

Param Type DefaultValue Description
sDescription string

New value for property description

setName

Sets a new value for property name.

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

Param Type DefaultValue Description
sName string

New value for property name

setViewGroupId

Sets a new value for property viewGroupId.

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

Param Type DefaultValue Description
sViewGroupId string

New value for property viewGroupId