Spiffy UI Framework

org.spiffyui.client
Class MainHeader

java.lang.Object
  extended by FlowPanel
      extended by org.spiffyui.client.nav.HasNavBarListenersPanel
          extended by org.spiffyui.client.MainHeader

public class MainHeader
extends HasNavBarListenersPanel

This is the header for the main page.


Field Summary
static java.lang.String HEADER_ACTIONS_BLOCK
          The ID of the header actions block
static java.lang.String HEADER_STRING
          The ID of the header string section.
static java.lang.String HEADER_TITLE
          The ID of the header title section
 
Constructor Summary
MainHeader()
          Creates a new MainHeader panel
 
Method Summary
 void addHeaderTitleWidget(Widget w)
          Add a widget to the header title
 java.lang.String getHeaderTitle()
          Get the main title for the this header
 Anchor getLogout()
          Get the Anchor object used for the logout link in the header bar
protected  HTMLPanel getPanel()
          Get the HTML panel for this header
 java.lang.String getWelcomeString()
          Gets the welcome string for the header
 void setHeaderTitle(java.lang.String string)
          Set the main title for this header
 void setLogout(Anchor logout)
          Set the Anchor used for the logout in the header
 void setWelcomeString(java.lang.String string)
          Sets the username for display in the header
 
Methods inherited from class org.spiffyui.client.nav.HasNavBarListenersPanel
addListener, fireEvent, fireEvent, firePreEvent, isEnabled, removeListener, setEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER_STRING

public static final java.lang.String HEADER_STRING
The ID of the header string section. This section is often used for a welcome message.

See Also:
Constant Field Values

HEADER_TITLE

public static final java.lang.String HEADER_TITLE
The ID of the header title section

See Also:
Constant Field Values

HEADER_ACTIONS_BLOCK

public static final java.lang.String HEADER_ACTIONS_BLOCK
The ID of the header actions block

See Also:
Constant Field Values
Constructor Detail

MainHeader

public MainHeader()
Creates a new MainHeader panel

Method Detail

getLogout

public Anchor getLogout()
Get the Anchor object used for the logout link in the header bar

Returns:
the logout Anchor

setLogout

public void setLogout(Anchor logout)
Set the Anchor used for the logout in the header

Parameters:
logout - the logout Anchor

setWelcomeString

public void setWelcomeString(java.lang.String string)
Sets the username for display in the header

Parameters:
string - the welcome string

getWelcomeString

public java.lang.String getWelcomeString()
Gets the welcome string for the header

Returns:
the welcome string

addHeaderTitleWidget

public void addHeaderTitleWidget(Widget w)
Add a widget to the header title

Parameters:
w - widget for the header title

setHeaderTitle

public void setHeaderTitle(java.lang.String string)
Set the main title for this header

Parameters:
string - The main title for this header

getHeaderTitle

public java.lang.String getHeaderTitle()
Get the main title for the this header

Returns:
The main title of this header

getPanel

protected HTMLPanel getPanel()
Get the HTML panel for this header

Returns:
the HTML panel

Spiffy UI Framework