tinymce.Plugin

Namespace tinymce
Class Plugin
Plugin base class, this is a pseudo class that describes how a plugin is to be created for TinyMCE. The methods below are all optional.

Example



Public Methods






Method
Defined By









createControl(name:String, controlman:ControlManager):Control



Gets called when a new control instance is created.


Plugin







getInfo():Object


Meta info method, this method gets executed when TinyMCE wants to present information about the plugin for example in th...


Plugin







init(editor:Editor, url:String):void


Initialization function for the plugin.


Plugin












Method details




createControlmethod


public 
						function createControl(name:String, controlman:ControlManager):Control


Gets called when a new control instance is created.



Parameters





name:String
Control name to create for example "mylistbox"




controlman:ControlManager

Control manager/factory to use to create the control.





Returns



Control - Returns a new control instance or null.


Example






getInfomethod


public 
						function getInfo():Object

Meta info method, this method gets executed when TinyMCE wants to present information about the plugin for example in the about/help dialog.



Returns


Object - Returns an object with meta information about the plugin the current items are longname, author, authorurl, infourl and version.


Example






initmethod


public 
						function init(editor:Editor, url:String):void

Initialization function for the plugin. This will be called when the plugin is created.



Parameters





editor:Editor

Editor instance that created the plugin instance.




url:String
Absolute URL where the plugin is located.





Example