de.must.markup

Class MustMenuBar

java.lang.Object

de.must.markup.Dialog

de.must.markup.MustMenuBar

All Implemented Interfaces:

Invokable

public abstract class MustMenuBar
extends Dialog

Menu bar analogous to JMenuBar containing submenus and menu items.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	wantToBeFinalized

Fields inherited from class de.must.markup.Dialog

additionalButtons, backButton, cancelButton, NAME_FOR_BACK_ACTION, NAME_FOR_CANCEL_ACTION, NAME_FOR_CLOSE_ACTION, NAME_FOR_DIALOG_NBR, NAME_FOR_HELP_ACTION, NAME_FOR_LIST_ACTION, NAME_FOR_NEW_ENTRY_ACTION, NAME_FOR_OK_ACTION, okButton, processComplete, sessionData, stackMovement

Constructor Summary

Constructors

Constructor and Description
MustMenuBar(SessionData sessionData) Constructs a new menu bar.

Method Summary

Modifier and Type	Method and Description
void	addMenu(java.lang.String menuText, int subjectArea) Creates a new top first level menu and adds it to the menu bar, former submenus are implicitly closed.
void	addMenu(java.lang.String menuText, int subjectArea, int minimumLevel) Creates a new top first level menu and adds it to the menu bar, former submenus are implicitly closed.
void	addMenuItem(java.lang.String menuText, java.lang.Class<? extends Invokable> invokeable) Creates a new menu item and adds it to the current menu.
void	addMenuItem(java.lang.String menuText, java.lang.Class<? extends Invokable> invokeable, java.lang.String toolTipText) Creates a new menu item and adds it to the current menu.
void	addMenuItem(java.lang.String menuText, FreeAction freeAction) Creates a new menu item and adds it to the current menu to execute things liberal.
void	addMenuItem(java.lang.String menuText, FreeAction freeAction, java.lang.String toolTipText) Creates a new menu item and adds it to the current menu to execute things liberal.
void	addMenuItem(java.lang.String menuText, Href href) Creates a new menu item and adds it to the current menu to execute things liberal.
void	addMenuItem(java.lang.String menuText, Href href, java.lang.String toolTipText) Creates a new menu item and adds it to the current menu to execute things liberal.
void	addSubMenu(java.lang.String menuText, int subjectArea) Creates a new menu one level below the current menu.
void	closeMenu() Closes the current menu and allows to continue in the menu one level above.
void	fetchValuesFromRequest(GeneralizedRequest request) Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.
java.lang.String	getCurrentMenuAddress() Returns the address of the current menu.
MustMenuNode	getCurrentMenuNode() Returns the current menu node.
java.lang.String	getPreviousMenuAddress() Returns the address of the menu above the current menu.
MustMenuNode	getRootNode() Returns the root node of the menu bar.
Submission	getSubmission() Informs the next invokable in stack about the submission details.
java.lang.String	getTagSequence() Returns the default tag sequence (as HTML).
void	init() Initializes the invokable in order to reuse the component without garbage from the previous use.
boolean	isBackAble(SessionData sessionData) Returns true if the menu bar allows a back function to a previous menu or another dialog step in stack.
boolean	isSuitableDialog(GeneralizedRequest request) Indicates whether the request fits to this dialog.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
void	setRootMenuDescription(java.lang.String menuDescription) Sets the root menu's descripton
void	setSubmitter(Invokable submitter) Informs this invokable, from which previous invokable it is submitted.
boolean	wantToBeFinalized() Indicates whether the reusage of the invokable is not to be supported.

Methods inherited from class de.must.markup.Dialog

afterOutput, appendAdditionalButton, beforeOutput, destroy, finalize, free, getAdditionalButtons, getBackButtonTagSequence, getCancelButtonTagSequence, getFooter, getHeader, getHelpContext, getInvokableInAdvance, getOkButtonTagSequence, getScriptToExecute, getScriptToExecuteSequence, getStackMovement, getSubTitle, getTitle, isCancelable, isPost, setHelpContext, setHelpContext, setMessageToKeep, setMessageToKeepIfNotAlreadySet, setScriptToExecute, setStackMovement, setSubTitle, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

wantToBeFinalized

protected boolean wantToBeFinalized

Constructor Detail

MustMenuBar

public MustMenuBar(SessionData sessionData)

Constructs a new menu bar.

Parameters:

sessionData - the session's public data

Method Detail

setSubmitter

public void setSubmitter(Invokable submitter)

Informs this invokable, from which previous invokable it is submitted. Technique to establish a bilateral communication between invokables.

Parameters:

submitter - the invokable that submitted this invokable

setRootMenuDescription

public void setRootMenuDescription(java.lang.String menuDescription)

Sets the root menu's descripton

Parameters:

MenuDescription - the description of the root menu

addMenu

public void addMenu(java.lang.String menuText,
                    int subjectArea)

