Class sap.ui.commons.ApplicationHeaderModule: sap/ui/commons/ApplicationHeader
The application header control stands on the top of any application page. It consists of 4 areas: Logo area, Function area provided by application, Search area, Logout area.
Deprecated API:Since version 1.38. Instead, use the sap.tnt.ToolHeader
control.
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the logoff
event of this sap.ui.commons.ApplicationHeader
.fnFunction
from the logoff
event of this sap.ui.commons.ApplicationHeader
. Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- logoSrc : sap.ui.core.URI
- logoText : string
- displayLogoff : boolean (default: true)
- userName : string
- displayWelcome : boolean (default: true)
- Events
- logoff : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.
{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.38. Instead, use the
sap.tnt.ToolHeader
control.
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of information as described in sap.ui.core.Control.extend.
{string} | sClassName | Name of the class being created |
{object} | oClassInfo? | Object literal with information about the class |
{function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
{function} | Created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
fnFunction
to the logoff
event of this sap.ui.commons.ApplicationHeader
. When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.commons.ApplicationHeader
itself.
Fires an event to log off the user from the application. No 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 be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.ApplicationHeader itself |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
fnFunction
from the logoff
event of this sap.ui.commons.ApplicationHeader
. The passed function and listener object must match the ones used for event registration.
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
logoff
to attached listeners. {Map} | mArguments? | The arguments to pass along with the event |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
displayLogoff
. Determines if the logoff area will be displayed at the right hand side of the application header.
Default value is true
.
{boolean} | Value of property displayLogoff |
displayWelcome
. Determines if the welcome text is displayed
Default value is true
.
{boolean} | Value of property displayWelcome |
logoSrc
. Path (src) to the logo icon to be displayed in the application header.
{sap.ui.core.URI} | Value of property logoSrc |
logoText
. The text that will be displayed beside the logo in the application header. This property is optional.
{string} | Value of property logoText |
userName
. User name that will be displayed beside the welcome text
{string} | Value of property userName |
displayLogoff
. Determines if the logoff area will be displayed at the right hand side of the application header.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bDisplayLogoff | New value for property displayLogoff |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
displayWelcome
. Determines if the welcome text is displayed
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
{boolean} | bDisplayWelcome | New value for property displayWelcome |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
logoSrc
. Path (src) to the logo icon to be displayed in the application header.
When called with a value of null
or undefined
, the default value of the property will be restored.
{sap.ui.core.URI} | sLogoSrc | New value for property logoSrc |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
logoText
. The text that will be displayed beside the logo in the application header. This property is optional.
When called with a value of null
or undefined
, the default value of the property will be restored.
{string} | sLogoText | New value for property logoText |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |
userName
. User name that will be displayed beside the welcome text
When called with a value of null
or undefined
, the default value of the property will be restored.
{string} | sUserName | New value for property userName |
{sap.ui.commons.ApplicationHeader} | Reference to this in order to allow method chaining |