Began removing $Id$ tags. This will be an ongoing process.
[citadel.git] / webcit / tiny_mce / plugins / example / editor_plugin_src.js
1 /*\r
2  * Copyright © 2004-2008, Moxiecode Systems AB, All rights reserved.\r
3  */\r
4 \r
5 (function() {\r
6         // Load plugin specific language pack\r
7         tinymce.PluginManager.requireLangPack('example');\r
8 \r
9         tinymce.create('tinymce.plugins.ExamplePlugin', {\r
10                 /**\r
11                  * Initializes the plugin, this will be executed after the plugin has been created.\r
12                  * This call is done before the editor instance has finished it's initialization so use the onInit event\r
13                  * of the editor instance to intercept that event.\r
14                  *\r
15                  * @param {tinymce.Editor} ed Editor instance that the plugin is initialized in.\r
16                  * @param {string} url Absolute URL to where the plugin is located.\r
17                  */\r
18                 init : function(ed, url) {\r
19                         // Register the command so that it can be invoked by using tinyMCE.activeEditor.execCommand('mceExample');\r
20                         ed.addCommand('mceExample', function() {\r
21                                 ed.windowManager.open({\r
22                                         file : url + '/dialog.htm',\r
23                                         width : 320 + parseInt(ed.getLang('example.delta_width', 0)),\r
24                                         height : 120 + parseInt(ed.getLang('example.delta_height', 0)),\r
25                                         inline : 1\r
26                                 }, {\r
27                                         plugin_url : url, // Plugin absolute URL\r
28                                         some_custom_arg : 'custom arg' // Custom argument\r
29                                 });\r
30                         });\r
31 \r
32                         // Register example button\r
33                         ed.addButton('example', {\r
34                                 title : 'example.desc',\r
35                                 cmd : 'mceExample',\r
36                                 image : url + '/img/example.gif'\r
37                         });\r
38 \r
39                         // Add a node change handler, selects the button in the UI when a image is selected\r
40                         ed.onNodeChange.add(function(ed, cm, n) {\r
41                                 cm.setActive('example', n.nodeName == 'IMG');\r
42                         });\r
43                 },\r
44 \r
45                 /**\r
46                  * Creates control instances based in the incomming name. This method is normally not\r
47                  * needed since the addButton method of the tinymce.Editor class is a more easy way of adding buttons\r
48                  * but you sometimes need to create more complex controls like listboxes, split buttons etc then this\r
49                  * method can be used to create those.\r
50                  *\r
51                  * @param {String} n Name of the control to create.\r
52                  * @param {tinymce.ControlManager} cm Control manager to use inorder to create new control.\r
53                  * @return {tinymce.ui.Control} New control instance or null if no control was created.\r
54                  */\r
55                 createControl : function(n, cm) {\r
56                         return null;\r
57                 },\r
58 \r
59                 /**\r
60                  * Returns information about the plugin as a name/value array.\r
61                  * The current keys are longname, author, authorurl, infourl and version.\r
62                  *\r
63                  * @return {Object} Name/value array containing information about the plugin.\r
64                  */\r
65                 getInfo : function() {\r
66                         return {\r
67                                 longname : 'Example plugin',\r
68                                 author : 'Some author',\r
69                                 authorurl : 'http://tinymce.moxiecode.com',\r
70                                 infourl : 'http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/example',\r
71                                 version : "1.0"\r
72                         };\r
73                 }\r
74         });\r
75 \r
76         // Register plugin\r
77         tinymce.PluginManager.add('example', tinymce.plugins.ExamplePlugin);\r
78 })();\r