ZurmoWidget Class Reference

Inheritance diagram for ZurmoWidget:
AmChart FileUpload FullCalendar ModelAttributeElementPreContentView MultiSelectAutoComplete OrgChart Redactor RssReader ZurmoColorPicker

Public Member Functions

 init ()

Data Fields

 $scriptUrl
 $scriptFile
 $cssFile
 $assetFolderName

Protected Member Functions

 resolvePackagePath ()
 registerCoreScripts ()
 registerScriptFile ($fileName, $position=CClientScript::POS_END)

Detailed Description

A base class for developing widgets.

Definition at line 40 of file ZurmoWidget.php.


Member Function Documentation

init (  ) 

Initializes the widget. This method will publish JUI assets if necessary. It will also register jquery and JUI JavaScript files and the theme CSS file. If you override this method, make sure you call the parent implementation first.

Reimplemented in FileUpload, FullCalendar, and Redactor.

Definition at line 60 of file ZurmoWidget.php.

resolvePackagePath (  )  [protected]

Determine the package installation path. This method will identify the JavaScript root URL and theme root URL. If they are not explicitly specified, it will publish the included JUI package and use that to resolve the needed paths.

Reimplemented in MultiSelectAutoComplete.

Definition at line 73 of file ZurmoWidget.php.

registerCoreScripts (  )  [protected]

Registers the core script files. This method registers jquery and JUI JavaScript files and the theme CSS file.

Definition at line 90 of file ZurmoWidget.php.

registerScriptFile ( fileName,
position = CClientScript::POS_END 
) [protected]

Registers a JavaScript file under scriptUrl. Note that by default, the script file will be rendered at the end of a page to improve page loading speed.

Parameters:
string JavaScript file name
integer the position of the JavaScript file. Valid values include the following:

  • CClientScript::POS_HEAD : the script is inserted in the head section right before the title element.
  • CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section.
  • CClientScript::POS_END : the script is inserted at the end of the body section.

Definition at line 130 of file ZurmoWidget.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Jun 22 07:10:31 2017