class sap.ui.vk.ContainerBase

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

Abstract Constructor for a new Container.


Constructor

Abstract Constructor for a new Container.

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.ContainerBase(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
autoAdjustHeight boolean false Visibility: public
fullScreen boolean false

Controls whether the control is show fullscreen or embedded

Visibility: public
showFullScreen boolean true

Show fullscreen toggle button in toolbar

Visibility: public
showSelection boolean true

Show selection button in toolbar

Visibility: public
showSettings boolean true

Show settings button in toolbar

Visibility: public
title string empty string

Title to show in toolbar

Visibility: public

Aggregations

Default Aggregation: content

Name Cardinality Type Description
content (default) 0..n sap.ui.vk.ContainerContent

Content Aggregation.

toolbar 0..1 sap.m.Toolbar

Toolbar aggregation


Associations

Name Cardinality Type Description
ariaDescribedBy 0..n sap.ui.core.Control

Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby).

ariaLabelledBy 0..n sap.ui.core.Control

Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy).


Events Overview

Event Description
contentChange
settingsPressed

contentChange

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

settingsPressed

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

Methods Overview

Method Description
_addToolbarContent

adjusts customizable buttons of overflow toolbar, displays content buttons

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

addContent

add container content - map, table..

attachContentChange

Attaches event handler fnFunction to the contentChange event of this sap.ui.vk.ContainerBase.

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

attachSettingsPressed

Attaches event handler fnFunction to the settingsPressed event of this sap.ui.vk.ContainerBase.

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

destroyContent

Destroys all the content in the aggregation content.

detachContentChange

Detaches event handler fnFunction from the contentChange event of this sap.ui.vk.ContainerBase.

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

detachSettingsPressed

Detaches event handler fnFunction from the settingsPressed event of this sap.ui.vk.ContainerBase.

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

sap.ui.vk.ContainerBase.extend

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

fireContentChange

Fires event contentChange to attached listeners.

fireSettingsPressed

Fires event settingsPressed to attached listeners.

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getAutoAdjustHeight

Gets current value of property autoAdjustHeight.

Default value is false.

getContent

Gets content of aggregation content.

Content Aggregation.

getFullScreen

Gets current value of property fullScreen.

Controls whether the control is show fullscreen or embedded

Default value is false.

sap.ui.vk.ContainerBase.getMetadata

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

getSelectedContent

get selected content

getShowFullScreen

Gets current value of property showFullScreen.

Show fullscreen toggle button in toolbar

Default value is true.

getShowSelection

Gets current value of property showSelection.

Show selection button in toolbar

Default value is true.

getShowSettings

Gets current value of property showSettings.

Show settings button in toolbar

Default value is true.

getTitle

Gets current value of property title.

Title to show in toolbar

Default value is empty string.

indexOfContent

Checks for the provided sap.ui.vk.ContainerContent in the aggregation content. and returns its index if found or -1 otherwise.

insertContent

insert container content - map, table..

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

removeContent

Removes a content from the aggregation content.

setAutoAdjustHeight

Sets a new value for property autoAdjustHeight.

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

Default value is false.

setFullScreen

set FullScreen - default is normal mode, but app can call this method to set the default to full screen

setSelectedContent

set selected content

setShowFullScreen

Sets a new value for property showFullScreen.

Show fullscreen toggle button in toolbar

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

Default value is true.

setShowSelection

Sets a new value for property showSelection.

Show selection button in toolbar

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

Default value is true.

setShowSettings

Sets a new value for property showSettings.

Show settings button in toolbar

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

Default value is true.

setTitle

Display title

switchContent

default Content could be defined in application

updateContainer

update container to allow dynamic change button layout

_addToolbarContent

adjusts customizable buttons of overflow toolbar, displays content buttons

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to add; if empty, nothing is inserted

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to add; if empty, nothing is inserted

addContent

add container content - map, table..

Param Type DefaultValue Description
oObject sap.ui.vk.ContainerContent

content object to add

attachContentChange

Attaches event handler fnFunction to the contentChange event of this sap.ui.vk.ContainerBase.

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

attachSettingsPressed

Attaches event handler fnFunction to the settingsPressed event of this sap.ui.vk.ContainerBase.

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

destroyContent

Destroys all the content in the aggregation content.

detachContentChange

Detaches event handler fnFunction from the contentChange event of this sap.ui.vk.ContainerBase.

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

detachSettingsPressed

Detaches event handler fnFunction from the settingsPressed event of this sap.ui.vk.ContainerBase.

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

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

fireContentChange

Fires event contentChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

selectedItemId string

fireSettingsPressed

Fires event settingsPressed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getAutoAdjustHeight

Gets current value of property autoAdjustHeight.

Default value is false.

getContent

Gets content of aggregation content.

Content Aggregation.

getFullScreen

Gets current value of property fullScreen.

Controls whether the control is show fullscreen or embedded

Default value is false.

sap.ui.vk.ContainerBase.getMetadata

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

getSelectedContent

get selected content

getShowFullScreen

Gets current value of property showFullScreen.

Show fullscreen toggle button in toolbar

Default value is true.

getShowSelection

Gets current value of property showSelection.

Show selection button in toolbar

Default value is true.

getShowSettings

Gets current value of property showSettings.

Show settings button in toolbar

Default value is true.

getTitle

Gets current value of property title.

Title to show in toolbar

Default value is empty string.

indexOfContent

Checks for the provided sap.ui.vk.ContainerContent in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.vk.ContainerContent

The content whose index is looked for

insertContent

insert container content - map, table..

Param Type DefaultValue Description
oObject sap.ui.vk.ContainerContent

content object to insert

iIndex int

index in the content aggregation where to insert the new content object

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy int sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to be removed or its index or ID

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy int sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to be removed or its index or ID

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.vk.ContainerContent

The content to remove or its index or id

setAutoAdjustHeight

Sets a new value for property autoAdjustHeight.

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

New value for property autoAdjustHeight

setFullScreen

set FullScreen - default is normal mode, but app can call this method to set the default to full screen

Param Type DefaultValue Description
bFullScreen boolean

Fullscreen mode on or off

setSelectedContent

set selected content

Param Type DefaultValue Description
oContent sap.ui.vk.ContainerContent

the selected content; involves no re-rendering

setShowFullScreen

Sets a new value for property showFullScreen.

Show fullscreen toggle button in 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
bShowFullScreen boolean true

New value for property showFullScreen

setShowSelection

Sets a new value for property showSelection.

Show selection button in 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
bShowSelection boolean true

New value for property showSelection

setShowSettings

Sets a new value for property showSettings.

Show settings button in 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
bShowSettings boolean true

New value for property showSettings

setTitle

Display title

Param Type DefaultValue Description
sValue string

the title

switchContent

default Content could be defined in application

Param Type DefaultValue Description
oContent sap.ui.vk.ContainerContent

the content to be visible; involves re-rendering

updateContainer

update container to allow dynamic change button layout