Class sap.suite.ui.commons.ProcessFlowConnectionModule: sap/suite/ui/commons/ProcessFlowConnection

extends Control

This control is used inside the ProcessFlow control to connect process flow node A with process flow node B in respect to the style(x) chosen by the application.

Constructor Summary
new sap.suite.ui.commons.ProcessFlowConnection(sId?, mSettings?)Constructor for a new ProcessFlowConnection.
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.ProcessFlowConnection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ProcessFlowConnection with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ProcessFlowConnection.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ProcessFlowConnection.
addConnectionData(singleConnectionData)Adds connection data.
getDrawData()Getter for property drawData.
getZoomLevel()Getter for property zoomLevel.
setDrawData(aDrawData)Setter for property drawData.
setZoomLevel(oZoomLevel)Setter for property zoomLevel.
getState()Getter for property state.
getType()Getter for property type.
setState(oState)Setter for property state.
setType(oType)Setter for property type.
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.suite.ui.commons.ProcessFlowConnection(sId?, mSettings?)
Constructor for a new ProcessFlowConnection.

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
    • drawData : object[]
    • zoomLevel : sap.suite.ui.commons.ProcessFlowZoomLevel (default: sap.suite.ui.commons.ProcessFlowZoomLevel.Two)
    • type : sap.suite.ui.commons.ProcessFlowConnectionType (default: sap.suite.ui.commons.ProcessFlowConnectionType.Normal)
    • state : sap.suite.ui.commons.ProcessFlowConnectionState (default: sap.suite.ui.commons.ProcessFlowConnectionState.Regular)
  • Aggregations
    • Associations
      • Events
        Parameters:
        {string}sId? id for the new control, generated automatically if no id is given
        {object}mSettings? initial settings for the new control
        Method Detail
        sap.suite.ui.commons.ProcessFlowConnection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
        Creates a new subclass of class sap.suite.ui.commons.ProcessFlowConnection 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.ProcessFlowConnection.getMetadata(): sap.ui.base.Metadata
        Returns a metadata object for class sap.suite.ui.commons.ProcessFlowConnection.
        Returns:
        {sap.ui.base.Metadata} Metadata object describing this class
        addConnectionData(singleConnectionData): Array
        Adds connection data.
        Parameters:
        {object}singleConnectionData
        Returns:
        {Array} connectionData
        getDrawData(): object[]
        Getter for property drawData. This is an array of the following attributes for one element: 1. flowLine (string) - A connection definition where the line should be drawn. A string which defines a course of a flow line. A flow line is a connection between nodes in a process flow control. The string can contain the following characters: - "r" for right, - "t" for top, - "l" for left, - "b" for bottom. 2. targetNodeState (ProcessFlowNodeState) - A copy of the target node status. If the target node is created, the line is solid. If the target node is planned, the line is dashed. 3. displayState (ProcessFlowDisplayState) - Display state of the node. This property defines if the node is displayed regularly, highlighted, or dimmed in combination with a selected visual style of the control. 4. hasArrow (boolean) - Indicates if the line has an arrow on the right end.

        Default value is empty/undefined

        Returns:
        {object[]} the value of property drawData
        getZoomLevel(): sap.suite.ui.commons.ProcessFlowZoomLevel
        Getter for property zoomLevel. This is a current zoom level for the connection. The point of connection to the node is derived from zoom level.

        Default value is Two

        Returns:
        {sap.suite.ui.commons.ProcessFlowZoomLevel} the value of property zoomLevel
        setDrawData(aDrawData): sap.suite.ui.commons.ProcessFlowConnection
        Setter for property drawData.

        Default value is empty/undefined

        Parameters:
        {object[]}aDrawData new value for property drawData
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnection}this to allow method chaining
        setZoomLevel(oZoomLevel): sap.suite.ui.commons.ProcessFlowConnection
        Setter for property zoomLevel.

        Default value is Two

        Parameters:
        {sap.suite.ui.commons.ProcessFlowZoomLevel}oZoomLevel new value for property zoomLevel
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnection}this to allow method chaining
        getState(): sap.suite.ui.commons.ProcessFlowConnectionState
        Getter for property state. State of the connection.

        Default value is Regular

        Deprecated:
        Since version 1.32. State is deprecated because of no usages. There will be no replacement.
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnectionState} the value of property state
        getType(): sap.suite.ui.commons.ProcessFlowConnectionType
        Getter for property type. Type of the connection.

        Default value is Normal

        Deprecated:
        Since version 1.32. Type is deprecated because of no usages. There will be no replacement.
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnectionType} the value of property type
        setState(oState): sap.suite.ui.commons.ProcessFlowConnection
        Setter for property state.

        Default value is Regular

        Parameters:
        {sap.suite.ui.commons.ProcessFlowConnectionState}oState new value for property state
        Deprecated:
        Since version 1.32. State is deprecated because of no usages. There will be no replacement.
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnection}this to allow method chaining
        setType(oType): sap.suite.ui.commons.ProcessFlowConnection
        Setter for property type.

        Default value is Normal

        Parameters:
        {sap.suite.ui.commons.ProcessFlowConnectionType}oType new value for property type
        Deprecated:
        Since version 1.32. Type is deprecated because of no usages. There will be no replacement.
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnection}this to allow method chaining