org.dmd.mvw.client.mvwmenus.base

Class MvwMenuFactory

java.lang.Object

org.dmd.mvw.client.mvwmenus.base.MvwMenuFactory

public abstract class MvwMenuFactory
extends Object

The MvwMenuFactory defines a component that can can instantiate MvwMenus and MvwMenuItems based on parameters defined in a Model View Whatever configuration file. The menu factory should be extended when you want a menu structure based on a particular widget set.

Constructor Summary

Constructors

Constructor and Description
MvwMenuFactory()

Method Summary

Modifier and Type	Method and Description
abstract MvwMenu	createMenu(String menuType, String menuName) This method should be overloaded to instantiate the type of menu specified.
abstract MvwMenuItem	createMenuItem(String itemType, String itemName, String menuOrder, String addToMenu, boolean dynamic, String actionName, String label, com.google.gwt.resources.client.ImageResource image) This method should be overloaded to instantiate the specified type of menu item.
abstract MvwSeparator	createSeparator(String separatorType, String itemName, String menuOrder, String addToMenu, boolean dynamic) This method should be overloaded to instantiate the specified type of separator.
abstract MvwMenu	createSubMenu(String menuType, String itemName, String menuOrder, String addToMenu, boolean dynamic, String label, com.google.gwt.resources.client.ImageResource image) This method should be overloaded to instantiate the type of submenu specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

MvwMenuFactory

public MvwMenuFactory()

Method Detail

createMenu

public abstract MvwMenu createMenu(String menuType,
                                   String menuName)

This method should be overloaded to instantiate the type of menu specified. The various menu types are defined as part of a MenuImplementationConfig in whatever module is implementing the menu functionality.

Parameters:

menuType - The menu type.

menuName - The unique name of the menu.

Returns:

an appropriate menu implementation.

createSubMenu

public abstract MvwMenu createSubMenu(String menuType,
                                      String itemName,
                                      String menuOrder,
                                      String addToMenu,
                                      boolean dynamic,
                                      String label,
                                      com.google.gwt.resources.client.ImageResource image)

This method should be overloaded to instantiate the type of submenu specified. The various submenu types are defined as part of a MenuImplementationConfig in whatever module is implementing the menu functionality.

Parameters:

menuType - The menu type.

itemName - The unique name of the item.

menuOrder - The item's place within the menu.

addToMenu - The menu to which it should be added.

dynamic - Whether or not the item is dynamic.

label - The display label for the submenu or null if this is just an image button.

image - The image for the submenu, or null if no image is to be displayed.

Returns:

an appropriate submenu implementation.

createMenuItem

public abstract MvwMenuItem createMenuItem(String itemType,
                                           String itemName,
                                           String menuOrder,
                                           String addToMenu,
                                           boolean dynamic,
                                           String actionName,
                                           String label,
                                           com.google.gwt.resources.client.ImageResource image)

This method should be overloaded to instantiate the specified type of menu item. This various item types are defined as part of a MenuImplementationConfig in whatever module is implementing the menu functionality.

Parameters:

itemType - The item type.

itemName - The unique name of the item.

menuOrder - The item's place within the menu.

addToMenu - The menu to which it should be added.

dynamic - Whether or not the item is dynamic.

actionName - The name of the action to be triggered.

label - The display label for the item or null if this is just an image button.

image - The image for the item, or null if no image is to be displayed.

Returns:

an appropriate menu item implementation

createSeparator

public abstract MvwSeparator createSeparator(String separatorType,
                                             String itemName,
                                             String menuOrder,
                                             String addToMenu,
                                             boolean dynamic)

This method should be overloaded to instantiate the specified type of separator. This various item types are defined as part of a MenuImplementationConfig in whatever module is implementing the menu functionality.

Parameters:

separatorType - The separator type.

itemName - The unique name of the item.

menuOrder - The item's place within the menu.

addToMenu - The menu to which it should be added.

dynamic - Whether or not the item is dynamic.

Returns:

an appropriate menu separator implementation.