class sap.m.OverflowToolbarLayoutData

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/OverflowToolbarLayoutData
Application Component: CA-UI5-CTR

Holds layout data for the sap.m.OverflowToolbar items.


Constructor

Constructor for a new OverflowToolbarLayoutData.

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.m.OverflowToolbarLayoutData(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new element, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
closeOverflowOnInteraction boolean true

Defines whether the overflow area is automatically closed when interacting with a control in it

Since: 1.40.

Visibility: public
group int 0

Defines OverflowToolbar items group number. Default value is 0, which means that the control does not belong to any group. Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority. Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.

Since: 1.32.

Visibility: public
moveToOverflow boolean true

The OverflowToolbar item can or cannot move to the overflow area

Visibility: public
priority sap.m.OverflowToolbarPriority High

Defines OverflowToolbar items priority. Available priorities are NeverOverflow, High, Low, Disappear and AlwaysOverflow.

Since: 1.32.

Visibility: public
stayInOverflow boolean false

The OverflowToolbar item can or cannot stay in the overflow area

Visibility: public

Borrowed Properties

Name Type Default Value Description
maxWidth sap.ui.core.CSSSize

Sets the maximum width of the toolbar item.

Visibility: public
minWidth sap.ui.core.CSSSize

Sets the minimum width of the toolbar item.

Visibility: public
shrinkable boolean false

Determines whether the control, when in a toolbar, is shrinkable or not. For controls with fixed width (100px, 5rem, etc...) this property is ignored.

Note: Nested layout controls should not be shrinkable.

Visibility: public

Methods Overview

Method Description
sap.m.OverflowToolbarLayoutData.extend

Creates a new subclass of class sap.m.OverflowToolbarLayoutData with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ToolbarLayoutData.extend.

getCloseOverflowOnInteraction

Gets current value of property closeOverflowOnInteraction.

Defines whether the overflow area is automatically closed when interacting with a control in it

Default value is true.

getGroup

Gets current value of property group.

Defines OverflowToolbar items group number. Default value is 0, which means that the control does not belong to any group. Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority. Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.

Default value is 0.

sap.m.OverflowToolbarLayoutData.getMetadata

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

getMoveToOverflow

Gets current value of property moveToOverflow.

The OverflowToolbar item can or cannot move to the overflow area

Default value is true.

getPriority

Gets current value of property priority.

Defines OverflowToolbar items priority. Available priorities are NeverOverflow, High, Low, Disappear and AlwaysOverflow.

Default value is High.

getStayInOverflow

Gets current value of property stayInOverflow.

The OverflowToolbar item can or cannot stay in the overflow area

Default value is false.

setCloseOverflowOnInteraction

Sets a new value for property closeOverflowOnInteraction.

Defines whether the overflow area is automatically closed when interacting with a control in it

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

Default value is true.

setGroup

Sets a new value for property group.

Defines OverflowToolbar items group number. Default value is 0, which means that the control does not belong to any group. Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority. Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.

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

Default value is 0.

setMoveToOverflow

Sets a new value for property moveToOverflow.

The OverflowToolbar item can or cannot move to the overflow area

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

Default value is true.

setStayInOverflow

Sets a new value for property stayInOverflow.

The OverflowToolbar item can or cannot stay in the overflow area

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

Default value is false.

sap.m.OverflowToolbarLayoutData.extend

Creates a new subclass of class sap.m.OverflowToolbarLayoutData with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ToolbarLayoutData.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

getCloseOverflowOnInteraction

Gets current value of property closeOverflowOnInteraction.

Defines whether the overflow area is automatically closed when interacting with a control in it

Default value is true.

getGroup

Gets current value of property group.

Defines OverflowToolbar items group number. Default value is 0, which means that the control does not belong to any group. Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority. Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.

Default value is 0.

sap.m.OverflowToolbarLayoutData.getMetadata

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

getMoveToOverflow

Gets current value of property moveToOverflow.

The OverflowToolbar item can or cannot move to the overflow area

Default value is true.

getPriority

Gets current value of property priority.

Defines OverflowToolbar items priority. Available priorities are NeverOverflow, High, Low, Disappear and AlwaysOverflow.

Default value is High.

getStayInOverflow

Gets current value of property stayInOverflow.

The OverflowToolbar item can or cannot stay in the overflow area

Default value is false.

setCloseOverflowOnInteraction

Sets a new value for property closeOverflowOnInteraction.

Defines whether the overflow area is automatically closed when interacting with a control in it

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

New value for property closeOverflowOnInteraction

setGroup

Sets a new value for property group.

Defines OverflowToolbar items group number. Default value is 0, which means that the control does not belong to any group. Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority. Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.

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
iGroup int 0

New value for property group

setMoveToOverflow

Sets a new value for property moveToOverflow.

The OverflowToolbar item can or cannot move to the overflow area

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

New value for property moveToOverflow

setStayInOverflow

Sets a new value for property stayInOverflow.

The OverflowToolbar item can or cannot stay in the overflow area

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

Default value is false.

Param Type DefaultValue Description
bStayInOverflow boolean false

New value for property stayInOverflow