Class: pnFormContextMenu

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormContextMenu

[line 55]
Context menu plugin

This plugin creates a popup menu to be used as a right-click context menu. To use it you must do three things:

• Create a menu
• Add menu items (as sub-pugins of the menu)
• Add a reference to the menu (there can be more than one of these)

Example usage with two menu items:

1.  <!--[pnformcontextmenu id="MyMenu" width="150px"]-->
2.    <!--[pnformcontextmenuitem title=_EDIT commandName="edit"]-->
3.    <!--[pnformcontextmenuitem title=_NEW commandName="new"]-->
4.  <!--[/pnformcontextmenu]-->
5.  
6.  <!--[foreach from=items item=item]-->
7.  <!--[$item.title]--> <!--[pnformcontextmenureference menuId="MyMenu" commandArgument=$item.id]-->
8.  <!--[/foreach]-->

As you can see it is possible to reuse the same menu more than once on a page - in the example above it is used as a context menu for each of the "items" (for instance articles or webshop goods). Where ever you insert a "pnformcontextmenureference" you will get a small clickable arrow indicating the menu. Clicking on the reference will bring op the menu.

In your event handler (which defaults to "handleCommand") you should check for both commandName and commandArgument:

1.  function handleCommand(&$render, &$args)
2.  {
3.    echo "Command: $args[commandName], $args[commandArgument]. ";
4.  }

The commandName value indicates the menu item which was clicked and the commandArgument is the value set at the menu reference. The use of commandArgument makes it easy to identify which $item the menu was activated for.

$cssClass =

[line 64]

CSS class name

The class name is applied to the div element that surrounds the entire menu. Defaults to "contextMenu".

$onCommand =

[line 73]

Name of command event handler method

Defaults to "handleCommand".

$zIndex =

[line 83]

Z-index for absolute positioning

No need to change or set this unless there's a conflict with other libraries (for instance prototype).

---

method create [line 92]

---

method dataBound [line 99]

---

method firstTime [line 134]

---

method getFilename [line 86]

---

method renderBegin [line 107]

---

method renderEnd [line 122]