sap.suite.ui.commons.ProcessFlow.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.ProcessFlow 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 |
Returns a metadata object for class sap.suite.ui.commons.ProcessFlow.
Returns:
Adds some lane oLane
to the aggregation named lanes
.
Parameters:
Returns:
applyNodeDisplayState()
Function applies the changes to the display state based on the requirements. If any node is in the highlighted state all others are set to the dimmed state.
Attach event handler
fnFunction
to the 'headerPress' event of this
sap.suite.ui.commons.ProcessFlow
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlow
.
itself. This event is fired when the header column was clicked.
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.ProcessFlow . itself. |
Returns:
Attach event handler
fnFunction
to the 'labelPress' event of this
sap.suite.ui.commons.ProcessFlow
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlow
.
itself. This event is fired when a process flow connection label was clicked.
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.ProcessFlow . itself. |
Returns:
Attach event handler
fnFunction
to the 'nodePress' event of this
sap.suite.ui.commons.ProcessFlow
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlow
.
itself. This event is fired when a process flow node was clicked.
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.ProcessFlow . itself. |
Returns:
Attach event handler
fnFunction
to the 'onError' event of this
sap.suite.ui.commons.ProcessFlow
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlow
.
itself. This event is fired when an issue occurs with the process flow calculation. In most cases, there is an issue with the data. The console contains the detailed error description with the errors.
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.ProcessFlow . itself. |
Returns:
Destroys all the lanes in the aggregation named lanes
.
Returns:
Destroys all the nodes in the aggregation named nodes
.
Returns:
Detach event handler
fnFunction
from the 'headerPress' event of this
sap.suite.ui.commons.ProcessFlow
.
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:
Detach event handler
fnFunction
from the 'labelPress' event of this
sap.suite.ui.commons.ProcessFlow
.
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:
Detach event handler
fnFunction
from the 'nodePress' event of this
sap.suite.ui.commons.ProcessFlow
.
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:
Detach event handler
fnFunction
from the 'onError' event of this
sap.suite.ui.commons.ProcessFlow
.
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:
Fire event headerPress to attached listeners.
Expects following event parameters:
- 'oEvent' of type
object
This object represents the wrapped process flow lane header object.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event labelPress to attached listeners.
Expects following event parameters:
- 'oEvent' of type
object
This object represents the label information.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event nodePress to attached listeners.
Expects following event parameters:
- 'oEvent' of type
object
This object represents the wrapped process flow node object.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event onError to attached listeners.
Expects following event parameters:
- 'oEvent' of type
object
This parameters contains the localized string with error message.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
getFocusedNode(): String
Function returns the nodeId of the node which is focused.
Returns:
{String} | The id of focused node |
getFoldedCorners(): boolean
Getter for property
foldedCorners
. This property defines the folded corners for the single node control. The following values exist: - true: means folded corner - false/null/undefined: means normal corner
Default value is false
Returns:
{boolean} | the value of property foldedCorners |
Getter for aggregation
lanes
.
This is a header of the table for the process flow control.
Note: this is the default aggregation for ProcessFlow.
Returns:
Getter for aggregation nodes
.
This is the aggregation of the node controls put into the table to the calculated cells.
Returns:
getScrollable(): boolean
Getter for property
scrollable
. By default, the control body is embedded into a scroll container of fixed size, so the user can put the control into a fixe sized layout. When the control body (the graph) gets larger than the container cuts the overflowing parts of the graph and the cut parts can be viewed by scroling the control body. When the control body fits into the container limits, obviously no scrolling is possible (and makes sense).
The scrolling feature can be turned off by setting this property value to false, so the width/height of the whole control will change as the flow graph gets smaller/larger. In this case the control body could not be scrolled, as the control body size matches the control container size.
Default value is true
Returns:
{boolean} | the value of property scrollable |
getShowLabels(): boolean
Getter for property
showLabels
. Defines if the connection labels are shown or not.
Default value is false
Returns:
{boolean} | the value of property showLabels |
getWheelZoomable(): boolean
Getter for property
wheelZoomable
. The property specifies if to enable semantic zooming by mouse wheel events on desktop browsers.
Default value is true
Returns:
{boolean} | the value of property wheelZoomable |
getZoomLevel(): String
Function returns current zoom level.
Returns:
indexOfLane(oLane): int
Checks for the provided sap.suite.ui.commons.ProcessFlowLaneHeader
in the aggregation named lanes
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfNode(oNode): int
Checks for the provided sap.suite.ui.commons.ProcessFlowNode
in the aggregation named nodes
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a lane into the aggregation named lanes
.
Parameters:
{sap.suite.ui.commons.ProcessFlowLaneHeader} | oLane | the lane to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the lane should be inserted at; for a negative value of iIndex , the lane is inserted at position 0; for a value greater than the current size of the aggregation, the lane is inserted at the last position |
Returns:
Inserts a node into the aggregation named nodes
.
Parameters:
{sap.suite.ui.commons.ProcessFlowNode} | 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:
Removes all the controls in the aggregation named lanes
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named nodes
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an lane from the aggregation named lanes
.
Parameters:
Returns:
Removes an node from the aggregation named nodes
.
Parameters:
Returns:
setFocusToLabel(Label)
Sets the focus to the given Label
Parameters:
{sap.suite.ui.commons.ProcessFlowConnectionlabel} | Label | to focus |
- Since:
- 1.32
Setter for property
foldedCorners
.
Default value is false
Parameters:
{boolean} | bFoldedCorners | new value for property foldedCorners |
Returns:
Setter for property
scrollable
.
Default value is true
Parameters:
{boolean} | bScrollable | new value for property scrollable |
Returns:
setSelectedPath(sourceNodeId, targetNodeId)
Sets the path between source and target node to selected status and rerenders the control. If parameters are null, sets all nodes to normal status.
Parameters:
{String} | sourceNodeId | of the path or null |
{String} | targetNodeId | of the path or null |
- Since:
- 1.32
setShowLabels(New)
Overwrites setShowLabels of ProcessFlow control to apply additional functionality.
Parameters:
{Boolean} | New | value for showLabels |
Setter for property
wheelZoomable
.
Default value is true
Parameters:
{boolean} | bWheelZoomable | new value for property wheelZoomable |
Returns:
setZoomLevel()
Function sets the zoom level.
Parameters:
| zoomLevel. | this is a new zoom level of the type sap.suite.ui.commons.ProcessFlowZoomLevel |
updateModel()
Updates the model and rerenders the control.
updateNodesOnly()
Updates the nodes and rerenders the control.
zoomIn(): String
Function sets new zoom level with higher level of details. Having max details it stays as it is.
Returns:
{String} | The updated zoomLevel |
zoomOut(): String
Function sets new zoom level with smaller level of details. Having the least detail view it stays as it is.
Returns:
{String} | The updated zoomLevel |
Attach event handler
fnFunction
to the 'nodeTitlePress' event of this
sap.suite.ui.commons.ProcessFlow
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlow
.
itself. This event is fired when a process flow node title was clicked. The user can access the clicked process flow node control object which is the only argument of the event handler.
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.ProcessFlow . itself. |
- Deprecated:
- Since version 1.26. Should not be used any longer, use nodePress event instead ( click on the node)
Returns:
Detach event handler
fnFunction
from the 'nodeTitlePress' event of this
sap.suite.ui.commons.ProcessFlow
.
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 nodePress event instead ( click on the node)
Returns:
Fire event nodeTitlePress to attached listeners.
Expects following event parameters:
- 'oEvent' of type
object
This object represents the wrapped process flow node object.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
- Deprecated:
- Since version 1.26. Should not be used any longer, use nodePress event instead ( click on the node)
Returns: