com.sap.ui.commons.client
Class ApplicationHeaderWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.ApplicationHeaderWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class ApplicationHeaderWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	ApplicationHeaderWidget() constructs the class ApplicationHeaderWidget
protected	ApplicationHeaderWidget(ApplicationHeader control) constructs the class ApplicationHeaderWidget
	ApplicationHeaderWidget(String id) constructs the class ApplicationHeaderWidget

Method Summary

void	attachLogoffEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Fires an event to log off the user from the application.
void	detachLogoffEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Fires an event to log off the user from the application.
ApplicationHeader	getControl() returns the reference to the Phoenix Control
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
void	setDisplayLogoff(boolean value) Setter for property displayLogoff Default value is: true
void	setDisplayWelcome(boolean value) Setter for property displayWelcome Default value is: true
void	setLogoSrc(String value) Setter for property logoSrc
void	setLogoText(String value) Setter for property logoText
void	setUserName(String value) Setter for property userName

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationHeaderWidget

public ApplicationHeaderWidget()

constructs the class ApplicationHeaderWidget

ApplicationHeaderWidget

public ApplicationHeaderWidget(String id)

constructs the class ApplicationHeaderWidget

Parameters:

id - id of the ApplicationHeaderWidget

ApplicationHeaderWidget

protected ApplicationHeaderWidget(ApplicationHeader control)

constructs the class ApplicationHeaderWidget

Parameters:

control - reference to an existing ApplicationHeader

Method Detail

getControl

public ApplicationHeader getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getLogoSrc

public 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 void setLogoSrc(String value)

Setter for property logoSrc

Parameters:

value - String

getLogoText

public 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 void setLogoText(String value)

Setter for property logoText

Parameters:

value - String

isDisplayLogoff

public 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 void setDisplayLogoff(boolean value)

Setter for property displayLogoff
Default value is: true

Parameters:

value - boolean

getUserName

public String getUserName()

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

Returns:

the value of property userName

setUserName

public void setUserName(String value)

Setter for property userName

Parameters:

value - String

isDisplayWelcome

public boolean isDisplayWelcome()

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

Returns:

the value of property displayWelcome

setDisplayWelcome

public void setDisplayWelcome(boolean value)

Setter for property displayWelcome
Default value is: true

Parameters:

value - boolean

attachLogoffEvent

public void 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

detachLogoffEvent

public void 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