VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: CustomPopupMenu

Source Location: /menus.inc.php

Class Overview

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

Base class for PopupMenu.


Variables

Methods


Child classes:

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

Inherited Variables

Inherited Methods

Class: Component

Component::__construct()
Component constructor
Component::ajaxCall()
Dumps the javascript code to make an ajax call to the server.
Component::callEvent()
Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems()
This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode()
Dumps the header code for all the children
Component::dumpChildrenJavascript()
Dumps the javascript code for all the children
Component::dumpFormItems()
Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode()
Dumps header code required
Component::dumpHiddenKeyFields()
Dumps hidden field values for the key record
Component::dumpJavascript()
Dumps the javascript code needed by this component
Component::dumpJSEvent()
Dumps javascript code for an event
Component::fixupProperty()
Resolves the right reference to an object property
Component::generateAjaxEvent()
Returns the javascript code to generate an ajax call.
Component::getName()
Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag()
A versatile property of every Component that can be used in any way you want
Component::hasValidDataField()
Returns true if a valid data field is attached to the component
Component::init()
Initializes a component
Component::insertComponent()
Inserts a component into the component's collection
Component::loaded()
Initializes the component after the form file has been read into memory.
Component::loadedChildren()
Calls childrens loaded
Component::loadResource()
Loads this component from a string
Component::preinit()
Method called before init()
Component::readAccessibility()
Provides accessibility info to the embedded RPC engine.
Component::readComponentCount()
Indicates the number of components owned by the component.
Component::readComponents()
Lists all the components owned by this component.
Component::readControlState()
A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue()
This property returns the value of the datafield if any.
Component::readFromResource()
Reads a component from a resource file
Component::readNamePath()
Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner()
Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent()
Removes a component from the component's collection
Component::serializeChildren()
Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren()
Unserializes all children by calling unserialize for all the components
Component::updateDataField()
Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize()
This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign()
Assigns the source properties to this object.
Persistent::assignError()
Raises an assignation error.
Persistent::assignTo()
Assigns this object to another object.
Persistent::inSession()
This method determines if this object exists in the current session.
Persistent::readNamePath()
Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner()
Owner of the component.
Persistent::serialize()
Stores this object into the session.
Persistent::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.

Class: Object

Object::__construct()
Constructs an object and initializes its data before the object is first used.
Object::className()
Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs()
Determines whether an object is of a specific type.
Object::classParent()
Returns the type of the immediate ancestor of a class.
Object::inheritsFrom()
Determines the relationship of two object types.
Object::methodExists()
Check if a method exists declared on this object instance.
Object::readProperty()
Reads a property from the streams
Object::__get()
To virtualize properties
Object::__set()
To virtualize properties

Class Details

[line 376]
Base class for PopupMenu.

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.




[ Top ]


Class Variables

$_images =  null

[line 381]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_items = array()

[line 378]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_jsonclick = null

[line 380]



Tags:

access:  protected

Type:   mixed


[ Top ]

$_onclick = null

[line 379]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method defaultImages [line 568]

void defaultImages( )



[ Top ]

method dumpFormItems [line 475]

void dumpFormItems( )



Overrides Component::dumpFormItems() (Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components)

[ Top ]

method dumpHeaderCode [line 480]

void dumpHeaderCode( )



Overrides Component::dumpHeaderCode() (Dumps header code required)

[ Top ]

method dumpJavascript [line 383]

void dumpJavascript( )



Overrides Component::dumpJavascript() (Dumps the javascript code needed by this component)

[ Top ]

method init [line 464]

void init( )



Overrides Component::init() (Initializes a component)

[ Top ]

method loaded [line 458]

void loaded( )



Overrides Component::loaded() (Initializes the component after the form file has been read into memory.)

[ Top ]

method readImages [line 566]

ImageList readImages( )

Lists the images that can appear beside individual menu items.

Use this property if you want to add images to your items. Set it to an ImageList object containing the images you want to use and use the ImageIndex of each item to set the image you want to show.




Tags:

access:  protected


[ Top ]

method readItems [line 616]

item readItems( )

Describes the elements of the menu.

Use Items to access information about the elements in the menu. Item contain information about Caption, associated image and Tag.

  1.  <?php
  2.  
  3.      function Unit467BeforeShow($sender$params)
  4.      {
  5.      $items=array();
  6.  
  7.      $subitems=array();
  8.      $subitems[]=array(
  9.             'Caption'=>'Sub Menu1',
  10.             'ImageIndex'=>0,
  11.             'SelectedIndex'=>0,
  12.             'StateIndex'=>-1,
  13.             'Tag'=>1
  14.      );
  15.  
  16.      $subitems[]=array(
  17.             'Caption'=>'Sub Menu2',
  18.             'ImageIndex'=>0,
  19.             'SelectedIndex'=>0,
  20.             'StateIndex'=>-1,
  21.             'Tag'=>2
  22.      );
  23.  
  24.      $items[]=array(
  25.             'Caption'=>'Top Menu',
  26.             'ImageIndex'=>0,
  27.             'SelectedIndex'=>0,
  28.             'StateIndex'=>-1,
  29.             'Tag'=>0,
  30.             'Items'=>$subitems
  31.      );
  32.  
  33.      $this->PopupMenu1->Items=$items;
  34.  
  35.      }
  36.  
  37.  ?>




Tags:

return:  collection
access:  protected


[ Top ]

method readjsOnClick [line 644]

mixed readjsOnClick( )

OnJsClick event Occurs when the user clicks menu item.



Tags:

access:  protected


[ Top ]

method readOnClick [line 637]

mixed readOnClick( )

Occurs when the user clicks the control.

Use the OnClick event handler to respond when the user clicks the control.

Usually OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:

The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.

The user presses Spacebar while a button or check box has focus.

The user presses Enter when the active form has a default button (specified by the Default property).

The user presses Esc when the active form has a cancel button (specified by the Cancel property).




Tags:

return:  Returns the event handler or null if no handler is set.
access:  protected


[ Top ]

method writeImages [line 567]

void writeImages( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeItems [line 617]

void writeItems( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writejsOnClick [line 645]

void writejsOnClick( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]

method writeOnClick [line 638]

void writeOnClick( $value)



Tags:

access:  protected


Parameters:

   $value  

[ Top ]


Documentation generated on Sat, 13 Jun 2009 10:51:48 -0700 by phpDocumentor 1.4.1