OverflowToolbarLayoutData

Holds layout data for the OverflowToolbar items.

Since: 1.28.

Constructor Summary

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

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

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

getGroup()Gets current value of property group.

getPriority()Gets current value of property priority.

setGroup(iGroup)Sets a new value for property group.

setPriority(sPriority)Sets a new value for property priority.

getMoveToOverflow()Gets current value of property moveToOverflow.

getStayInOverflow()Gets current value of property stayInOverflow.

setMoveToOverflow(bMoveToOverflow)Sets a new value for property moveToOverflow.

setStayInOverflow(bStayInOverflow)Sets a new value for property stayInOverflow.

Methods borrowed from class sap.m.ToolbarLayoutData

getMaxWidth, getMinWidth, getShrinkable, setMaxWidth, setMinWidth, setShrinkable

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

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- moveToOverflow : boolean (default: true)
- stayInOverflow : boolean (default: false)
- priority : sap.m.OverflowToolbarPriority (default: High)
- group : int (default: 0)

In addition, all settings applicable to the base type sap.m.ToolbarLayoutData 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 control

Method Detail

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

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.

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.OverflowToolbarLayoutData.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getGroup(): int

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.

Since:: 1.32

Returns:

{int} Value of property group

getPriority(): sap.m.OverflowToolbarPriority

Gets current value of property priority.

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

Default value is High.

Since:: 1.32

Returns:

{sap.m.OverflowToolbarPriority} Value of property priority

setGroup(iGroup): sap.m.OverflowToolbarLayoutData

Sets a new value for property group.

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

Default value is 0.

Parameters:

{int} iGroup New value for property group

Since:: 1.32

Returns:

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

setPriority(sPriority): sap.m.OverflowToolbarLayoutData

Sets a new value for property priority.

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

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

Default value is High.

Parameters:

{sap.m.OverflowToolbarPriority} sPriority New value for property priority

Since:: 1.32

Returns:

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

getMoveToOverflow(): boolean

Gets current value of property moveToOverflow.

The OverflowToolbar item can or cannot move to the overflow area

Default value is true.

Deprecated:
Since version 1.32

Returns:

{boolean} Value of property moveToOverflow

getStayInOverflow(): boolean

Gets current value of property stayInOverflow.

The OverflowToolbar item can or cannot stay in the overflow area

Default value is false.

Deprecated:
Since version 1.32

Returns:

{boolean} Value of property stayInOverflow

setMoveToOverflow(bMoveToOverflow): sap.m.OverflowToolbarLayoutData

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.

Parameters:

{boolean} bMoveToOverflow New value for property moveToOverflow

Deprecated:
Since version 1.32

Returns:

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

setStayInOverflow(bStayInOverflow): sap.m.OverflowToolbarLayoutData

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.

Parameters:

{boolean} bStayInOverflow New value for property stayInOverflow

Deprecated:
Since version 1.32

Returns:

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