Class sap.ui.ux3.CollectionModule: sap/ui/ux3/Collection

extends Element

Collection

Deprecated API:Since version 1.38.


Since: 1.9.0.
Constructor Summary
new sap.ui.ux3.Collection(sId?, mSettings?)Constructor for a new Collection.
Event Summary
propertyChanged(oControlEvent)Fires if a property has changed, and the collection inspector needs to do something after that
selectionChanged(oControlEvent)Fired when ever the selected items changer
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.Collection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Collection with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.Collection.getMetadata()Returns a metadata object for class sap.ui.ux3.Collection.
addItem(oItem)Adds some item to the aggregation items.
addSelectedItem(vSelectedItem)
attachPropertyChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the propertyChanged event of this sap.ui.ux3.Collection.
attachSelectionChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectionChanged event of this sap.ui.ux3.Collection.
destroyItems()Destroys all the items in the aggregation items.
detachPropertyChanged(fnFunction, oListener)Detaches event handler fnFunction from the propertyChanged event of this sap.ui.ux3.Collection.
detachSelectionChanged(fnFunction, oListener)Detaches event handler fnFunction from the selectionChanged event of this sap.ui.ux3.Collection.
firePropertyChanged(mArguments?)Fires event propertyChanged to attached listeners.
fireSelectionChanged(mArguments?)Fires event selectionChanged to attached listeners.
getEditable()Gets current value of property editable.
getItems()Gets content of aggregation items.
getMultiSelection()Gets current value of property multiSelection.
getSelectedItems()Returns array of IDs of the elements which are the current targets of the association selectedItems.
getTitle()Gets current value of property title.
indexOfItem(oItem)Checks for the provided sap.ui.core.Item in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeAllSelectedItems()
removeItem(vItem)Removes a item from the aggregation items.
removeSelectedItem(vSelectedItem)
setEditable(bEditable)Sets a new value for property editable.
setMultiSelection(bMultiSelection)Sets a new value for property multiSelection.
setTitle(sTitle)Sets a new value for property title.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
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.ui.ux3.Collection(sId?, mSettings?)
Constructor for a new Collection.

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
  • Aggregations
    • items : sap.ui.core.Item[]
  • Events
    • selectionChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • propertyChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.38.
Event Detail
propertyChanged(oControlEvent)
Fires if a property has changed, and the collection inspector needs to do something after that
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
selectionChanged(oControlEvent)
Fired when ever the selected items changer
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.ux3.Collection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.Collection 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.

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.ui.ux3.Collection.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.Collection.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.ux3.Collection
Adds some item to the aggregation items.
Parameters:
{sap.ui.core.Item}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
addSelectedItem(vSelectedItem): sap.ui.ux3.Collection
Parameters:
{string|sap.ui.core.Item}vSelectedItem Id of a selectedItem which becomes an additional target of this selectedItems association. Alternatively, a selectedItem instance may be given.
Returns:
{sap.ui.ux3.Collection}this to allow method chaining
attachPropertyChanged(oData?, fnFunction, oListener?): sap.ui.ux3.Collection
Attaches event handler fnFunction to the propertyChanged event of this sap.ui.ux3.Collection.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Collection itself.

Fires if a property has changed, and the collection inspector needs to do something after that

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection itself
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
attachSelectionChanged(oData?, fnFunction, oListener?): sap.ui.ux3.Collection
Attaches event handler fnFunction to the selectionChanged event of this sap.ui.ux3.Collection.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Collection itself.

Fired when ever the selected items changer

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.ux3.Collection itself
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
destroyItems(): sap.ui.ux3.Collection
Destroys all the items in the aggregation items.
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
detachPropertyChanged(fnFunction, oListener): sap.ui.ux3.Collection
Detaches event handler fnFunction from the propertyChanged event of this sap.ui.ux3.Collection.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
detachSelectionChanged(fnFunction, oListener): sap.ui.ux3.Collection
Detaches event handler fnFunction from the selectionChanged event of this sap.ui.ux3.Collection.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
firePropertyChanged(mArguments?): sap.ui.ux3.Collection
Fires event propertyChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
fireSelectionChanged(mArguments?): sap.ui.ux3.Collection
Fires event selectionChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
getEditable(): boolean
Gets current value of property editable.

If a collection is editable an edit button will be displayed below the list of items

Default value is false.

Returns:
{boolean} Value of property editable
getItems(): sap.ui.core.Item[]
Gets content of aggregation items.

Items in the collection

Returns:
{sap.ui.core.Item[]}
getMultiSelection(): boolean
Gets current value of property multiSelection.

Allow multi selection of items in collection

Default value is false.

Returns:
{boolean} Value of property multiSelection
getSelectedItems(): sap.ui.core.Item[]
Returns array of IDs of the elements which are the current targets of the association selectedItems.
Returns:
{sap.ui.core.Item[]}
getTitle(): string
Gets current value of property title.

Name for the collection

Returns:
{string} Value of property title
indexOfItem(oItem): int
Checks for the provided sap.ui.core.Item in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Item}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.ux3.Collection
Inserts a item into the aggregation items.
Parameters:
{sap.ui.core.Item}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.core.Item[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Item[]} An array of the removed elements (might be empty)
removeAllSelectedItems(): string[]
Returns:
{string[]} an array with the ids of the removed elements (might be empty)
removeItem(vItem): sap.ui.core.Item
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.core.Item}vItem The itemto remove or its index or id
Returns:
{sap.ui.core.Item} The removed item or null
removeSelectedItem(vSelectedItem): string
Parameters:
{int|string|sap.ui.core.Item}vSelectedItem the selectedItem to remove or its index or id
Returns:
{string} the id of the removed selectedItem or null
setEditable(bEditable): sap.ui.ux3.Collection
Sets a new value for property editable.

If a collection is editable an edit button will be displayed below the list of items

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

Default value is false.

Parameters:
{boolean}bEditable New value for property editable
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
setMultiSelection(bMultiSelection): sap.ui.ux3.Collection
Sets a new value for property multiSelection.

Allow multi selection of items in collection

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

Default value is false.

Parameters:
{boolean}bMultiSelection New value for property multiSelection
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining
setTitle(sTitle): sap.ui.ux3.Collection
Sets a new value for property title.

Name for the collection

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

Parameters:
{string}sTitle New value for property title
Returns:
{sap.ui.ux3.Collection} Reference to this in order to allow method chaining