Class MenuManager

Object
   |
   +--MenuManager

class MenuManager

Defined in menu_manager.js

Constructor Detail

MenuManager

function MenuManager(<MenuItemProvider> menuItemProvider, <ContentProvider> contentProvider, <ViewerSorter> sorter)

Creates an object to manage a data-driven menu. This interface is somewhat provisional, in that I'm not sure if this is the best way to go. For one thing, there might be a need to provide a facility for destroying the managed menu. For another, menus are inherently tree-shaped (actuators have child-menus), so MenuManager could be extended to manage a hierarchy of menus, rather than a single menu, but I can't think of a good example of a data-driven hierarchy of menus, only a data-driven menu. Another potential problem is that the most sensible layout for a menu might have only part of that menu be data-driven, but there is no provision for "static" members of a managed menu.

One thought that crossed my mind was that MenuItemProvider could be changed such that getMenuItem(element) be allowed to return a single MenuItem, an array of MenuItems, or a list of MenuItems, and then MenuManager could leverage forEach to insert them into the menu. Then the content provider could return a fake data-object that represents a clump of "static" menu items, the menu-item provider could return a list of menu-items for that object, and the sorter could make sure that everything ends up in the right place. This arrangement would be non-trivial to implement, though, because the current insertion mechanism assumes an isomorphic mapping from indexes into this._elements and indexes into this.getWidget().children. Of course, this setup could be overly complicated anyway, and trying to figure out how to keep such a menu sorted could be the least of anyone's worries.

Parameters:
menuItemProvider - the data-object to MenuItem translator
contentProvider - the data source
sorter - (Optional) - a sorting policy for the data objects. Defaults to a default instance of ViewerSorter.

getAssociatedObject

Object getAssociatedObject(<Widget> widget)

Gets the domain object associated with the given Widget.

Parameters:
widget - the Widget to search for

Returns:
the domain object associated with widget

getAssociatedWidget

Widget getAssociatedWidget(<Object> object)

Gets the Widget associated with object. Note: if object is null or undefined, then the returned value is this.getWidget().

Parameters:
object - the domain object to search for

Returns:
the Widget displaying a value for object

getContentProvider

ContentProvider getContentProvider()

Returns the ContentProvider associated with this MenuManager.

Returns:
this manager's ContentProvider

getMenuItemProvider

MenuItemViewer getMenuItemProvider()

Returns the MenuItemProvider associated with this MenuManager.

Returns:
the MenuItemProvider for this manager

getSorter

ViewerSorter getSorter()

getWidget

Widget getWidget()

Returns the Widget displaying this viewer's contents.

Returns:
this viewer's Widget

setSorter

void setSorter(<ViewerSorter> newSorter, <boolean> forceResort)

Sets this viewer's sorter to be newSorter. If newSorter is different from the existing sorter then the elements in the viewer will be resorted according to the new sorter.

Parameters:
newSorter - a ViewerSorter to start using
forceResort - (Optional) - a boolean to indicate whether or not to force a re-sort. If forceResort is false, then the widgets will only be re-sorted if newSorter is different from the existing sorter. Defaults to false.