Class PopupMenu

(line 655)

Description

Object
   |
   --Persistent
      |
      --Component
         |
         --CustomPopupMenu
            |
            --PopupMenu

Located in File: /menus.inc.php

Use PopupMenu to define the pop-up menu that appears when the user clicks on a control with the right mouse button.

To make a pop-up menu available, assign the PopupMenu object to the control's PopupMenu property.


Properties

Summary:
Images Lists the images that can appear beside individual menu items. [Publishes CustomPopupMenu::Images]
Items Describes the elements of the menu. [Publishes CustomPopupMenu::Items]

Defined in class CustomPopupMenu
Images Lists the images that can appear beside individual menu items.
Items Describes the elements of the menu.

Defined in class Component
Name Specifies the name for the component. The name is used as an identifier and should be unique.
Tag A versatile property of every Component that can be used in any way you want
ComponentCount Indicates the number of components owned by the component.
Components Lists all the components owned by this component.
ControlState A flag to know the state of the control, csLoading, csDesigning
DataFieldValue This property returns the value of the datafield if any.
NamePath Specifies the path to uniquely identify a component, qualified by the owner when required.
Owner Indicates the component that is responsible for streaming and freeing this component.

Defined in class Persistent
NamePath Used to serialize/unserialize. It returns the full path to identify this component.
Owner Owner of the component.

property Images (line 658)

ImageList Images

Lists the images that can appear beside individual menu items. [Publishes CustomPopupMenu::Images]

property Items (line 661)

item Items

Describes the elements of the menu. [Publishes CustomPopupMenu::Items]

property Images

Lists the images that can appear beside individual menu items.
This property is implemented in CustomPopupMenu::Images

property Items

Describes the elements of the menu.
This property is implemented in CustomPopupMenu::Items

property Name

Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name

property Tag

A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag

property ComponentCount

Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount

property Components

Lists all the components owned by this component.
This property is implemented in Component::Components

property ControlState

A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState

property DataFieldValue

This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue

property NamePath

Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath

property Owner

Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner

property NamePath

Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePath

property Owner

Owner of the component.
This property is implemented in Persistent::Owner

Methods

Summary:

Defined in class CustomPopupMenu
dumpFormItems Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
dumpHeaderCode Dumps header code required
dumpJavascript Dumps the javascript code needed by this component
init Initializes a component
loaded Initializes the component after the form file has been read into memory.

Defined in class Component
dumpChildrenJavascript Dumps the javascript code for all the children
dumpFormItems Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
dumpHeaderCode Dumps header code required
dumpJavascript Dumps the javascript code needed by this component
hasValidDataField Returns true if a valid data field is attached to the component
init Initializes a component
loaded Initializes the component after the form file has been read into memory.
loadedChildren Calls childrens loaded
preinit Method called before init()
serializeChildren Serializes all children
unserializeChildren Unserializes all children by calling unserialize for all the components

Defined in class Persistent
serialize Stores this object into the session.
unserialize This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Defined in class Object
__construct Constructs an object and initializes its data before the object is first used.
className Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
classParent Returns the type of the immediate ancestor of a class.

Events

Summary:
OnClick Occurs when the user clicks the control. [Publishes CustomPopupMenu::OnClick]

Defined in class CustomPopupMenu
OnClick Occurs when the user clicks the control.

property OnClick (line 665)

mixed OnClick

Occurs when the user clicks the control. [Publishes CustomPopupMenu::OnClick]

property OnClick

Occurs when the user clicks the control.
This event is implemented in CustomPopupMenu::OnClick

Javascript Events

Summary:
OnClick OnJsClick event Occurs when the user clicks menu item. [Publishes CustomPopupMenu::OnClick]

Defined in class CustomPopupMenu
OnClick OnJsClick event Occurs when the user clicks menu item.

property OnClick (line 668)

mixed OnClick

OnJsClick event Occurs when the user clicks menu item. [Publishes CustomPopupMenu::OnClick]

property OnClick

OnJsClick event Occurs when the user clicks menu item.
This event is implemented in CustomPopupMenu::OnClick
Documentation generated on Fri, 26 Dec 2008 11:45:57 +0100 by phpDocumentor 1.4.0a2