Class sap.suite.ui.commons.ProcessFlowConnectionLabelModule: sap/suite/ui/commons/ProcessFlowConnectionLabel

extends Button

This control is used inside the ProcessFlow control providing information on connections. Using this control, you need to take care of the lifetime handling instance as instances of this control are not destroyed automatically.

Constructor Summary
new sap.suite.ui.commons.ProcessFlowConnectionLabel(sId?, mSettings?)Constructor for a new ProcessFlowConnectionLabel.
Events borrowed from class sap.m.Button
press, tap
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.ProcessFlowConnectionLabel.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.ProcessFlowConnectionLabel with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.ProcessFlowConnectionLabel.getMetadata()Returns a metadata object for class sap.suite.ui.commons.ProcessFlowConnectionLabel.
getPriority()Getter for property priority.
getState()Getter for property state.
setPriority(iPriority)Setter for property priority.
setState(oState)Setter for property state.
Methods borrowed from class sap.m.Button
addAriaDescribedBy, addAriaLabelledBy, attachPress, attachTap, detachPress, detachTap, firePress, fireTap, getAccessibilityInfo, getActiveIcon, getAriaDescribedBy, getAriaLabelledBy, getEnabled, getIcon, getIconDensityAware, getIconFirst, getPopupAnchorDomRef, getText, getTextDirection, getType, getWidth, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setActiveIcon, setEnabled, setIcon, setIconDensityAware, setText, setTextDirection, setType
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, 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.ProcessFlowConnectionLabel(sId?, mSettings?)
Constructor for a new ProcessFlowConnectionLabel.

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
    • priority : int (default: 0)
    • state : sap.suite.ui.commons.ProcessFlowConnectionLabelState (default: sap.suite.ui.commons.ProcessFlowConnectionLabelState.Neutral)
  • Aggregations
    • Associations
      • Events

        In addition, all settings applicable to the base type sap.m.Button 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
        Method Detail
        sap.suite.ui.commons.ProcessFlowConnectionLabel.extend(sClassName, oClassInfo?, FNMetaImpl?): function
        Creates a new subclass of class sap.suite.ui.commons.ProcessFlowConnectionLabel 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.ProcessFlowConnectionLabel.getMetadata(): sap.ui.base.Metadata
        Returns a metadata object for class sap.suite.ui.commons.ProcessFlowConnectionLabel.
        Returns:
        {sap.ui.base.Metadata} Metadata object describing this class
        getPriority(): int
        Getter for property priority. Priority is used to define which label is visible if the state of multiple labels is equal. Assuming there are multiple labels with equal state (e.g. Negative state appears twice), the priority decides which one needs to be selected.

        Default value is 0

        Returns:
        {int} the value of property priority
        getState(): sap.suite.ui.commons.ProcessFlowConnectionLabelState
        Getter for property state. Specifies the state of the connection label. If multiple labels are available for one connection, the label will be selected by state based on the following order: Neutral -> Positive -> Critical -> Negative.

        Default value is Neutral

        Returns:
        {sap.suite.ui.commons.ProcessFlowConnectionLabelState} the value of property state
        setPriority(iPriority): sap.suite.ui.commons.ProcessFlowConnectionLabel
        Setter for property priority.

        Default value is 0

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

        Default value is Neutral

        Parameters:
        {sap.suite.ui.commons.ProcessFlowConnectionLabelState}oState new value for property state
        Returns:
        {sap.suite.ui.commons.ProcessFlowConnectionLabel}this to allow method chaining