Class sap.landvisz.internal.HeaderListModule: sap/landvisz/internal/HeaderList

extends Control

A control to render headers of a control

Constructor Summary
new sap.landvisz.internal.HeaderList(sId?, mSettings?)Constructor for a new internal/HeaderList.
Event Summary
press(oControlEvent)Event triggered when 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.landvisz.internal.HeaderList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.internal.HeaderList with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.internal.HeaderList.getMetadata()Returns a metadata object for class sap.landvisz.internal.HeaderList.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.landvisz.internal.HeaderList.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.landvisz.internal.HeaderList.
firePress(mArguments?)Fire event press to attached listeners.
getEntitySize()Getter for property entitySize.
getHeaderTooltip()Getter for property headerTooltip.
getSelected()Getter for property selected.
getType()Getter for property type.
setEntitySize(sEntitySize)Setter for property entitySize.
setHeaderTooltip(sHeaderTooltip)Setter for property headerTooltip.
setSelected(bSelected)Setter for property selected.
setType(oType)Setter for property type.
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.landvisz.internal.HeaderList(sId?, mSettings?)
Constructor for a new internal/HeaderList.

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)
      Event triggered when header is clicked
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.landvisz.internal.HeaderList.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.landvisz.internal.HeaderList 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.landvisz.internal.HeaderList.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.landvisz.internal.HeaderList.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachPress(oData?, fnFunction, oListener?): sap.landvisz.internal.HeaderList
      Attach event handler fnFunction to the 'press' event of this sap.landvisz.internal.HeaderList.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.landvisz.internal.HeaderList.
      itself.

      Event triggered when 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.landvisz.internal.HeaderList.
      itself.
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining
      detachPress(fnFunction, oListener): sap.landvisz.internal.HeaderList
      Detach event handler fnFunction from the 'press' event of this sap.landvisz.internal.HeaderList.

      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.landvisz.internal.HeaderList}this to allow method chaining
      firePress(mArguments?): sap.landvisz.internal.HeaderList
      Fire event press to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining
      getEntitySize(): string
      Getter for property entitySize. Size of the headers

      Default value is empty/undefined

      Returns:
      {string} the value of property entitySize
      getHeaderTooltip(): string
      Getter for property headerTooltip. ToolTip for headers

      Default value is empty/undefined

      Returns:
      {string} the value of property headerTooltip
      getSelected(): boolean
      Getter for property selected. to select/deselect a header

      Default value is false

      Returns:
      {boolean} the value of property selected
      getType(): sap.landvisz.LandscapeObject
      Getter for property type. type of system

      Default value is empty/undefined

      Returns:
      {sap.landvisz.LandscapeObject} the value of property type
      setEntitySize(sEntitySize): sap.landvisz.internal.HeaderList
      Setter for property entitySize.

      Default value is empty/undefined

      Parameters:
      {string}sEntitySize new value for property entitySize
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining
      setHeaderTooltip(sHeaderTooltip): sap.landvisz.internal.HeaderList
      Setter for property headerTooltip.

      Default value is empty/undefined

      Parameters:
      {string}sHeaderTooltip new value for property headerTooltip
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining
      setSelected(bSelected): sap.landvisz.internal.HeaderList
      Setter for property selected.

      Default value is false

      Parameters:
      {boolean}bSelected new value for property selected
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining
      setType(oType): sap.landvisz.internal.HeaderList
      Setter for property type.

      Default value is empty/undefined

      Parameters:
      {sap.landvisz.LandscapeObject}oType new value for property type
      Returns:
      {sap.landvisz.internal.HeaderList}this to allow method chaining