Class XOAD_Controls

Description

XOAD_Controls Class.

This class allows you to register custom client controls.

Each control includes a JS file that defines the class that will handle the control. Additionally, you can attach a server class and a HTML code.

Example:

  1. XOAD_Controls::register('xoad', array('Panel', 'PanelTitle', 'PanelContent'), 'xoad.controls.panel.js');

  • version: 0.6.0.0
  • author: Stanimir Angeloff

Located in /extensions/controls/classes/Controls.class.php (line 55)


	
			
Method Summary
 string getFileName (mixed $fileName)
 string register ([string $tagPrefix = 'xoad'], [mixed $tagName = null], [string $jsFile = null], [string $phpFile = null], [string $url = null], [string $htmlFile = null])
Methods
getFileName (line 65)

Gets the absolute path to the file.

  • access: private
string getFileName (mixed $fileName)
register (line 113)

Registers a custom client control.

Each control includes a JS file that defines the class that will handle the control. Additionally, you can attach a server class and a HTML code.

  • return: HTML code to register the custom control.
  • static:
  • access: public
string register ([string $tagPrefix = 'xoad'], [mixed $tagName = null], [string $jsFile = null], [string $phpFile = null], [string $url = null], [string $htmlFile = null])
  • string $tagPrefix: The tag prefix for the control, required.
  • mixed $tagName: The tag name for the control, required.
  • string $jsFile: The relative path to the JS file that defines the class that will handle the control, required.
  • string $phpFile: The relative/absolute path to the PHP file that defines the server class that is associated with the control, optional.
  • string $url: The callback URL for the server class, optional.
  • string $htmlFile: The relative/absolute path to the HTML file that defines the code that is associated with the control, optional.

Documentation generated on Sat, 12 Nov 2005 20:23:59 +0200 by phpDocumentor 1.3.0RC3