DefaultHeader

DefaultHeader

Package: com.webobjects.directtoweb

Inherits from:com.webobjects.appserver.WOComponent

Subclasses:

Class Description

This class defines the behavior of the menu header in a Direct to Web application. The source code for this class is copied into the MenuHeader.java file in the application's project.

Method Types

Constructors

public DefaultHeader()

Fields

entityNameInList

Actions

findEntityAction
homeAction
logout
newObjectAction
showWebAssistant

Key-Value Coding

isWebAssistantEnabled
manipulatedEntityName
setManipulatedEntityName
visibleEntityNames

Constructors

DefaultHeader

public DefaultHeader()

Standard Java no-argument constructor.

Fields

entityNameInList
java.lang.String

This instance variable is used as a temporary variable by the Entities WOPopupButton.

Methods

findEntityAction

public WOComponent findEntityAction()

This method is invoked when the user clicks Search in the menu bar. It creates and displays a query page (a WOComponent object) for the selected entity.

homeAction

public WOComponent homeAction()

This method is invoked when the user clicks Home in the menu bar. It displays the startup task page.

isWebAssistantEnabled

public boolean isWebAssistantEnabled()

Returns whether or not the Web Assistant is enabled. By default it is enabled.

logout

public WOComponent logout()

This method is invoked when the user clicks Logout in the menu bar. It terminates the current session and returns the application's home page WOComponent (Main).

See Also:
homeHrefInContext (D2W)

manipulatedEntityName

public String manipulatedEntityName()

Returns the entity name the user chooses in the Entities pop-up list in the menu bar.

newObjectAction

public WOComponent newObjectAction()

This action method is invoked when the user clicks New in the menu bar. It creates an instance of the manipulated entity and displays an edit page for it.

See Also:
manipulatedEntityName

setManipulatedEntityName

public void setManipulatedEntityName(String entityName)

Sets the entity name the use chooses from the pop-up list in the menu bar.

showWebAssistant

public WOComponent showWebAssistant()

This action method is invoked when the user clicks Customize in the menu bar. It displays the Web Assistant in the user's browser.

visibleEntityNames

public NSArray visibleEntityNames()

Returns an NSArray containing the names of the visible entities in the session WOSession. You can hide entities using the Entities tab in the Web Assistant. See the "Direct to Web" chapter of WebObjects Tools and Techniques for more information about hiding entities.