class sap.uxap.ObjectPageHeaderLayoutData

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/uxap/ObjectPageHeaderLayoutData
Application Component: CA-UI5-CTR

A sap.ui.core.LayoutData element that can be added to controls used in the headerContent aggregation of the ObjectPageLayout.

Note: This element is only taken into account when the sap.uxap.ObjectPageLayout control is used together with sap.uxap.ObjectPageHeader as value of headerTitle.


Constructor

Constructor for a new ObjectPageHeaderLayoutData.

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.uxap.ObjectPageHeaderLayoutData(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
showSeparatorAfter boolean false

If this property is set the control will display a separator after it.

Visibility: public
showSeparatorBefore boolean false

If this property is set the control will display a separator before it.

Visibility: public
visibleL boolean true

If this property is set the control will be visible (or not) in a large sized layout.

Visibility: public
visibleM boolean true

If this property is set the control will be visible (or not) in a medium sized layout.

Visibility: public
visibleS boolean true

If this property is set the control will be visible (or not) in a small sized layout.

Visibility: public
width sap.ui.core.CSSSize auto

If this property is set the control will take the provided size.

Visibility: public

Methods Overview

Method Description
sap.uxap.ObjectPageHeaderLayoutData.extend

Creates a new subclass of class sap.uxap.ObjectPageHeaderLayoutData 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.LayoutData.extend.

sap.uxap.ObjectPageHeaderLayoutData.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.

getShowSeparatorAfter

Gets current value of property showSeparatorAfter.

If this property is set the control will display a separator after it.

Default value is false.

getShowSeparatorBefore

Gets current value of property showSeparatorBefore.

If this property is set the control will display a separator before it.

Default value is false.

getVisibleL

Gets current value of property visibleL.

If this property is set the control will be visible (or not) in a large sized layout.

Default value is true.

getVisibleM

Gets current value of property visibleM.

If this property is set the control will be visible (or not) in a medium sized layout.

Default value is true.

getVisibleS

Gets current value of property visibleS.

If this property is set the control will be visible (or not) in a small sized layout.

Default value is true.

getWidth

Gets current value of property width.

If this property is set the control will take the provided size.

Default value is 'auto'.

setShowSeparatorAfter

Sets a new value for property showSeparatorAfter.

If this property is set the control will display a separator after it.

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

Default value is false.

setShowSeparatorBefore

Sets a new value for property showSeparatorBefore.

If this property is set the control will display a separator before it.

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

Default value is false.

setVisibleL

Sets a new value for property visibleL.

If this property is set the control will be visible (or not) in a large sized layout.

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

Default value is true.

setVisibleM

Sets a new value for property visibleM.

If this property is set the control will be visible (or not) in a medium sized layout.

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

Default value is true.

setVisibleS

Sets a new value for property visibleS.

If this property is set the control will be visible (or not) in a small sized layout.

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

Default value is true.

setWidth

Sets a new value for property width.

If this property is set the control will take the provided size.

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

Default value is 'auto'.

sap.uxap.ObjectPageHeaderLayoutData.extend

Creates a new subclass of class sap.uxap.ObjectPageHeaderLayoutData 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.LayoutData.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

sap.uxap.ObjectPageHeaderLayoutData.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.

getShowSeparatorAfter

Gets current value of property showSeparatorAfter.

If this property is set the control will display a separator after it.

Default value is false.

getShowSeparatorBefore

Gets current value of property showSeparatorBefore.

If this property is set the control will display a separator before it.

Default value is false.

getVisibleL

Gets current value of property visibleL.

If this property is set the control will be visible (or not) in a large sized layout.

Default value is true.

getVisibleM

Gets current value of property visibleM.

If this property is set the control will be visible (or not) in a medium sized layout.

Default value is true.

getVisibleS

Gets current value of property visibleS.

If this property is set the control will be visible (or not) in a small sized layout.

Default value is true.

getWidth

Gets current value of property width.

If this property is set the control will take the provided size.

Default value is 'auto'.

setShowSeparatorAfter

Sets a new value for property showSeparatorAfter.

If this property is set the control will display a separator after it.

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

New value for property showSeparatorAfter

setShowSeparatorBefore

Sets a new value for property showSeparatorBefore.

If this property is set the control will display a separator before it.

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

New value for property showSeparatorBefore

setVisibleL

Sets a new value for property visibleL.

If this property is set the control will be visible (or not) in a large sized layout.

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

New value for property visibleL

setVisibleM

Sets a new value for property visibleM.

If this property is set the control will be visible (or not) in a medium sized layout.

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

New value for property visibleM

setVisibleS

Sets a new value for property visibleS.

If this property is set the control will be visible (or not) in a small sized layout.

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

New value for property visibleS

setWidth

Sets a new value for property width.

If this property is set the control will take the provided size.

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

Default value is 'auto'.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize 'auto'

New value for property width