Class sap.ui.comp.smartform.flexibility.FieldListModule: sap/ui/comp/smartform/flexibility/FieldList

extends Control

Contains list of forms, groups and fields which can could be modified by the SAPUI5 flexibility services

Constructor Summary
new sap.ui.comp.smartform.flexibility.FieldList(sId?, mSettings?)Constructor for a new smartform/flexibility/FieldList.
Event Summary
labelChanged(oControlEvent)Event is fired when the label of the node has changed
nodeHidden(oControlEvent)Event is fired when a node was hidden
selectionChanged(oControlEvent)Event is fired when the selected node has changed
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.smartform.flexibility.FieldList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartform.flexibility.FieldList with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartform.flexibility.FieldList.getMetadata()Returns a metadata object for class sap.ui.comp.smartform.flexibility.FieldList.
attachLabelChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldList.
attachNodeHidden(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldList.
attachSelectionChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectionChanged event of this sap.ui.comp.smartform.flexibility.FieldList.
detachLabelChanged(fnFunction, oListener)Detaches event handler fnFunction from the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldList.
detachNodeHidden(fnFunction, oListener)Detaches event handler fnFunction from the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldList.
detachSelectionChanged(fnFunction, oListener)Detaches event handler fnFunction from the selectionChanged event of this sap.ui.comp.smartform.flexibility.FieldList.
fireLabelChanged(mArguments?)Fires event labelChanged to attached listeners.
fireNodeHidden(mArguments?)Fires event nodeHidden to attached listeners.
fireSelectionChanged(mArguments?)Fires event selectionChanged to attached listeners.
getNodes()Gets content of aggregation nodes.
getSelectedNode()Returns the currently selected field list node
indexOfNode(oNode)Checks for the provided sap.ui.comp.smartform.flexibility.FieldListNode in the aggregation nodes.
init()init
insertNode(oNode, iIndex)Inserts a node into the aggregation nodes.
removeAllNodes()Removes all the controls from the aggregation nodes.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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.comp.smartform.flexibility.FieldList(sId?, mSettings?)
Constructor for a new smartform/flexibility/FieldList.

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:

  • Aggregations
    • nodes : sap.ui.comp.smartform.flexibility.FieldListNode[]
  • Events
    • selectionChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • labelChanged : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • nodeHidden : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control 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
Event Detail
labelChanged(oControlEvent)
Event is fired when the label of the node has changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
nodeHidden(oControlEvent)
Event is fired when a node was hidden
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
selectionChanged(oControlEvent)
Event is fired when the selected node has changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.comp.smartform.flexibility.FieldList.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.comp.smartform.flexibility.FieldList 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.

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.comp.smartform.flexibility.FieldList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartform.flexibility.FieldList.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachLabelChanged(oData?, fnFunction, oListener?): sap.ui.comp.smartform.flexibility.FieldList
Attaches event handler fnFunction to the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList itself.

Event is fired when the label of the node has changed

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.comp.smartform.flexibility.FieldList itself
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
attachNodeHidden(oData?, fnFunction, oListener?): sap.ui.comp.smartform.flexibility.FieldList
Attaches event handler fnFunction to the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList itself.

Event is fired when a node was hidden

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.comp.smartform.flexibility.FieldList itself
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
attachSelectionChanged(oData?, fnFunction, oListener?): sap.ui.comp.smartform.flexibility.FieldList
Attaches event handler fnFunction to the selectionChanged event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList itself.

Event is fired when the selected node has changed

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.comp.smartform.flexibility.FieldList itself
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
detachLabelChanged(fnFunction, oListener): sap.ui.comp.smartform.flexibility.FieldList
Detaches event handler fnFunction from the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
detachNodeHidden(fnFunction, oListener): sap.ui.comp.smartform.flexibility.FieldList
Detaches event handler fnFunction from the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
detachSelectionChanged(fnFunction, oListener): sap.ui.comp.smartform.flexibility.FieldList
Detaches event handler fnFunction from the selectionChanged event of this sap.ui.comp.smartform.flexibility.FieldList.

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.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
fireLabelChanged(mArguments?): sap.ui.comp.smartform.flexibility.FieldList
Fires event labelChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
fireNodeHidden(mArguments?): sap.ui.comp.smartform.flexibility.FieldList
Fires event nodeHidden to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
fireSelectionChanged(mArguments?): sap.ui.comp.smartform.flexibility.FieldList
Fires event selectionChanged to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
getNodes(): sap.ui.comp.smartform.flexibility.FieldListNode[]
Gets content of aggregation nodes.

Nodes representing either a Form, a Group or a field

Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode[]}
getSelectedNode(): sap.ui.comp.smartform.flexibility.FieldListNode
Returns the currently selected field list node
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} field list node
indexOfNode(oNode): int
Checks for the provided sap.ui.comp.smartform.flexibility.FieldListNode in the aggregation nodes. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.comp.smartform.flexibility.FieldListNode}oNode The node whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
init()
init
insertNode(oNode, iIndex): sap.ui.comp.smartform.flexibility.FieldList
Inserts a node into the aggregation nodes.
Parameters:
{sap.ui.comp.smartform.flexibility.FieldListNode}oNode the node to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the node should be inserted at; for a negative value of iIndex, the node is inserted at position 0; for a value greater than the current size of the aggregation, the node is inserted at the last position
Returns:
{sap.ui.comp.smartform.flexibility.FieldList} Reference to this in order to allow method chaining
removeAllNodes(): sap.ui.comp.smartform.flexibility.FieldListNode[]
Removes all the controls from the aggregation nodes.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode[]} An array of the removed elements (might be empty)