de.must.appletserver

Class MustMenuBar

java.lang.Object

de.must.appletserver.MustMenuBar

All Implemented Interfaces:

AppletTalker, Remotable

public abstract class MustMenuBar
extends java.lang.Object
implements Remotable

Menu bar analogous to JMenuBar containing submenus and menu items.

Field Summary

Fields

Modifier and Type	Field and Description
protected MustMenuBar	menuBar
protected SessionData	sessionData

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)
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, boolean dialogBeforeAction, int subjectArea, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, boolean ownThread, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, int keyEvent, boolean ownThread, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, int keyEvent, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, int keyEvent, int keyControlEvent, boolean ownThread, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String menuText, int subjectArea, int keyEvent, int keyControlEvent, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String iconName, java.lang.String menuText, boolean dialogBeforeAction, int subjectArea, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String iconName, java.lang.String menuText, int subjectArea, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String iconName, java.lang.String menuText, int subjectArea, int keyEvent, int keyControlEvent, boolean ownThread, Callback callback) Adds a menu item to the menu.
void	addMenuItem(java.lang.String iconName, java.lang.String menuText, int subjectArea, int keyEvent, int keyControlEvent, Callback callback) Adds a menu item to the menu.
void	addSeparator()
void	beginSubMenu(java.lang.String menuText, int subjectArea) Creates a new menu one level below the current menu.
void	buildRemoteView(ToAppletWriter out) Build remote view.
void	closeSubMenu() Closes the current menu and allows to continue in the menu one level above.
void	destroy() Don't wait until garbage collector removed weak reference.
void	fetchValuesFromRequest(GeneralizedRequest request)
void	newMenu(java.lang.String menuText, int subjectArea) Creates a new top first level menu and adds it to the menu bar, former sub menus are implicitly closed.
void	setToolTipText(java.lang.String newToolTipText) Sets the component's tool tip text.

Methods inherited from class java.lang.Object

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

Field Detail

sessionData

protected SessionData sessionData

menuBar

protected MustMenuBar menuBar

Constructor Detail

MustMenuBar

public MustMenuBar(SessionData sessionData)

Constructs a new menu bar.

Parameters:

sessionData - the session's public data

Method Detail

addMenu

public void addMenu(java.lang.String menuText)

newMenu

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

Creates a new top first level menu and adds it to the menu bar, former sub menus 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

beginSubMenu

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

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        boolean dialogBeforeAction,
                        int subjectArea,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

dialogBeforeAction - whether or not a dialog will be shown before action performs

subjectArea - the subject area / context of this item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String iconName,
                        java.lang.String menuText,
                        boolean dialogBeforeAction,
                        int subjectArea,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

iconName - the name of the icon to be used.

menuText - the label text of the menu item

dialogBeforeAction - whether or not a dialog will be shown before action performs

subjectArea - the subject area / context of this item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        boolean ownThread,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

ownThread - whether or not the client should callback in an own thread

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        boolean ownThread,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

ownThread - whether or not the client should callback in an own thread

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        int keyControlEvent,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

keyControlEvent - the key control event of the shortcut to call the menu item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        int keyControlEvent,
                        boolean ownThread,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

keyControlEvent - the key control event of the shortcut to call the menu item

ownThread - whether or not the client should callback in an own thread

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String iconName,
                        java.lang.String menuText,
                        int subjectArea,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

iconName - the name of the icon to be used.

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String iconName,
                        java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        int keyControlEvent,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

iconName - the name of the icon to be used.

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

keyControlEvent - the key control event of the shortcut to call the menu item

callback - the action to perform if user chooses this menu item

addMenuItem

public void addMenuItem(java.lang.String iconName,
                        java.lang.String menuText,
                        int subjectArea,
                        int keyEvent,
                        int keyControlEvent,
                        boolean ownThread,
                        Callback callback)

Adds a menu item to the menu.

Parameters:

iconName - the name of the icon to be used.

menuText - the label text of the menu item

subjectArea - the subject area / context of this item

keyEvent - the key event of the shortcut to call the menu item

keyControlEvent - the key control event of the shortcut to call the menu item

ownThread - whether or not the client should callback in an own thread

callback - the action to perform if user chooses this menu item

addSeparator

public void addSeparator()

closeSubMenu

public void closeSubMenu()

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

buildRemoteView

public void buildRemoteView(ToAppletWriter out)

Description copied from interface: AppletTalker

Build remote view.

Specified by:

buildRemoteView in interface AppletTalker

Parameters:

out - the writer which will be read by the applet

setToolTipText

public void setToolTipText(java.lang.String newToolTipText)

Description copied from interface: Remotable

Sets the component's tool tip text.

Specified by:

setToolTipText in interface Remotable

Parameters:

newToolTipText - the component's tool tip text

fetchValuesFromRequest

public void fetchValuesFromRequest(GeneralizedRequest request)

Specified by:

fetchValuesFromRequest in interface Remotable

destroy

public void destroy()

Description copied from interface: Remotable

Don't wait until garbage collector removed weak reference.

Specified by:

destroy in interface Remotable