ObjectPageHeaderLayoutData

extends LayoutData

This is a LayoutData Element that can be added to a control if this control is used within an ObjectPage headerContent aggregation

Since: 1.26.

Constructor Summary

new sap.uxap.ObjectPageHeaderLayoutData(sId?, mSettings?)Constructor for a new ObjectPageHeaderLayoutData.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.uxap.ObjectPageHeaderLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageHeaderLayoutData with name sClassName and enriches it with the information contained in oClassInfo.

sap.uxap.ObjectPageHeaderLayoutData.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageHeaderLayoutData.

getShowSeparatorAfter()Gets current value of property showSeparatorAfter.

getShowSeparatorBefore()Gets current value of property showSeparatorBefore.

getVisibleL()Gets current value of property visibleL.

getVisibleM()Gets current value of property visibleM.

getVisibleS()Gets current value of property visibleS.

getWidth()Gets current value of property width.

setShowSeparatorAfter(bShowSeparatorAfter)Sets a new value for property showSeparatorAfter.

setShowSeparatorBefore(bShowSeparatorBefore)Sets a new value for property showSeparatorBefore.

setVisibleL(bVisibleL)Sets a new value for property visibleL.

setVisibleM(bVisibleM)Sets a new value for property visibleM.

setVisibleS(bVisibleS)Sets a new value for property visibleS.

setWidth(sWidth)Sets a new value for property width.

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.uxap.ObjectPageHeaderLayoutData(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- visibleS : boolean (default: true)
- visibleM : boolean (default: true)
- visibleL : boolean (default: true)
- showSeparatorBefore : boolean (default: false)
- showSeparatorAfter : boolean (default: false)
- width : sap.ui.core.CSSSize (default: auto)

In addition, all settings applicable to the base type sap.ui.core.LayoutData can be used as well.

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	initial settings for the new control

Method Detail

sap.uxap.ObjectPageHeaderLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.uxap.ObjectPageHeaderLayoutData.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getShowSeparatorAfter(): boolean

Gets current value of property showSeparatorAfter.

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

Default value is false.

Returns:

{boolean} Value of property showSeparatorAfter

getShowSeparatorBefore(): boolean

Gets current value of property showSeparatorBefore.

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

Default value is false.

Returns:

{boolean} Value of property showSeparatorBefore

getVisibleL(): boolean

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.

Returns:

{boolean} Value of property visibleL

getVisibleM(): boolean

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.

Returns:

{boolean} Value of property visibleM

getVisibleS(): boolean

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.

Returns:

{boolean} Value of property visibleS

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

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

Default value is auto.

Returns:

{sap.ui.core.CSSSize} Value of property width

setShowSeparatorAfter(bShowSeparatorAfter): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{boolean} bShowSeparatorAfter New value for property showSeparatorAfter

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining

setShowSeparatorBefore(bShowSeparatorBefore): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{boolean} bShowSeparatorBefore New value for property showSeparatorBefore

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining

setVisibleL(bVisibleL): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{boolean} bVisibleL New value for property visibleL

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining

setVisibleM(bVisibleM): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{boolean} bVisibleM New value for property visibleM

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining

setVisibleS(bVisibleS): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{boolean} bVisibleS New value for property visibleS

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining

setWidth(sWidth): sap.uxap.ObjectPageHeaderLayoutData

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.

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

{sap.uxap.ObjectPageHeaderLayoutData} Reference to this in order to allow method chaining