class sap.ui.layout.FixFlex

Control sample: sap.ui.layout.FixFlex
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/layout/FixFlex
Application Component: CA-UI5-CTR

A layout container with a fixed and a flexible part.

Overview

The FixFlex control builds the container for a layout with a fixed and a flexible part. The flexible container adapts its size to the fix container.

Guidelines:

Structure

The behavior of the FixFlex is controlled by the following properties:

Responsive Behavior

This control can be a drop target.

Constructor

Constructor for a new FixFlex.

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.layout.FixFlex(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
fixContentSize sap.ui.core.CSSSize auto

Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.

Visibility: public
fixFirst boolean true

Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").

Visibility: public
minFlexSize int 0

Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger than the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.

Since: 1.29.

Visibility: public
vertical boolean true

Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
fixContent 0..n sap.ui.core.Control

Controls in the fixed part of the layout.

flexContent 0..1 sap.ui.core.Control

Control in the stretching part of the layout.


Methods Overview

Method Description
addFixContent

Adds some fixContent to the aggregation fixContent.

destroyFixContent

Destroys all the fixContent in the aggregation fixContent.

destroyFlexContent

Destroys the flexContent in the aggregation flexContent.

sap.ui.layout.FixFlex.extend

Creates a new subclass of class sap.ui.layout.FixFlex 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.Control.extend.

getFixContent

Gets content of aggregation fixContent.

Controls in the fixed part of the layout.

getFixContentSize

Gets current value of property fixContentSize.

Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.

Default value is "auto".

getFixFirst

Gets current value of property fixFirst.

Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").

Default value is true.

getFlexContent

Gets content of aggregation flexContent.

Control in the stretching part of the layout.

sap.ui.layout.FixFlex.getMetadata

Returns a metadata object for class sap.ui.layout.FixFlex.

getMinFlexSize

Gets current value of property minFlexSize.

Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger than the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.

Default value is 0.

getVertical

Gets current value of property vertical.

Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.

Default value is true.

indexOfFixContent

Checks for the provided sap.ui.core.Control in the aggregation fixContent. and returns its index if found or -1 otherwise.

insertFixContent

Inserts a fixContent into the aggregation fixContent.

removeAllFixContent

Removes all the controls from the aggregation fixContent.

Additionally, it unregisters them from the hosting UIArea.

removeFixContent

Removes a fixContent from the aggregation fixContent.

setFixContentSize

Sets a new value for property fixContentSize.

Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.

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

Default value is "auto".

setFixFirst

Sets a new value for property fixFirst.

Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").

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

Default value is true.

setFlexContent

Sets the aggregated flexContent.

setMinFlexSize

Sets a new value for property minFlexSize.

Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger than the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.

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

Default value is 0.

setVertical

Sets a new value for property vertical.

Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.

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

Default value is true.

addFixContent

Adds some fixContent to the aggregation fixContent.

Param Type DefaultValue Description
oFixContent sap.ui.core.Control

The fixContent to add; if empty, nothing is inserted

destroyFixContent

Destroys all the fixContent in the aggregation fixContent.

destroyFlexContent

Destroys the flexContent in the aggregation flexContent.

sap.ui.layout.FixFlex.extend

Creates a new subclass of class sap.ui.layout.FixFlex 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.Control.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

getFixContent

Gets content of aggregation fixContent.

Controls in the fixed part of the layout.

getFixContentSize

Gets current value of property fixContentSize.

Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.

Default value is "auto".

getFixFirst

Gets current value of property fixFirst.

Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").

Default value is true.

getFlexContent

Gets content of aggregation flexContent.

Control in the stretching part of the layout.

sap.ui.layout.FixFlex.getMetadata

Returns a metadata object for class sap.ui.layout.FixFlex.

getMinFlexSize

Gets current value of property minFlexSize.

Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger than the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.

Default value is 0.

getVertical

Gets current value of property vertical.

Determines the direction of the layout of child elements. True for vertical and false for horizontal layout.

Default value is true.

indexOfFixContent

Checks for the provided sap.ui.core.Control in the aggregation fixContent. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oFixContent sap.ui.core.Control

The fixContent whose index is looked for

insertFixContent

Inserts a fixContent into the aggregation fixContent.

Param Type DefaultValue Description
oFixContent sap.ui.core.Control

The fixContent to insert; if empty, nothing is inserted

iIndex int

The 0-based index the fixContent should be inserted at; for a negative value of iIndex, the fixContent is inserted at position 0; for a value greater than the current size of the aggregation, the fixContent is inserted at the last position

removeAllFixContent

Removes all the controls from the aggregation fixContent.

Additionally, it unregisters them from the hosting UIArea.

removeFixContent

Removes a fixContent from the aggregation fixContent.

Param Type DefaultValue Description
vFixContent int string sap.ui.core.Control

The fixContent to remove or its index or id

setFixContentSize

Sets a new value for property fixContentSize.

Determines the height (if the vertical property is "true") or the width (if the vertical property is "false") of the fixed area. If left at the default value "auto", the fixed-size area will be as large as its content. In this case the content cannot use percentage sizes.

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
sFixContentSize sap.ui.core.CSSSize "auto"

New value for property fixContentSize

setFixFirst

Sets a new value for property fixFirst.

Determines whether the fixed-size area should be on the beginning/top ( if the value is "true") or end/bottom ( if the value is "false").

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

New value for property fixFirst

setFlexContent

Sets the aggregated flexContent.

Param Type DefaultValue Description
oFlexContent sap.ui.core.Control

The flexContent to set

setMinFlexSize

Sets a new value for property minFlexSize.

Enables scrolling inside the flexible part. The given size is calculated in "px". If the child control in the flexible part is larger than the available flexible size on the screen and if the available size for the flexible part is smaller or equal to the minFlexSize value, the scroll will be for the entire FixFlex control.

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

Default value is 0.

Param Type DefaultValue Description
iMinFlexSize int 0

New value for property minFlexSize

setVertical

Sets a new value for property vertical.

Determines the direction of the layout of child elements. True for vertical and false for horizontal 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
bVertical boolean true

New value for property vertical