Class sap.suite.ui.commons.HeaderCellModule: sap/suite/ui/commons/HeaderCell

extends Control

This control contains 4 cells (West, North, East, South). It can display one or more controls in different layouts. Each aggregation must contain only one instance of HeaderCellItem.

Constructor Summary
new sap.suite.ui.commons.HeaderCell(sId?, mSettings?)Constructor for a new HeaderCell.
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.HeaderCell.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.HeaderCell with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.HeaderCell.getMetadata()Returns a metadata object for class sap.suite.ui.commons.HeaderCell.
destroyEast()Destroys the east in the aggregation named east.
destroyNorth()Destroys the north in the aggregation named north.
destroySouth()Destroys the south in the aggregation named south.
destroyWest()Destroys the west in the aggregation named west.
getEast()Getter for aggregation east.
getHeight()Getter for property height.
getNorth()Getter for aggregation north.
getSouth()Getter for aggregation south.
getWest()Getter for aggregation west.
setEast(oEast)Setter for the aggregated east.
setHeight(sHeight)Setter for property height.
setNorth(oNorth)Setter for the aggregated north.
setSouth(oSouth)Setter for the aggregated south.
setWest(oWest)Setter for the aggregated west.
getHeigth()Getter for property heigth.
setHeigth(sHeigth)Setter for property heigth.
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.suite.ui.commons.HeaderCell(sId?, mSettings?)
Constructor for a new HeaderCell.

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
    • heigth : sap.ui.core.CSSSize (default: '100px')
    • height : sap.ui.core.CSSSize (default: '106px')
  • Aggregations
    • west : sap.suite.ui.commons.HeaderCellItem
    • north : sap.suite.ui.commons.HeaderCellItem
    • east : sap.suite.ui.commons.HeaderCellItem
    • south : sap.suite.ui.commons.HeaderCellItem
  • 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
      Method Detail
      sap.suite.ui.commons.HeaderCell.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.HeaderCell 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.HeaderCell.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.HeaderCell.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      destroyEast(): sap.suite.ui.commons.HeaderCell
      Destroys the east in the aggregation named east.
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      destroyNorth(): sap.suite.ui.commons.HeaderCell
      Destroys the north in the aggregation named north.
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      destroySouth(): sap.suite.ui.commons.HeaderCell
      Destroys the south in the aggregation named south.
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      destroyWest(): sap.suite.ui.commons.HeaderCell
      Destroys the west in the aggregation named west.
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      getEast(): sap.suite.ui.commons.HeaderCellItem
      Getter for aggregation east.
      Objecth that contains control to render in east area of the HeaderCell.
      Returns:
      {sap.suite.ui.commons.HeaderCellItem}
      getHeight(): sap.ui.core.CSSSize
      Getter for property height. Height of the HeaderCell control.

      Default value is 106px

      Returns:
      {sap.ui.core.CSSSize} the value of property height
      getNorth(): sap.suite.ui.commons.HeaderCellItem
      Getter for aggregation north.
      Objecth that contains control to render in north area of the HeaderCell.
      Returns:
      {sap.suite.ui.commons.HeaderCellItem}
      getSouth(): sap.suite.ui.commons.HeaderCellItem
      Getter for aggregation south.
      Objecth that contains control to render in south area of the HeaderCell.
      Returns:
      {sap.suite.ui.commons.HeaderCellItem}
      getWest(): sap.suite.ui.commons.HeaderCellItem
      Getter for aggregation west.
      Objecth that contains control to render in west area of the HeaderCell.
      Returns:
      {sap.suite.ui.commons.HeaderCellItem}
      setEast(oEast): sap.suite.ui.commons.HeaderCell
      Setter for the aggregated east.
      Parameters:
      {sap.suite.ui.commons.HeaderCellItem}oEast
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      setHeight(sHeight): sap.suite.ui.commons.HeaderCell
      Setter for property height.

      Default value is 106px

      Parameters:
      {sap.ui.core.CSSSize}sHeight new value for property height
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      setNorth(oNorth): sap.suite.ui.commons.HeaderCell
      Setter for the aggregated north.
      Parameters:
      {sap.suite.ui.commons.HeaderCellItem}oNorth
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      setSouth(oSouth): sap.suite.ui.commons.HeaderCell
      Setter for the aggregated south.
      Parameters:
      {sap.suite.ui.commons.HeaderCellItem}oSouth
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      setWest(oWest): sap.suite.ui.commons.HeaderCell
      Setter for the aggregated west.
      Parameters:
      {sap.suite.ui.commons.HeaderCellItem}oWest
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining
      getHeigth(): sap.ui.core.CSSSize
      Getter for property heigth. Height of the HeaderCell control.

      Default value is 100px

      Deprecated:
      Since version 1.20.2. Wrong property name
      Returns:
      {sap.ui.core.CSSSize} the value of property heigth
      setHeigth(sHeigth): sap.suite.ui.commons.HeaderCell
      Setter for property heigth.

      Default value is 100px

      Parameters:
      {sap.ui.core.CSSSize}sHeigth new value for property heigth
      Deprecated:
      Since version 1.20.2. Wrong property name
      Returns:
      {sap.suite.ui.commons.HeaderCell}this to allow method chaining