Class sap.suite.ui.commons.ProcessFlowLaneHeaderModule: sap/suite/ui/commons/ProcessFlowLaneHeader

extends Control

This control gives you an overview of documents/items used in a process flow. The process flow is represented by the doughnut chart sections which are colored according to the documents’ status(es). This control can be used in two different ways. If you use it standalone, an event is fired and can be caught in to display the node map. If you use it with the node/document, it gives you an overview of the documents/items used in the process flow that is represented by the doughnut chart sections.

Constructor Summary
new sap.suite.ui.commons.ProcessFlowLaneHeader(sId?, mSettings?)Constructor for a new ProcessFlowLaneHeader.
Event Summary
press(oControlEvent)This event is fired when the header is clicked.
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.ProcessFlowLaneHeader.createNewEndSymbol(isHeaderMode)Process symbol node factory method - creates a control with a square symbol used at the end of the lane header.
sap.suite.ui.commons.ProcessFlowLaneHeader.createNewProcessSymbol(isHeaderMode)Process symbol node factory method - creates a control with a '>>>' symbol.
sap.suite.ui.commons.ProcessFlowLaneHeader.createNewStartSymbol(isHeaderMode)Creates the start symbol at the beginning of the lane header.
sap.suite.ui.commons.ProcessFlowLaneHeader.enableEllipsisSupportForText(isSupportEnabled)Enable/disable ellipsis support for non-webkit browsers (for the case where there is no native ellipsis support).
sap.suite.ui.commons.ProcessFlowLaneHeader.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ProcessFlowLaneHeader with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ProcessFlowLaneHeader.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ProcessFlowLaneHeader.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.ProcessFlowLaneHeader.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.ProcessFlowLaneHeader.
firePress(mArguments?)Fire event press to attached listeners.
getIconSrc()Getter for property iconSrc.
getLaneId()Getter for property laneId.
getPosition()Overrides the getter method for property position.
getState()Getter for property state.
getText()Getter for property text.
getZoomLevel()Getter for property zoomLevel.
init()Process Flow Lane Header controller.
onAfterRendering()Standard method called after the control rendering.
onBeforeRendering()Standard method called before the control rendering.
setIconSrc(sIconSrc)Setter for property iconSrc.
setLaneId(sLaneId)Setter for property laneId.
setPosition(iPosition)Setter for property position.
setState(oState)Setter for property state.
setText(sText)Setter for property text.
setZoomLevel(oZoomLevel)Setter for property zoomLevel.
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.ProcessFlowLaneHeader(sId?, mSettings?)
Constructor for a new ProcessFlowLaneHeader.

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
      • Events
        • 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 header is clicked.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {object}oControlEvent.getParameters.oEvent tbd
      Method Detail
      sap.suite.ui.commons.ProcessFlowLaneHeader.createNewEndSymbol(isHeaderMode): sap.suite.ui.commons.ProcessFlowLaneHeader
      Process symbol node factory method - creates a control with a square symbol used at the end of the lane header.
      Parameters:
      {Boolean}isHeaderMode true if the hand cursor should be displayed above the header
      Since:
      1.22
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader} a new end symbol node
      sap.suite.ui.commons.ProcessFlowLaneHeader.createNewProcessSymbol(isHeaderMode): sap.suite.ui.commons.ProcessFlowLaneHeader
      Process symbol node factory method - creates a control with a '>>>' symbol.
      Parameters:
      {Boolean}isHeaderMode true if the hand cursor should be displayed above the header
      Since:
      1.22
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader} a new process symbol node
      sap.suite.ui.commons.ProcessFlowLaneHeader.createNewStartSymbol(isHeaderMode): sap.suite.ui.commons.ProcessFlowLaneHeader
      Creates the start symbol at the beginning of the lane header.
      Parameters:
      {Boolean}isHeaderMode true if the hand cursor should be displayed above the header
      Since:
      1.22
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader} a new start symbol node
      sap.suite.ui.commons.ProcessFlowLaneHeader.enableEllipsisSupportForText(isSupportEnabled)
      Enable/disable ellipsis support for non-webkit browsers (for the case where there is no native ellipsis support). It is recommended to disable the ellipsis support in case the control is inserted into a container of variable width as the ellipsis position is not updated automatically. By default the ellipsis support is enabled.
      Parameters:
      {Boolean}isSupportEnabled false if the ellipsis support is to be disabled
      Since:
      1.22
      sap.suite.ui.commons.ProcessFlowLaneHeader.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.ProcessFlowLaneHeader 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.ProcessFlowLaneHeader.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.ProcessFlowLaneHeader.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.ProcessFlowLaneHeader
      Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.ProcessFlowLaneHeader.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.ProcessFlowLaneHeader.
      itself.

      This event is fired when the header is 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.ProcessFlowLaneHeader.
      itself.
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      detachPress(fnFunction, oListener): sap.suite.ui.commons.ProcessFlowLaneHeader
      Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.ProcessFlowLaneHeader.

      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.ProcessFlowLaneHeader}this to allow method chaining
      firePress(mArguments?): sap.suite.ui.commons.ProcessFlowLaneHeader
      Fire event press to attached listeners.

      Expects following event parameters:

      • 'oEvent' of type object tbd
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      getIconSrc(): sap.ui.core.URI
      Getter for property iconSrc. Icon to be displayed in the middle of the control.

      Default value is empty/undefined

      Returns:
      {sap.ui.core.URI} the value of property iconSrc
      getLaneId(): string
      Getter for property laneId. Internal identification of the header.

      Default value is empty/undefined

      Returns:
      {string} the value of property laneId
      getPosition()
      Overrides the getter method for property position. It returns the position that was changed due to the artificial merged lanes. Otherwise it returns the position set in the model.
      getState(): object
      Getter for property state. Array of the ProcessFlowLaneState. The user can explicitly set an array with the two properties state and value of the state, for example [state:sap.suite.ui.commons.ProcessFlowNodeState.Neutral, value: 20]. Possible states are states are positive, negative, neutral, and planned.

      Default value is empty/undefined

      Returns:
      {object} the value of property state
      getText(): string
      Getter for property text. Text information that is displayed in the control.

      Default value is empty/undefined

      Returns:
      {string} the value of property text
      getZoomLevel(): sap.suite.ui.commons.ProcessFlowZoomLevel
      Getter for property zoomLevel. Current zoom level for the lane header.

      Default value is empty/undefined

      Returns:
      {sap.suite.ui.commons.ProcessFlowZoomLevel} the value of property zoomLevel
      init()
      Process Flow Lane Header controller.
      onAfterRendering()
      Standard method called after the control rendering.
      onBeforeRendering()
      Standard method called before the control rendering.
      setIconSrc(sIconSrc): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property iconSrc.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.URI}sIconSrc new value for property iconSrc
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      setLaneId(sLaneId): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property laneId.

      Default value is empty/undefined

      Parameters:
      {string}sLaneId new value for property laneId
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      setPosition(iPosition): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property position.

      Default value is empty/undefined

      Parameters:
      {int}iPosition new value for property position
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      setState(oState): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property state.

      Default value is empty/undefined

      Parameters:
      {object}oState new value for property state
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      setText(sText): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property text.

      Default value is empty/undefined

      Parameters:
      {string}sText new value for property text
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining
      setZoomLevel(oZoomLevel): sap.suite.ui.commons.ProcessFlowLaneHeader
      Setter for property zoomLevel.

      Default value is empty/undefined

      Parameters:
      {sap.suite.ui.commons.ProcessFlowZoomLevel}oZoomLevel new value for property zoomLevel
      Returns:
      {sap.suite.ui.commons.ProcessFlowLaneHeader}this to allow method chaining