FlexItemData

Holds layout data for a FlexBox|HBox|VBox

Constructor Summary

new sap.m.FlexItemData(sId?, mSettings?)Constructor for a new sap.m.FlexItemData.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

sap.m.FlexItemData.getMetadata()Returns a metadata object for class sap.m.FlexItemData.

getAlignSelf()Gets current value of property alignSelf.

getBackgroundDesign()Gets current value of property backgroundDesign.

getBaseSize()Gets current value of property baseSize.

getGrowFactor()Gets current value of property growFactor.

getMaxHeight()Gets current value of property maxHeight.

getMaxWidth()Gets current value of property maxWidth.

getMinHeight()Gets current value of property minHeight.

getMinWidth()Gets current value of property minWidth.

getOrder()Gets current value of property order.

getShrinkFactor()Gets current value of property shrinkFactor.

getStyleClass()Gets current value of property styleClass.

setAlignSelf(sAlignSelf)Sets a new value for property alignSelf.

setBackgroundDesign(sBackgroundDesign)Sets a new value for property backgroundDesign.

setBaseSize(sBaseSize)Sets a new value for property baseSize.

setGrowFactor(fGrowFactor)Sets a new value for property growFactor.

setMaxHeight(sMaxHeight)Sets a new value for property maxHeight.

setMaxWidth(sMaxWidth)Sets a new value for property maxWidth.

setMinHeight(sMinHeight)Sets a new value for property minHeight.

setMinWidth(sMinWidth)Sets a new value for property minWidth.

setOrder(iOrder)Sets a new value for property order.

setShrinkFactor(fShrinkFactor)Sets a new value for property shrinkFactor.

setStyleClass(sStyleClass)Sets a new value for property styleClass.

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.m.FlexItemData(sId?, mSettings?)

Constructor for a new sap.m.FlexItemData.

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
- alignSelf : sap.m.FlexAlignSelf (default: Auto)
- order : int (default: 0)
- growFactor : float (default: 0)
- shrinkFactor : float (default: 1)
- baseSize : sap.ui.core.CSSSize (default: auto)
- minHeight : sap.ui.core.CSSSize (default: auto)
- maxHeight : sap.ui.core.CSSSize (default: )
- minWidth : sap.ui.core.CSSSize (default: auto)
- maxWidth : sap.ui.core.CSSSize (default: )
- styleClass : string (default: )
- backgroundDesign : sap.m.BackgroundDesign (default: Transparent)

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 element, generated automatically if no id is given
{object}	mSettings?	initial settings for the new element

Method Detail

sap.m.FlexItemData.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.FlexItemData 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.m.FlexItemData.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.m.FlexItemData.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getAlignSelf(): sap.m.FlexAlignSelf

Gets current value of property alignSelf.

Determines cross-axis alignment of individual element (not currently supported in Internet Explorer)

Default value is Auto.

Returns:

{sap.m.FlexAlignSelf} Value of property alignSelf

getBackgroundDesign(): sap.m.BackgroundDesign

Gets current value of property backgroundDesign.

Defines the background style of the flex item.

Default value is Transparent.

Since:: 1.38.5

Returns:

{sap.m.BackgroundDesign} Value of property backgroundDesign

getBaseSize(): sap.ui.core.CSSSize

Gets current value of property baseSize.

The base size is the initial main size of the item for the flex algorithm. If set to "auto", this will be the computed size of the item.

Default value is auto.

Since:: 1.32.0

Returns:

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

getGrowFactor(): float

Gets current value of property growFactor.

Determines the flexibility of the flex item when allocatable space is remaining.

Default value is 0.

Returns:

{float} Value of property growFactor

getMaxHeight(): sap.ui.core.CSSSize

Gets current value of property maxHeight.

The maximum height of the flex item.

Default value is .

Since:: 1.36.0

Returns:

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

getMaxWidth(): sap.ui.core.CSSSize

Gets current value of property maxWidth.

The maximum height of the flex item.

Default value is .

Since:: 1.36.0

Returns:

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

