Class sap.ca.ui.HierarchicalSelectDialogModule: sap/ca/ui/HierarchicalSelectDialog

extends Dialog

Select an item in a dialog from a hierarchical list

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

Constructor Summary
new sap.ca.ui.HierarchicalSelectDialog(sId?, mSettings?)Constructor for a new HierarchicalSelectDialog.
Event Summary
cancel(oControlEvent)Thrown when user clicks cancel
select(oControlEvent)Thrown when user selects an item
Events borrowed from class sap.m.Dialog
afterClose, afterOpen, beforeClose, beforeOpen
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.HierarchicalSelectDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.HierarchicalSelectDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.HierarchicalSelectDialog.getMetadata()Returns a metadata object for class sap.ca.ui.HierarchicalSelectDialog.
addItem(oItem)Adds some item oItem to the aggregation named items.
attachCancel(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'cancel' event of this sap.ca.ui.HierarchicalSelectDialog.
attachSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'select' event of this sap.ca.ui.HierarchicalSelectDialog.
destroyItems()Destroys all the items in the aggregation named items.
detachCancel(fnFunction, oListener)Detach event handler fnFunction from the 'cancel' event of this sap.ca.ui.HierarchicalSelectDialog.
detachSelect(fnFunction, oListener)Detach event handler fnFunction from the 'select' event of this sap.ca.ui.HierarchicalSelectDialog.
fireCancel(mArguments?)Fire event cancel to attached listeners.
fireSelect(mArguments?)Fire event select to attached listeners.
getItems()Getter for aggregation items.
indexOfItem(oItem)Checks for the provided sap.ca.ui.HierarchicalSelectDialogItem in the aggregation named items and returns its index if found or -1 otherwise.
removeAllItems()Removes all the controls in the aggregation named items.
removeItem(vItem)Removes an item from the aggregation named items.
Methods borrowed from class sap.m.Dialog
_getAnyHeader, addAriaDescribedBy, addAriaLabelledBy, addButton, addContent, attachAfterClose, attachAfterOpen, attachBeforeClose, attachBeforeOpen, close, destroyBeginButton, destroyButtons, destroyContent, destroyCustomHeader, destroyEndButton, destroySubHeader, detachAfterClose, detachAfterOpen, detachBeforeClose, detachBeforeOpen, fireAfterClose, fireAfterOpen, fireBeforeClose, fireBeforeOpen, getAriaDescribedBy, getAriaLabelledBy, getBeginButton, getButtons, getContent, getContentHeight, getContentWidth, getCustomHeader, getDraggable, getEndButton, getHorizontalScrolling, getIcon, getInitialFocus, getLeftButton, getResizable, getRightButton, getShowHeader, getState, getStretch, getStretchOnPhone, getSubHeader, getTitle, getType, getVerticalScrolling, indexOfButton, indexOfContent, insertButton, insertContent, isOpen, open, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAllButtons, removeAllContent, removeAriaDescribedBy, removeAriaLabelledBy, removeButton, removeContent, setBeginButton, setContentHeight, setContentWidth, setCustomHeader, setDraggable, setEndButton, setHorizontalScrolling, setIcon, setInitialFocus, setLeftButton, setResizable, setRightButton, setShowHeader, setState, setStretch, setStretchOnPhone, setSubHeader, setTitle, setType, setVerticalScrolling
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.HierarchicalSelectDialog(sId?, mSettings?)
Constructor for a new HierarchicalSelectDialog.

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(default aggregation) : sap.ca.ui.HierarchicalSelectDialogItem[]
    • Associations
      • Events
        • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • cancel : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

      In addition, all settings applicable to the base type sap.m.Dialog 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
      Deprecated:
      Since version 1.24.1. HierarchicalSelectDialog is deprecated as per central UX requirements. This control will not be supported anymore.
      Event Detail
      cancel(oControlEvent)
      Thrown when user clicks cancel
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      select(oControlEvent)
      Thrown when user selects an item
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.ca.ui.HierarchicalSelectDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.HierarchicalSelectDialog 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.HierarchicalSelectDialog.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.HierarchicalSelectDialog.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      addItem(oItem): sap.ca.ui.HierarchicalSelectDialog
      Adds some item oItem to the aggregation named items.
      Parameters:
      {sap.ca.ui.HierarchicalSelectDialogItem}oItem the item to add; if empty, nothing is inserted
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      attachCancel(oData?, fnFunction, oListener?): sap.ca.ui.HierarchicalSelectDialog
      Attach event handler fnFunction to the 'cancel' event of this sap.ca.ui.HierarchicalSelectDialog.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.HierarchicalSelectDialog.
      itself.

      Thrown when user clicks cancel

      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.HierarchicalSelectDialog.
      itself.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      attachSelect(oData?, fnFunction, oListener?): sap.ca.ui.HierarchicalSelectDialog
      Attach event handler fnFunction to the 'select' event of this sap.ca.ui.HierarchicalSelectDialog.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.HierarchicalSelectDialog.
      itself.

      Thrown when user selects an item

      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.HierarchicalSelectDialog.
      itself.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      destroyItems(): sap.ca.ui.HierarchicalSelectDialog
      Destroys all the items in the aggregation named items.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      detachCancel(fnFunction, oListener): sap.ca.ui.HierarchicalSelectDialog
      Detach event handler fnFunction from the 'cancel' event of this sap.ca.ui.HierarchicalSelectDialog.

      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.HierarchicalSelectDialog}this to allow method chaining
      detachSelect(fnFunction, oListener): sap.ca.ui.HierarchicalSelectDialog
      Detach event handler fnFunction from the 'select' event of this sap.ca.ui.HierarchicalSelectDialog.

      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.HierarchicalSelectDialog}this to allow method chaining
      fireCancel(mArguments?): sap.ca.ui.HierarchicalSelectDialog
      Fire event cancel to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      fireSelect(mArguments?): sap.ca.ui.HierarchicalSelectDialog
      Fire event select to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialog}this to allow method chaining
      getItems(): sap.ca.ui.HierarchicalSelectDialogItem[]
      Getter for aggregation items.
      Type checker, only HierarchicalSelectDialogItem are allowed. Please do NOT use the "content" aggregation of the dialog

      Note: this is the default aggregation for HierarchicalSelectDialog.

      Returns:
      {sap.ca.ui.HierarchicalSelectDialogItem[]}
      indexOfItem(oItem): int
      Checks for the provided sap.ca.ui.HierarchicalSelectDialogItem in the aggregation named items and returns its index if found or -1 otherwise.
      Parameters:
      {sap.ca.ui.HierarchicalSelectDialogItem}oItem the item whose index is looked for.
      Returns:
      {int} the index of the provided control in the aggregation if found, or -1 otherwise
      removeAllItems(): sap.ca.ui.HierarchicalSelectDialogItem[]
      Removes all the controls in the aggregation named items.
      Additionally unregisters them from the hosting UIArea.
      Returns:
      {sap.ca.ui.HierarchicalSelectDialogItem[]} an array of the removed elements (might be empty)
      removeItem(vItem): sap.ca.ui.HierarchicalSelectDialogItem
      Removes an item from the aggregation named items.
      Parameters:
      {int|string|sap.ca.ui.HierarchicalSelectDialogItem}vItem the item to remove or its index or id
      Returns:
      {sap.ca.ui.HierarchicalSelectDialogItem} the removed item or null