Class sap.ui.comp.smartform.flexibility.FieldListNodeModule: sap/ui/comp/smartform/flexibility/FieldListNode

extends Control

A node within the field list control

Constructor Summary
new sap.ui.comp.smartform.flexibility.FieldListNode(sId?, mSettings?)Constructor for a new smartform/flexibility/FieldListNode.
Event Summary
labelChanged(oControlEvent)label of node was changed
nodeHidden(oControlEvent)node was hidden
selected(oControlEvent)node was selected
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.FieldListNode.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartform.flexibility.FieldListNode with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartform.flexibility.FieldListNode.getMetadata()Returns a metadata object for class sap.ui.comp.smartform.flexibility.FieldListNode.
_onLabelChanged(oEvent)Event handler - called when the user changes the label
_onLabelSelectedByKeyboard(oEvent)Event handler - called when the user has selected the label using the keyboard
addNode(oNode)Adds some node to the aggregation nodes.
attachLabelChanged(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldListNode.
attachNodeHidden(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldListNode.
attachSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selected event of this sap.ui.comp.smartform.flexibility.FieldListNode.
destroyLayout()Destroys the layout in the aggregation layout.
destroyNodes()Destroys all the nodes in the aggregation nodes.
detachLabelChanged(fnFunction, oListener)Detaches event handler fnFunction from the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldListNode.
detachNodeHidden(fnFunction, oListener)Detaches event handler fnFunction from the nodeHidden event of this sap.ui.comp.smartform.flexibility.FieldListNode.
detachSelected(fnFunction, oListener)Detaches event handler fnFunction from the selected event of this sap.ui.comp.smartform.flexibility.FieldListNode.
fireLabelChanged(mArguments?)Fires event labelChanged to attached listeners.
fireNodeHidden(mArguments?)Fires event nodeHidden to attached listeners.
fireSelected(mArguments?)Fires event selected to attached listeners.
getIsSelected()Gets current value of property isSelected.
getIsVisible()Gets current value of property isVisible.
getLabel()Gets current value of property label.
getLayout()Gets content of aggregation layout.
getNodes()Gets content of aggregation nodes.
indexOfNode(oNode)Checks for the provided sap.ui.comp.smartform.flexibility.FieldListNode in the aggregation nodes.
insertNode(oNode, iIndex)Inserts a node into the aggregation nodes.
removeAllNodes()Removes all the controls from the aggregation nodes.
removeNode(vNode)Removes a node from the aggregation nodes.
setIsSelected(bIsSelected)Overwritten - Sets the isSelected property
setIsVisible(bIsVisible)Overwritten - Sets the isVisible property
setLabel(sLabel)Overwritten - Sets the label property
setLayout(oLayout)Sets the aggregated layout.
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, 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.FieldListNode(sId?, mSettings?)
Constructor for a new smartform/flexibility/FieldListNode.

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
    • nodes : sap.ui.comp.smartform.flexibility.FieldListNode[]
    • layout : sap.ui.core.Control
  • Events
    • selected : 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)
label of node was changed
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.comp.smartform.flexibility.FieldListNode}oControlEvent.getParameters.target The inner node which was clicked
nodeHidden(oControlEvent)
node was hidden
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.comp.smartform.flexibility.FieldListNode}oControlEvent.getParameters.target The inner node which was hidden
selected(oControlEvent)
node was selected
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.comp.smartform.flexibility.FieldListNode}oControlEvent.getParameters.target The inner node which was clicked
Method Detail
sap.ui.comp.smartform.flexibility.FieldListNode.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.comp.smartform.flexibility.FieldListNode 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.FieldListNode.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartform.flexibility.FieldListNode.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
_onLabelChanged(oEvent)
Event handler - called when the user changes the label
Parameters:
{object}oEvent Event
_onLabelSelectedByKeyboard(oEvent)
Event handler - called when the user has selected the label using the keyboard
Parameters:
{object}oEvent Event
addNode(oNode): sap.ui.comp.smartform.flexibility.FieldListNode
Adds some node to the aggregation nodes.
Parameters:
{sap.ui.comp.smartform.flexibility.FieldListNode}oNode the node to add; if empty, nothing is inserted
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} Reference to this in order to allow method chaining
attachLabelChanged(oData?, fnFunction, oListener?): sap.ui.comp.smartform.flexibility.FieldListNode
Attaches event handler fnFunction to the labelChanged event of this sap.ui.comp.smartform.flexibility.FieldListNode.

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.FieldListNode itself.

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

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.FieldListNode itself.

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

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.FieldListNode itself.

node was selected

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

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

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

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.FieldListNode} Reference to this in order to allow method chaining
fireLabelChanged(mArguments?): sap.ui.comp.smartform.flexibility.FieldListNode
Fires event labelChanged to attached listeners.

Expects the following event parameters:

  • target of type sap.ui.comp.smartform.flexibility.FieldListNodeThe inner node which was clicked
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} Reference to this in order to allow method chaining
fireNodeHidden(mArguments?): sap.ui.comp.smartform.flexibility.FieldListNode
Fires event nodeHidden to attached listeners.

Expects the following event parameters:

  • target of type sap.ui.comp.smartform.flexibility.FieldListNodeThe inner node which was hidden
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} Reference to this in order to allow method chaining
fireSelected(mArguments?): sap.ui.comp.smartform.flexibility.FieldListNode
Fires event selected to attached listeners.

Expects the following event parameters:

  • target of type sap.ui.comp.smartform.flexibility.FieldListNodeThe inner node which was clicked
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} Reference to this in order to allow method chaining
getIsSelected(): boolean
Gets current value of property isSelected.

is node selected

Returns:
{boolean} Value of property isSelected
getIsVisible(): boolean
Gets current value of property isVisible.

is visible flag

Returns:
{boolean} Value of property isVisible
getLabel(): string
Gets current value of property label.

The label

Returns:
{string} Value of property label
getLayout(): sap.ui.core.Control
Gets content of aggregation layout.

private aggregation

Returns:
{sap.ui.core.Control}
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[]}
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
insertNode(oNode, iIndex): sap.ui.comp.smartform.flexibility.FieldListNode
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.FieldListNode} 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)
removeNode(vNode): sap.ui.comp.smartform.flexibility.FieldListNode
Removes a node from the aggregation nodes.
Parameters:
{int|string|sap.ui.comp.smartform.flexibility.FieldListNode}vNode The nodeto remove or its index or id
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} The removed node or null
setIsSelected(bIsSelected)
Overwritten - Sets the isSelected property
Parameters:
{boolean}bIsSelected field list node selected
setIsVisible(bIsVisible)
Overwritten - Sets the isVisible property
Parameters:
{boolean}bIsVisible isVisible
setLabel(sLabel)
Overwritten - Sets the label property
Parameters:
{string}sLabel Label
setLayout(oLayout): sap.ui.comp.smartform.flexibility.FieldListNode
Sets the aggregated layout.
Parameters:
{sap.ui.core.Control}oLayout The layout to set
Returns:
{sap.ui.comp.smartform.flexibility.FieldListNode} Reference to this in order to allow method chaining