The BorderLayoutArea represents one area of a BorderLayout
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#constructor for a general description of the syntax of the settings object.
new sap.ui.commons.layout.BorderLayoutArea(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 |
Name | Type | Default Value | Description |
---|---|---|---|
areaId | sap.ui.commons.layout.BorderLayoutAreaTypes | top | Defines which area the element represents: top, begin, center, end, bottom Visibility: public |
contentAlign | string | left | The content alignment as CSS value Visibility: public |
overflowX | string | auto | The overflow mode of the area in horizontal direction as CSS value Visibility: public |
overflowY | string | auto | The overflow mode of the area in vertical direction as CSS value Visibility: public |
size | sap.ui.core.CSSSize | 100px | Defines the height or the width. Is not used when the area element is in Center. Visibility: public |
visible | boolean | true | Invisible controls are not rendered Visibility: public |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
content (default) | 0..n | sap.ui.core.Control |
Controls within the area |
Method | Description |
---|---|
addContent |
Adds some content to the aggregation content. |
destroyContent |
Destroys all the content in the aggregation content. |
sap.ui.commons.layout.BorderLayoutArea.extend |
Creates a new subclass of class sap.ui.commons.layout.BorderLayoutArea with name
|
getAreaId |
Gets current value of property areaId. Defines which area the element represents: top, begin, center, end, bottom Default value is
Since 1.3.3 Redundant to the aggregation by the parent border layout.
|
getContent |
Gets content of aggregation content. Controls within the area |
getContentAlign |
Gets current value of property contentAlign. The content alignment as CSS value Default value is |
sap.ui.commons.layout.BorderLayoutArea.getMetadata |
Returns a metadata object for class sap.ui.commons.layout.BorderLayoutArea. |
getOverflowX |
Gets current value of property overflowX. The overflow mode of the area in horizontal direction as CSS value Default value is |
getOverflowY |
Gets current value of property overflowY. The overflow mode of the area in vertical direction as CSS value Default value is |
getSize |
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 |
getVisible |
Gets current value of property visible. Invisible controls are not rendered Default value is |
indexOfContent |
Checks for the provided |
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. |
setAreaId |
Sets a new value for property areaId. Defines which area the element represents: top, begin, center, end, bottom When called with a value of Default value is
Since 1.3.3 Redundant to the aggregation by the parent border layout.
|
setContentAlign |
Sets a new value for property contentAlign. The content alignment as CSS value When called with a value of Default value is |
setOverflowX |
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 Default value is |
setOverflowY |
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 Default value is |
setSize |
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 Default value is |
setVisible |
Sets a new value for property visible. Invisible controls are not rendered When called with a value of Default value is |
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 |
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.
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 |
Gets current value of property areaId.
Defines which area the element represents: top, begin, center, end, bottom
Default value is top
.
Gets current value of property contentAlign.
The content alignment as CSS value
Default value is 'left'
.
Returns a metadata object for class sap.ui.commons.layout.BorderLayoutArea.
Gets current value of property overflowX.
The overflow mode of the area in horizontal direction as CSS value
Default value is 'auto'
.
Gets current value of property overflowY.
The overflow mode of the area in vertical direction as CSS value
Default value is 'auto'
.
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'
.
Gets current value of property visible.
Invisible controls are not rendered
Default value is true
.
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 |
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 |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
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 |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAreaId | sap.ui.commons.layout.BorderLayoutAreaTypes | top |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sContentAlign | string | 'left' |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sOverflowX | string | 'auto' |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sOverflowY | string | 'auto' |
New value for property |
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'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSize | sap.ui.core.CSSSize | '100px' |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean | true |
New value for property |