Creates a new top first level menu and adds it to the menu bar, former submenus are implicitly closed.

Parameters:

menuText - the menu text

subjectArea - the subject area as to be defined in subclasses of EntitlementStd

See Also:

EntitlementStd

addMenu

public void addMenu(java.lang.String menuText,
                    int subjectArea,
                    int minimumLevel)

Creates a new top first level menu and adds it to the menu bar, former submenus are implicitly closed.

Parameters:

menuText - the menu text

subjectArea - the subject area as to be defined in subclasses of EntitlementStd

minimumLevel - the minimum access level a user must gain that he may access the menu at all

See Also:

EntitlementStd

addSubMenu

public void addSubMenu(java.lang.String menuText,
                       int subjectArea)

Creates a new menu one level below the current menu.

Parameters:

menuText - the menu text

subjectArea - the subject area as to be defined in subclasses of EntitlementStd

See Also:

EntitlementStd

closeMenu

public void closeMenu()

Closes the current menu and allows to continue in the menu one level above.

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        java.lang.Class<? extends Invokable> invokeable)

Creates a new menu item and adds it to the current menu.

Parameters:

menuText - the text of the menu item

invokeable - the invokable to be invoked when the menu item is choosen.

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        java.lang.Class<? extends Invokable> invokeable,
                        java.lang.String toolTipText)

Creates a new menu item and adds it to the current menu.

Parameters:

menuText - the text of the menu item

invokeable - the invokable to be invoked when the menu item is choosen.

toolTipText - the tool tip text for the menu item to show

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        FreeAction freeAction)

Creates a new menu item and adds it to the current menu to execute things liberal.

Parameters:

menuText - the text of the menu item

freeAction - a free action, e.g. a JavaScript fragment to execute.

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        FreeAction freeAction,
                        java.lang.String toolTipText)

Creates a new menu item and adds it to the current menu to execute things liberal.

Parameters:

menuText - the text of the menu item

freeAction - a free action, e.g. a JavaScript fragment to execute.

toolTipText - the tool tip text for the menu item to show

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        Href href)

Creates a new menu item and adds it to the current menu to execute things liberal.

Parameters:

menuText - the text of the menu item

href - the hyper reference

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        Href href,
                        java.lang.String toolTipText)

Creates a new menu item and adds it to the current menu to execute things liberal.

Parameters:

menuText - the text of the menu item

href - the hyper reference

toolTipText - the tool tip text for the menu item to show

getRootNode

public MustMenuNode getRootNode()

Returns the root node of the menu bar.

Returns:

the root node of the menu bar

init

public void init()

Initializes the invokable in order to reuse the component without garbage from the previous use.

Specified by:

init in interface Invokable

Overrides:

init in class Dialog

isBackAble

public boolean isBackAble(SessionData sessionData)

Returns true if the menu bar allows a back function to a previous menu or another dialog step in stack.

Parameters:

sessionData - the session's public data

Returns:

true if the menu bar allows a back function

getTagSequence

public java.lang.String getTagSequence()

Returns the default tag sequence (as HTML). Normally you should not call this method directly. Use Layout implementing classes instead.

Returns:

the default tag sequence (as HTML)

See Also:

Layout

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.

Specified by:

fetchValuesFromRequest in interface Invokable

Overrides:

fetchValuesFromRequest in class Dialog

Parameters:

request - the request from where the values are to be fetched

See Also:

Markupable#fetchYourValueFromRequest

isSuitableDialog

public boolean isSuitableDialog(GeneralizedRequest request)

Indicates whether the request fits to this dialog. Useful to stop the user to use any back functions of the browser.

Specified by:

isSuitableDialog in interface Invokable

Overrides:

isSuitableDialog in class Dialog

Parameters:

request - the request to check

Returns:

true if the request fits to this dialog

process

public void process(GeneralizedRequest request)

Allows the invokable to react to the request. Sample: saving data when Ok button was pressed.

Specified by:

process in interface Invokable

Overrides:

process in class Dialog

Parameters:

request - the requeset to react to

getPreviousMenuAddress

public java.lang.String getPreviousMenuAddress()

Returns the address of the menu above the current menu. If the current menu is the root menu, null is returned.

Returns:

Returns the address of the menu above the current menu

getCurrentMenuAddress

public java.lang.String getCurrentMenuAddress()

Returns the address of the current menu.

Returns:

the address of the current menu

getCurrentMenuNode

public MustMenuNode getCurrentMenuNode()

Returns the current menu node.

Returns:

the current menu node

getSubmission

public Submission getSubmission()

Informs the next invokable in stack about the submission details. E.g. a PropertyAdminstration may call this method to receive the primary key of the entry to be edited.

Returns:

the submission details

wantToBeFinalized

public boolean wantToBeFinalized()

Indicates whether the reusage of the invokable is not to be supported.

Returns:

true if the reusage of the invokable is not to be supported