Remoto - VFS: menuManager Class Reference
Remoto - VFS

Manages context menus or any other menu. More...

#include "remoto!stdlib:js/paneManager/paneMenu.js"

Public Member Functions

 menuManager ()
 Construct a menu manager. More...
 
 createMenu (m, p, subscribe)
 Create a paneMenu(). You will want to use paneMenu.addItem() on the resulting object. More...
 
 getMenu (m)
 
 openMenu (m, b, p, d, c)
 Open a menu. More...
 
 removeMenu (m)
 
 resetMenus ()
 DOCME. More...
 

Detailed Description

Manages context menus or any other menu.

These will act as a modal, but the interface will hide that.

Menus have names. The name can be generic if it is for multiple purposes, but it can also be specific, using a uuid, path, database ID, or other uniqueness mechanism.

See also
menuManager.getMenu()
menuManager.openMenu()
menuManager.createMenu()

Constructor & Destructor Documentation

◆ menuManager()

Construct a menu manager.

This will, by default, be an empty list of menus.

See also
menuManager.createMenu()

Member Function Documentation

◆ createMenu()

createMenu (   m,
  p,
  subscribe 
)

Create a paneMenu(). You will want to use paneMenu.addItem() on the resulting object.

Parameters
mThe unique menu name, if it exists
pThe path of the menu, if it is to be connected to the VFS
subscribeThis menu is a listing of a VFS directory. Subscribe to it.
Returns
A new paneMenu() if it didn't exist, or an existing one.

◆ getMenu()

getMenu (   m)
Parameters
m
Returns

DOCME

◆ openMenu()

openMenu (   m,
  b,
  p,
  d,
  c 
)

Open a menu.

Parameters
mThe id of the menu to open
bThe dom element or event to get position data from
pThe positioning style... one of ["T","R","B","L"] against the element or event
dAdditional data to pass to the menu modal.
cA callback for when the menu closes
Returns
The modal object which is the menu.

Menus must be defined by name in the menuManager. Once defined, this method will open and position the menu.

See also
menuManager.createMenu

◆ removeMenu()

removeMenu (   m)
Parameters
mDOCME

◆ resetMenus()

resetMenus ( )

DOCME.


The documentation for this class was generated from the following file: