class sap.ui.vk.Toolbar

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

Provides buttons to hide or show certain sap.ui.vk controls.


Constructor

Constructor for a new Toolbar.

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.Toolbar(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
title string empty string

Used to set the title of the Toolbar

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_enterFullScreenButton 0..1 sap.m.ToggleButton
_exitFullScreenButton 0..1 sap.m.Button
_helpButton 0..1 sap.m.Button
_sceneTreeButton 0..1 sap.m.ToggleButton
_stepNavigationButton 0..1 sap.m.ToggleButton
_toolbar 0..1 sap.m.Toolbar
_toolbarTitle 0..1 sap.m.Title
content 0..n sap.ui.core.Control

Toolbar content, this can be used to add/remove buttons and other SAP UI5 controls to the toolbar


Associations

Name Cardinality Type Description
viewer 0..1 sap.ui.vk.Viewer

A toolbar instance is associated with an instance of the Viewer


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.vk.Toolbar.extend

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

getContent

Gets content of aggregation content.

Toolbar content, this can be used to add/remove buttons and other SAP UI5 controls to the toolbar

sap.ui.vk.Toolbar.getMetadata

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

getTitle

Gets current value of property title.

Used to set the title of the Toolbar

Default value is empty string.

getViewer

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

indexOfContent

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

insertContent

Inserts a content into the aggregation content.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

setTitle

Sets a new value for property title.

Used to set the title of the Toolbar

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

Default value is empty string.

setViewer

Sets the associated viewer.

addContent

Adds some content to the aggregation content.

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

The content to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

sap.ui.vk.Toolbar.extend

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

getContent

Gets content of aggregation content.

Toolbar content, this can be used to add/remove buttons and other SAP UI5 controls to the toolbar

sap.ui.vk.Toolbar.getMetadata

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

getTitle

Gets current value of property title.

Used to set the title of the Toolbar

Default value is empty string.

getViewer

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

indexOfContent

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

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

The content whose index is looked for

insertContent

Inserts a content into the aggregation content.

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

The content to insert; if empty, nothing is inserted

iIndex int

The 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.core.Control

The content to remove or its index or id

setTitle

Sets a new value for property title.

Used to set the title of the Toolbar

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

Default value is empty string.

Param Type DefaultValue Description
sTitle string ""

New value for property title

setViewer

Sets the associated viewer.

Param Type DefaultValue Description
oViewer sap.ui.core.ID sap.ui.vk.Viewer

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