Class sap.ui.commons.layout.BorderLayoutAreaModule: sap/ui/commons/layout/BorderLayoutArea

extends Element

The BorderLayoutArea represents one area of a BorderLayout

Deprecated API:Since version 1.38. Instead, use the sap.m.Page control.

Constructor Summary
new sap.ui.commons.layout.BorderLayoutArea(sId?, mSettings?)Constructor for a new layout/BorderLayoutArea.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.commons.layout.BorderLayoutArea.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.layout.BorderLayoutArea with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.layout.BorderLayoutArea.getMetadata()Returns a metadata object for class sap.ui.commons.layout.BorderLayoutArea.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
getContentAlign()Gets current value of property contentAlign.
getOverflowX()Gets current value of property overflowX.
getOverflowY()Gets current value of property overflowY.
getSize()Gets current value of property size.
getVisible()Gets current value of property visible.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setContentAlign(sContentAlign)Sets a new value for property contentAlign.
setOverflowX(sOverflowX)Sets a new value for property overflowX.
setOverflowY(sOverflowY)Sets a new value for property overflowY.
setSize(sSize)Sets a new value for property size.
setVisible(bVisible)Sets a new value for property visible.
getAreaId()Gets current value of property areaId.
setAreaId(sAreaId)Sets a new value for property areaId.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
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.ui.commons.layout.BorderLayoutArea(sId?, mSettings?)
Constructor for a new layout/BorderLayoutArea.

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
    • areaId : sap.ui.commons.layout.BorderLayoutAreaTypes (default: top)
    • overflowX : string (default: auto)
    • overflowY : string (default: auto)
    • contentAlign : string (default: left)
    • size : sap.ui.core.CSSSize (default: 100px)
    • visible : boolean (default: true)
  • Aggregations
    • content : sap.ui.core.Control[] (default)

In addition, all settings applicable to the base type sap.ui.core.Element 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
Deprecated:
Since version 1.38. Instead, use the sap.m.Page control.
Method Detail
sap.ui.commons.layout.BorderLayoutArea.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.layout.BorderLayoutArea 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.

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.ui.commons.layout.BorderLayoutArea.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.layout.BorderLayoutArea.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.ui.commons.layout.BorderLayoutArea
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
destroyContent(): sap.ui.commons.layout.BorderLayoutArea
Destroys all the content in the aggregation content.
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

Controls within the area

Returns:
{sap.ui.core.Control[]}
getContentAlign(): string
Gets current value of property contentAlign.

The content alignment as CSS value

Default value is left.

Returns:
{string} Value of property contentAlign
getOverflowX(): string
Gets current value of property overflowX.

The overflow mode of the area in horizontal direction as CSS value

Default value is auto.

Returns:
{string} Value of property overflowX
getOverflowY(): string
Gets current value of property overflowY.

The overflow mode of the area in vertical direction as CSS value

Default value is auto.

Returns:
{string} Value of property overflowY
getSize(): sap.ui.core.CSSSize
Gets current value of property size.

Defines the height or the width. Is not used when the area element is in Center.

Default value is 100px.

Returns:
{sap.ui.core.CSSSize} Value of property size
getVisible(): boolean
Gets current value of property visible.

Invisible controls are not rendered

Default value is true.

Returns:
{boolean} Value of property visible
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.commons.layout.BorderLayoutArea
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
setContentAlign(sContentAlign): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property contentAlign.

The content alignment as CSS value

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

Default value is left.

Parameters:
{string}sContentAlign New value for property contentAlign
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
setOverflowX(sOverflowX): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property overflowX.

The overflow mode of the area in horizontal direction as CSS value

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

Default value is auto.

Parameters:
{string}sOverflowX New value for property overflowX
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
setOverflowY(sOverflowY): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property overflowY.

The overflow mode of the area in vertical direction as CSS value

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

Default value is auto.

Parameters:
{string}sOverflowY New value for property overflowY
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
setSize(sSize): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property size.

Defines the height or the width. Is not used when the area element is in Center.

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

Default value is 100px.

Parameters:
{sap.ui.core.CSSSize}sSize New value for property size
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
setVisible(bVisible): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property visible.

Invisible controls are not rendered

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

Default value is true.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining
getAreaId(): sap.ui.commons.layout.BorderLayoutAreaTypes
Gets current value of property areaId.

Defines which area the element represents: top, begin, center, end, bottom

Default value is top.

Deprecated:
Since version 1.3.3. Redundant to the aggregation by the parent border layout.
Returns:
{sap.ui.commons.layout.BorderLayoutAreaTypes} Value of property areaId
setAreaId(sAreaId): sap.ui.commons.layout.BorderLayoutArea
Sets a new value for property areaId.

Defines which area the element represents: top, begin, center, end, bottom

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

Default value is top.

Parameters:
{sap.ui.commons.layout.BorderLayoutAreaTypes}sAreaId New value for property areaId
Deprecated:
Since version 1.3.3. Redundant to the aggregation by the parent border layout.
Returns:
{sap.ui.commons.layout.BorderLayoutArea} Reference to this in order to allow method chaining