getMinHeight(): sap.ui.core.CSSSize

Gets current value of property minHeight.

The minimum height of the flex item.

Default value is auto.

Since:: 1.36.0

Returns:

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

getMinWidth(): sap.ui.core.CSSSize

Gets current value of property minWidth.

The minimum height of the flex item.

Default value is auto.

Since:: 1.36.0

Returns:

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

getOrder(): int

Gets current value of property order.

Determines the display order of flex items independent of their source code order.

Default value is 0.

Returns:

{int} Value of property order

getShrinkFactor(): float

Gets current value of property shrinkFactor.

The shrink factor determines how much the flex item will shrink relative to the rest of the flex items in the flex container when negative free space is distributed.

Default value is 1.

Since:: 1.24.0

Returns:

{float} Value of property shrinkFactor

getStyleClass(): string

Gets current value of property styleClass.

The style class will be applied to the flex item and can be used for CSS selectors

Default value is .

Returns:

{string} Value of property styleClass

setAlignSelf(sAlignSelf): sap.m.FlexItemData

Sets a new value for property alignSelf.

Determines cross-axis alignment of individual element (not currently supported in Internet Explorer)

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

Default value is Auto.

Parameters:

{sap.m.FlexAlignSelf} sAlignSelf New value for property alignSelf

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setBackgroundDesign(sBackgroundDesign): sap.m.FlexItemData

Sets a new value for property backgroundDesign.

Defines the background style of the flex item.

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

Default value is Transparent.

Parameters:

{sap.m.BackgroundDesign} sBackgroundDesign New value for property backgroundDesign

Since:: 1.38.5

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setBaseSize(sBaseSize): sap.m.FlexItemData

Sets a new value for property baseSize.

The base size is the initial main size of the item for the flex algorithm. If set to "auto", this will be the computed size of the item.

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} sBaseSize New value for property baseSize

Since:: 1.32.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setGrowFactor(fGrowFactor): sap.m.FlexItemData

Sets a new value for property growFactor.

Determines the flexibility of the flex item when allocatable space is remaining.

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

Default value is 0.

Parameters:

{float} fGrowFactor New value for property growFactor

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setMaxHeight(sMaxHeight): sap.m.FlexItemData

Sets a new value for property maxHeight.

The maximum height of the flex item.

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

Default value is .

Parameters:

{sap.ui.core.CSSSize} sMaxHeight New value for property maxHeight

Since:: 1.36.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setMaxWidth(sMaxWidth): sap.m.FlexItemData

Sets a new value for property maxWidth.

The maximum height of the flex item.

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

Default value is .

Parameters:

{sap.ui.core.CSSSize} sMaxWidth New value for property maxWidth

Since:: 1.36.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setMinHeight(sMinHeight): sap.m.FlexItemData

Sets a new value for property minHeight.

The minimum height of the flex item.

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} sMinHeight New value for property minHeight

Since:: 1.36.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setMinWidth(sMinWidth): sap.m.FlexItemData

Sets a new value for property minWidth.

The minimum height of the flex item.

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} sMinWidth New value for property minWidth

Since:: 1.36.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setOrder(iOrder): sap.m.FlexItemData

Sets a new value for property order.

Determines the display order of flex items independent of their source code order.

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

Default value is 0.

Parameters:

{int} iOrder New value for property order

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setShrinkFactor(fShrinkFactor): sap.m.FlexItemData

Sets a new value for property shrinkFactor.

The shrink factor determines how much the flex item will shrink relative to the rest of the flex items in the flex container when negative free space is distributed.

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

Default value is 1.

Parameters:

{float} fShrinkFactor New value for property shrinkFactor

Since:: 1.24.0

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining

setStyleClass(sStyleClass): sap.m.FlexItemData

Sets a new value for property styleClass.

The style class will be applied to the flex item and can be used for CSS selectors

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

Default value is .

Parameters:

{string} sStyleClass New value for property styleClass

Returns:

{sap.m.FlexItemData} Reference to this in order to allow method chaining