Class sap.ca.ui.HierarchyItemModule: sap/ca/ui/HierarchyItem

extends Control

Item that represent a line of the Hierarchy control. The emphasized property should apply to the item that we want to represent in his hierarchy. Optionals item will be hidden if the option is true on the Hierarchy control.

Deprecated API:Since version 1.24. This control is deprecated as per central UX requirements. This control will not be supported anymore.

Constructor Summary
new sap.ca.ui.HierarchyItem(sId?, mSettings?)Constructor for a new HierarchyItem.
Event Summary
linkPress(oControlEvent)Event when a link is pressed
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.ca.ui.HierarchyItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.HierarchyItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.HierarchyItem.getMetadata()Returns a metadata object for class sap.ca.ui.HierarchyItem.
attachLinkPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'linkPress' event of this sap.ca.ui.HierarchyItem.
detachLinkPress(fnFunction, oListener)Detach event handler fnFunction from the 'linkPress' event of this sap.ca.ui.HierarchyItem.
fireLinkPress(mArguments?)Fire event linkPress to attached listeners.
getEmphasized()Getter for property emphasized.
getIcon()Getter for property icon.
getIdentifier()Getter for property identifier.
getLevelType()Getter for property levelType.
getLink()Getter for property link.
getOptional()Getter for property optional.
getTitle()Getter for property title.
setEmphasized(bEmphasized)Setter for property emphasized.
setIcon(sIcon)Setter for property icon.
setIdentifier(sIdentifier)Setter for property identifier.
setLevelType(sLevelType)Setter for property levelType.
setLink(sLink)Setter for property link.
setOptional(bOptional)Setter for property optional.
setTitle(sTitle)Setter for property title.
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, init, 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.ca.ui.HierarchyItem(sId?, mSettings?)
Constructor for a new HierarchyItem.

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
        • linkPress : 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
      Deprecated:
      Since version 1.24. This control is deprecated as per central UX requirements. This control will not be supported anymore.
      Event Detail
      linkPress(oControlEvent)
      Event when a link is pressed
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.ca.ui.HierarchyItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.HierarchyItem 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.ca.ui.HierarchyItem.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.HierarchyItem.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachLinkPress(oData?, fnFunction, oListener?): sap.ca.ui.HierarchyItem
      Attach event handler fnFunction to the 'linkPress' event of this sap.ca.ui.HierarchyItem.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.HierarchyItem.
      itself.

      Event when a link is pressed

      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.ca.ui.HierarchyItem.
      itself.
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      detachLinkPress(fnFunction, oListener): sap.ca.ui.HierarchyItem
      Detach event handler fnFunction from the 'linkPress' event of this sap.ca.ui.HierarchyItem.

      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.ca.ui.HierarchyItem}this to allow method chaining
      fireLinkPress(mArguments?): sap.ca.ui.HierarchyItem
      Fire event linkPress to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      getEmphasized(): boolean
      Getter for property emphasized. Does the item looks emphasized

      Default value is false

      Returns:
      {boolean} the value of property emphasized
      getIcon(): sap.ui.core.URI
      Getter for property icon. Icon for the item

      Default value is empty/undefined

      Returns:
      {sap.ui.core.URI} the value of property icon
      getIdentifier(): string
      Getter for property identifier. Identifier text

      Default value is empty/undefined

      Returns:
      {string} the value of property identifier
      getLevelType(): string
      Getter for property levelType. Level type

      Default value is empty/undefined

      Returns:
      {string} the value of property levelType
      getLink(): string
      Getter for property link. Text of the link

      Default value is empty/undefined

      Returns:
      {string} the value of property link
      getOptional(): boolean
      Getter for property optional. Is the item optional, so we hide it if option is set on the Hierarchy control

      Default value is false

      Returns:
      {boolean} the value of property optional
      getTitle(): string
      Getter for property title. Title

      Default value is empty/undefined

      Returns:
      {string} the value of property title
      setEmphasized(bEmphasized): sap.ca.ui.HierarchyItem
      Setter for property emphasized.

      Default value is false

      Parameters:
      {boolean}bEmphasized new value for property emphasized
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setIcon(sIcon): sap.ca.ui.HierarchyItem
      Setter for property icon.

      Default value is empty/undefined

      Parameters:
      {sap.ui.core.URI}sIcon new value for property icon
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setIdentifier(sIdentifier): sap.ca.ui.HierarchyItem
      Setter for property identifier.

      Default value is empty/undefined

      Parameters:
      {string}sIdentifier new value for property identifier
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setLevelType(sLevelType): sap.ca.ui.HierarchyItem
      Setter for property levelType.

      Default value is empty/undefined

      Parameters:
      {string}sLevelType new value for property levelType
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setLink(sLink): sap.ca.ui.HierarchyItem
      Setter for property link.

      Default value is empty/undefined

      Parameters:
      {string}sLink new value for property link
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setOptional(bOptional): sap.ca.ui.HierarchyItem
      Setter for property optional.

      Default value is false

      Parameters:
      {boolean}bOptional new value for property optional
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining
      setTitle(sTitle): sap.ca.ui.HierarchyItem
      Setter for property title.

      Default value is empty/undefined

      Parameters:
      {string}sTitle new value for property title
      Returns:
      {sap.ca.ui.HierarchyItem}this to allow method chaining