class sap.ui.commons.ToolbarSeparator

Visiblity: public
UX Guidelines:
Implements: sap.ui.commons.ToolbarItem
Available since: N/A
Module: sap/ui/commons/ToolbarSeparator
Application Component: CA-UI5-CTR

A small vertical line that is generally added to the tool bar between the items to visually separate them.


Constructor

Constructor for a new ToolbarSeparator.

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.commons.ToolbarSeparator(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
design sap.ui.commons.ToolbarSeparatorDesign

Design of the Separator.

Visibility: public
displayVisualSeparator boolean true

When set to false, there is no visual indication of separation by a vertical line but by a wider space.

Visibility: public

Methods Overview

Method Description
sap.ui.commons.ToolbarSeparator.extend

Creates a new subclass of class sap.ui.commons.ToolbarSeparator 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.Element.extend.

getDesign

Gets current value of property design.

Design of the Separator.

getDisplayVisualSeparator

Gets current value of property displayVisualSeparator.

When set to false, there is no visual indication of separation by a vertical line but by a wider space.

Default value is true.

sap.ui.commons.ToolbarSeparator.getMetadata

Returns a metadata object for class sap.ui.commons.ToolbarSeparator.

setDesign

Sets a new value for property design.

Design of the Separator.

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

setDisplayVisualSeparator

Sets a new value for property displayVisualSeparator.

When set to false, there is no visual indication of separation by a vertical line but by a wider space.

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

Default value is true.

sap.ui.commons.ToolbarSeparator.extend

Creates a new subclass of class sap.ui.commons.ToolbarSeparator 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.Element.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

getDesign

Gets current value of property design.

Design of the Separator.

getDisplayVisualSeparator

Gets current value of property displayVisualSeparator.

When set to false, there is no visual indication of separation by a vertical line but by a wider space.

Default value is true.

sap.ui.commons.ToolbarSeparator.getMetadata

Returns a metadata object for class sap.ui.commons.ToolbarSeparator.

setDesign

Sets a new value for property design.

Design of the Separator.

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

Param Type DefaultValue Description
sDesign sap.ui.commons.ToolbarSeparatorDesign

New value for property design

setDisplayVisualSeparator

Sets a new value for property displayVisualSeparator.

When set to false, there is no visual indication of separation by a vertical line but by a wider space.

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

New value for property displayVisualSeparator