com.sap.ui.commons.client
Class ApplicationHeader

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.ApplicationHeader

public class ApplicationHeader
extends com.sap.ui.core.client.Control

The class ApplicationHeader is the GWT wrapper for the Phoenix control: sap.ui.commons.ApplicationHeader.

The application header control stands on the top of any application page. It consists basically of 4 areas. Logo area/Function area provided by application/Search area/Logout area

• Properties
  • logoSrc : String
    Path (src) to the logo icon to be displayed in the application header.
  • logoText : String
    The text that will be displayed beside the logo in the application header. This property is optional.
  • displayLogoff : boolean
    If set to true, the logoff area will be displayed at the right hand side of the application header.
  • userName : String
    User name that will be displayed beside the welcome text
  • displayWelcome : boolean
    By default, set to true and dislpays the welcome text
• Aggregations
• Associations
• Events
  • logoff Fires an event to log off the user from the application. No parameters.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.ApplicationHeader)

Constructor Summary

protected

ApplicationHeader() constructs the class ApplicationHeader hidden due to JavaScriptObject restriction

Method Summary

ApplicationHeader	attachLogoffEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Fires an event to log off the user from the application.
static ApplicationHeader	create() creates a new instance of the class ApplicationHeader
static ApplicationHeader	create(String idOrConfig) creates a new instance of the class ApplicationHeader
static ApplicationHeader	create(String id, String config) creates a new instance of the class ApplicationHeader
ApplicationHeader	detachLogoffEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Fires an event to log off the user from the application.
String	getLogoSrc() Getter for property logoSrc Path (src) to the logo icon to be displayed in the application header.
String	getLogoText() Getter for property logoText The text that will be displayed beside the logo in the application header.
String	getUserName() Getter for property userName User name that will be displayed beside the welcome text
boolean	isDisplayLogoff() Getter for property displayLogoff If set to true, the logoff area will be displayed at the right hand side of the application header.
boolean	isDisplayWelcome() Getter for property displayWelcome By default, set to true and dislpays the welcome text
ApplicationHeader	setDisplayLogoff(boolean value) Setter for property displayLogoff Default value is: true
ApplicationHeader	setDisplayWelcome(boolean value) Setter for property displayWelcome Default value is: true
ApplicationHeader	setLogoSrc(String value) Setter for property logoSrc
ApplicationHeader	setLogoText(String value) Setter for property logoText
ApplicationHeader	setUserName(String value) Setter for property userName

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationHeader

protected ApplicationHeader()

constructs the class ApplicationHeader
hidden due to JavaScriptObject restriction

Method Detail

create

public static ApplicationHeader create()

creates a new instance of the class ApplicationHeader

create

public static ApplicationHeader create(String idOrConfig)

creates a new instance of the class ApplicationHeader

Parameters:

id - id of the ApplicationHeader or configuration JSON string

create

public static ApplicationHeader create(String id,
                                       String config)

creates a new instance of the class ApplicationHeader

Parameters:

id - id of the ApplicationHeader

config - configuration JSON string

getLogoSrc

public final String getLogoSrc()

Getter for property logoSrc Path (src) to the logo icon to be displayed in the application header.

Returns:

the value of property logoSrc

setLogoSrc

public final ApplicationHeader setLogoSrc(String value)

Setter for property logoSrc

Parameters:

value - String

Returns:

this to allow method chaining

getLogoText

public final String getLogoText()

Getter for property logoText The text that will be displayed beside the logo in the application header. This property is optional.

Returns:

the value of property logoText

setLogoText

public final ApplicationHeader setLogoText(String value)

Setter for property logoText

Parameters:

value - String

Returns:

this to allow method chaining

isDisplayLogoff

public final boolean isDisplayLogoff()

Getter for property displayLogoff If set to true, the logoff area will be displayed at the right hand side of the application header.

Returns:

the value of property displayLogoff

setDisplayLogoff

public final ApplicationHeader setDisplayLogoff(boolean value)

Setter for property displayLogoff
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getUserName

public final String getUserName()

Getter for property userName User name that will be displayed beside the welcome text

Returns:

the value of property userName

setUserName

public final ApplicationHeader setUserName(String value)

Setter for property userName

Parameters:

value - String

Returns:

this to allow method chaining

isDisplayWelcome

public final boolean isDisplayWelcome()

Getter for property displayWelcome By default, set to true and dislpays the welcome text

Returns:

the value of property displayWelcome

setDisplayWelcome

public final ApplicationHeader setDisplayWelcome(boolean value)

Setter for property displayWelcome
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

attachLogoffEvent

public final ApplicationHeader attachLogoffEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Fires an event to log off the user from the application. No parameters.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachLogoffEvent

public final ApplicationHeader detachLogoffEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Fires an event to log off the user from the application. No parameters.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining