Class sap.suite.ui.commons.ProcessFlowNodeModule: sap/suite/ui/commons/ProcessFlowNode

extends Control

This control enables you to see documents (or other items) in respect to their statuses – positive, negative, neutral, planned, planned negative. In addition to the node title (which can be optionally a hyperlink) also two other text fields are provided and can be filled. The process flow nodes consider all styles depending on the status they are in. The user can update or change the content of the node. The content of the node can be also filtered according to updated data and specific parameters set. This means that also the node’s style is affected.

Constructor Summary
new sap.suite.ui.commons.ProcessFlowNode(sId?, mSettings?)Constructor for a new ProcessFlowNode.
Event Summary
press(oControlEvent)This event is fired when the user clicks on the node.
titlePress(oControlEvent)This event handler is executed when the user clicks the node title.
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.suite.ui.commons.ProcessFlowNode.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ProcessFlowNode with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ProcessFlowNode.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ProcessFlowNode.
addParent(vParent)
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.ProcessFlowNode.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.ProcessFlowNode.
firePress(mArguments?)Fire event press to attached listeners.
getChildren()Getter for property children.
getFocused()Getter for property focused.
getHighlighted()Getter for property highlighted.
getLaneId()Overwrites the getter method for property laneId.
getNodeId()Getter for property nodeId.
getParents()Reference to ProcessFlowNodes which appears before this ProcessFlowNode.
getSelected()Getter for property selected.
getState()Getter for property state.
getStateText()Getter for property stateText.
getTag()Getter for property tag.
getTexts()Getter for property texts.
getTitle()Getter for property title.
getTitleAbbreviation()Getter for property titleAbbreviation.
getType()Getter for property type.
removeAllParents()
removeParent(vParent)
setChildren(aChildren)Setter for property children.
setFocused(bFocused)Setter for property focused.
setHighlighted(bHighlighted)Setter for property highlighted.
setLaneId(sLaneId)Setter for property laneId.
setNodeId(sNodeId)Setter for property nodeId.
setSelected(bSelected)Setter for property selected.
setState(oState)Setter for property state.
setStateText(sStateText)Setter for property stateText.
setTag(oTag)Setter for property tag.
setTexts(aTexts)Setter for property texts.
setTitle(sTitle)Setter for property title.
setTitleAbbreviation(sTitleAbbreviation)Setter for property titleAbbreviation.
setType(oType)Setter for property type.
attachTitlePress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'titlePress' event of this sap.suite.ui.commons.ProcessFlowNode.
detachTitlePress(fnFunction, oListener)Detach event handler fnFunction from the 'titlePress' event of this sap.suite.ui.commons.ProcessFlowNode.
fireTitlePress(mArguments?)Fire event titlePress to attached listeners.
getIsTitleClickable()Getter for property isTitleClickable.
setIsTitleClickable(bIsTitleClickable)Setter for property isTitleClickable.
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, 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.suite.ui.commons.ProcessFlowNode(sId?, mSettings?)
Constructor for a new ProcessFlowNode.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • Associations
      • parents : string | sap.suite.ui.commons.ProcessFlowNode
    • Events
      • titlePress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    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
    press(oControlEvent)
    This event is fired when the user clicks on the node. However, this event is not fired if the titlePress event has been fired.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {object}oControlEvent.getParameters.oEvent The node identification.
    titlePress(oControlEvent)
    This event handler is executed when the user clicks the node title. This event is fired only when the title is clickable (isTitleClickable equals true).
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {object}oControlEvent.getParameters.oEvent The node identification.
    Deprecated:
    Since version 1.26. Should not be used any longer, use Press event instead ( click on the node)
    Method Detail
    sap.suite.ui.commons.ProcessFlowNode.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.ProcessFlowNode with name sClassName and enriches it with the information contained in oClassInfo.

    oClassInfo might contain the same kind of informations as described in Element.extend.

    Parameters:
    {string}sClassName name of the class to be created
    {object}oClassInfo? object literal with informations about the class
    {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
    Returns:
    {function} the created class / constructor function
    sap.suite.ui.commons.ProcessFlowNode.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.ProcessFlowNode.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addParent(vParent): sap.suite.ui.commons.ProcessFlowNode
    Parameters:
    {string|sap.suite.ui.commons.ProcessFlowNode}vParent Id of a parent which becomes an additional target of this parents association. Alternatively, a parent instance may be given.
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ProcessFlowNode
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.ProcessFlowNode.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlowNode.
    itself.

    This event is fired when the user clicks on the node. However, this event is not fired if the titlePress event has been fired.

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.ProcessFlowNode.
    itself.
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.ProcessFlowNode
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.ProcessFlowNode.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.ProcessFlowNode
    Fire event press to attached listeners.

    Expects following event parameters:

    • 'oEvent' of type object The node identification.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    getChildren(): string[]
    Getter for property children. Defines an array of children of the node.

    Default value is empty/undefined

    Returns:
    {string[]} the value of property children
    getFocused(): boolean
    Getter for property focused. The parameter defines if the node should be displayed in focus state.

    Default value is false

    Returns:
    {boolean} the value of property focused
    getHighlighted(): boolean
    Getter for property highlighted. The parameter defines if the node should be displayed in highlighted state.

    Default value is false

    Returns:
    {boolean} the value of property highlighted
    getLaneId()
    Overwrites the getter method for property laneId. It returns the artificially merged laneId, if the node is in such a lane. Otherwise it returns the laneId set in the model.
    getNodeId(): string
    Getter for property nodeId. >Node identifier.

    Default value is empty/undefined

    Returns:
    {string} the value of property nodeId
    getParents(): string[]
    Reference to ProcessFlowNodes which appears before this ProcessFlowNode.
    Returns:
    {string[]}
    getSelected(): boolean
    Getter for property selected. The parameter defines if the node should be displayed in selected state.

    Default value is false

    Returns:
    {boolean} the value of property selected
    getState(): sap.suite.ui.commons.ProcessFlowNodeState
    Getter for property state. State of the node.

    Default value is Neutral

    Returns:
    {sap.suite.ui.commons.ProcessFlowNodeState} the value of property state
    getStateText(): string
    Getter for property stateText. Description of the state, for example "Status OK".

    Default value is empty/undefined

    Returns:
    {string} the value of property stateText
    getTag(): object
    Getter for property tag. The user-defined object which is returned back to the user by a node click event.

    Default value is empty/undefined

    Returns:
    {object} the value of property tag
    getTexts(): string[]
    Getter for property texts. The property contains the additional texts on the node. The expected type is array of strings. One array must not contain more than two strings. Additional strings in the array will be ignored.

    Default value is empty/undefined

    Returns:
    {string[]} the value of property texts
    getTitle(): string
    Getter for property title. The node title.

    Default value is empty/undefined

    Returns:
    {string} the value of property title
    getTitleAbbreviation(): string
    Getter for property titleAbbreviation. Title abbreviation is used in the compact mode.

    Default value is empty/undefined

    Returns:
    {string} the value of property titleAbbreviation
    getType(): sap.suite.ui.commons.ProcessFlowNodeType
    Getter for property type. Type of the node.

    Default value is Single

    Returns:
    {sap.suite.ui.commons.ProcessFlowNodeType} the value of property type
    removeAllParents(): string[]
    Returns:
    {string[]} an array with the ids of the removed elements (might be empty)
    removeParent(vParent): string
    Parameters:
    {int|string|sap.suite.ui.commons.ProcessFlowNode}vParent the parent to remove or its index or id
    Returns:
    {string} the id of the removed parent or null
    setChildren(aChildren): sap.suite.ui.commons.ProcessFlowNode
    Setter for property children.

    Default value is empty/undefined

    Parameters:
    {string[]}aChildren new value for property children
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setFocused(bFocused): sap.suite.ui.commons.ProcessFlowNode
    Setter for property focused.

    Default value is false

    Parameters:
    {boolean}bFocused new value for property focused
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setHighlighted(bHighlighted): sap.suite.ui.commons.ProcessFlowNode
    Setter for property highlighted.

    Default value is false

    Parameters:
    {boolean}bHighlighted new value for property highlighted
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setLaneId(sLaneId): sap.suite.ui.commons.ProcessFlowNode
    Setter for property laneId.

    Default value is empty/undefined

    Parameters:
    {string}sLaneId new value for property laneId
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setNodeId(sNodeId): sap.suite.ui.commons.ProcessFlowNode
    Setter for property nodeId.

    Default value is empty/undefined

    Parameters:
    {string}sNodeId new value for property nodeId
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setSelected(bSelected): sap.suite.ui.commons.ProcessFlowNode
    Setter for property selected.

    Default value is false

    Parameters:
    {boolean}bSelected new value for property selected
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setState(oState): sap.suite.ui.commons.ProcessFlowNode
    Setter for property state.

    Default value is Neutral

    Parameters:
    {sap.suite.ui.commons.ProcessFlowNodeState}oState new value for property state
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setStateText(sStateText): sap.suite.ui.commons.ProcessFlowNode
    Setter for property stateText.

    Default value is empty/undefined

    Parameters:
    {string}sStateText new value for property stateText
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setTag(oTag): sap.suite.ui.commons.ProcessFlowNode
    Setter for property tag.

    Default value is empty/undefined

    Parameters:
    {object}oTag new value for property tag
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setTexts(aTexts): sap.suite.ui.commons.ProcessFlowNode
    Setter for property texts.

    Default value is empty/undefined

    Parameters:
    {string[]}aTexts new value for property texts
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setTitle(sTitle): sap.suite.ui.commons.ProcessFlowNode
    Setter for property title.

    Default value is empty/undefined

    Parameters:
    {string}sTitle new value for property title
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setTitleAbbreviation(sTitleAbbreviation): sap.suite.ui.commons.ProcessFlowNode
    Setter for property titleAbbreviation.

    Default value is empty/undefined

    Parameters:
    {string}sTitleAbbreviation new value for property titleAbbreviation
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    setType(oType): sap.suite.ui.commons.ProcessFlowNode
    Setter for property type.

    Default value is Single

    Parameters:
    {sap.suite.ui.commons.ProcessFlowNodeType}oType new value for property type
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    attachTitlePress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ProcessFlowNode
    Attach event handler fnFunction to the 'titlePress' event of this sap.suite.ui.commons.ProcessFlowNode.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlowNode.
    itself.

    This event handler is executed when the user clicks the node title. This event is fired only when the title is clickable (isTitleClickable equals true).

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.ProcessFlowNode.
    itself.
    Deprecated:
    Since version 1.26. Should not be used any longer, use Press event instead ( click on the node)
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    detachTitlePress(fnFunction, oListener): sap.suite.ui.commons.ProcessFlowNode
    Detach event handler fnFunction from the 'titlePress' event of this sap.suite.ui.commons.ProcessFlowNode.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Deprecated:
    Since version 1.26. Should not be used any longer, use Press event instead ( click on the node)
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    fireTitlePress(mArguments?): sap.suite.ui.commons.ProcessFlowNode
    Fire event titlePress to attached listeners.

    Expects following event parameters:

    • 'oEvent' of type object The node identification.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Deprecated:
    Since version 1.26. Should not be used any longer, use Press event instead ( click on the node)
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining
    getIsTitleClickable(): boolean
    Getter for property isTitleClickable. Specifies if the node title is clickable.

    Default value is false

    Deprecated:
    Since version 1.26. According to the new requirement there should be only one click event for each node (click on the whole node – see Press event) that is why titlePress event should not be used any longer. Hence isTitleClickable should not be used either.
    Returns:
    {boolean} the value of property isTitleClickable
    setIsTitleClickable(bIsTitleClickable): sap.suite.ui.commons.ProcessFlowNode
    Setter for property isTitleClickable.

    Default value is false

    Parameters:
    {boolean}bIsTitleClickable new value for property isTitleClickable
    Deprecated:
    Since version 1.26. According to the new requirement there should be only one click event for each node (click on the whole node – see Press event) that is why titlePress event should not be used any longer. Hence isTitleClickable should not be used either.
    Returns:
    {sap.suite.ui.commons.ProcessFlowNode}this to allow method chaining