Class sap.ca.ui.HierarchyModule: sap/ca/ui/Hierarchy

extends Control

Display the Hierarchy of an item. Useful to indicates where an object stand in a chain of hierarchical data. The emphasized item shows the one item to display. Optional item can be hidden using the hideOptionalLevels property. Hidden items will stay accessible with an expand button.

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

Constructor Summary
new sap.ca.ui.Hierarchy(sId?, mSettings?)Constructor for a new Hierarchy.
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.Hierarchy.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.Hierarchy with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.Hierarchy.getMetadata()Returns a metadata object for class sap.ca.ui.Hierarchy.
addItem(oItem)Adds some item oItem to the aggregation named items.
bindItems(sPath, oTemplate, oSorter, aFilters)Binder for aggregation items.
destroyItems()Destroys all the items in the aggregation named items.
getHideOptionalLevels()Getter for property hideOptionalLevels.
getItems()Getter for aggregation items.
indexOfItem(oItem)Checks for the provided sap.ca.ui.HierarchyItem in the aggregation named items and returns its index if found or -1 otherwise.
insertItem(oItem, iIndex)Inserts a item into the aggregation named items.
removeAllItems()Removes all the controls in the aggregation named items.
removeItem(vItem)Removes an item from the aggregation named items.
setHideOptionalLevels(bHideOptionalLevels)Setter for property hideOptionalLevels.
unbindItems()Unbinder for aggregation items.
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.Hierarchy(sId?, mSettings?)
Constructor for a new Hierarchy.

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
    • items : sap.ca.ui.HierarchyItem[]
  • 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
      Deprecated:
      Since version 1.24.3. This control is not required anymore as per central UX requirements. This control will not be supported anymore.
      Method Detail
      sap.ca.ui.Hierarchy.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.Hierarchy 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.Hierarchy.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.Hierarchy.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addItem(oItem): sap.ca.ui.Hierarchy
      Adds some item oItem to the aggregation named items.
      Parameters:
      {sap.ca.ui.HierarchyItem}oItem the item to add; if empty, nothing is inserted
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining
      bindItems(sPath, oTemplate, oSorter, aFilters): sap.ca.ui.Hierarchy
      Binder for aggregation items.
      Parameters:
      {string}sPath path to a list in the model
      {sap.ui.core.Element}oTemplate the control template for this aggregation
      {sap.ui.model.Sorter}oSorter the initial sort order (optional)
      {array}aFilters the predefined filters for this aggregation (optional)
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining
      destroyItems(): sap.ca.ui.Hierarchy
      Destroys all the items in the aggregation named items.
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining
      getHideOptionalLevels(): boolean
      Getter for property hideOptionalLevels. Hide the levels marked optional. An expand button will appear

      Default value is true

      Returns:
      {boolean} the value of property hideOptionalLevels
      getItems(): sap.ca.ui.HierarchyItem[]
      Getter for aggregation items.
      The array of HierarchyItem ordered and starting from the root hierarchy
      Returns:
      {sap.ca.ui.HierarchyItem[]}
      indexOfItem(oItem): int
      Checks for the provided sap.ca.ui.HierarchyItem in the aggregation named items and returns its index if found or -1 otherwise.
      Parameters:
      {sap.ca.ui.HierarchyItem}oItem the item whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      insertItem(oItem, iIndex): sap.ca.ui.Hierarchy
      Inserts a item into the aggregation named items.
      Parameters:
      {sap.ca.ui.HierarchyItem}oItem the item to insert; if empty, nothing is inserted
      {int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining
      removeAllItems(): sap.ca.ui.HierarchyItem[]
      Removes all the controls in the aggregation named items.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.ca.ui.HierarchyItem[]} an array of the removed elements (might be empty)
      removeItem(vItem): sap.ca.ui.HierarchyItem
      Removes an item from the aggregation named items.
      Parameters:
      {int|string|sap.ca.ui.HierarchyItem}vItem the item to remove or its index or id
      Returns:
      {sap.ca.ui.HierarchyItem} the removed item or null
      setHideOptionalLevels(bHideOptionalLevels): sap.ca.ui.Hierarchy
      Setter for property hideOptionalLevels.

      Default value is true

      Parameters:
      {boolean}bHideOptionalLevels new value for property hideOptionalLevels
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining
      unbindItems(): sap.ca.ui.Hierarchy
      Unbinder for aggregation items.
      Returns:
      {sap.ca.ui.Hierarchy}this to allow method chaining