Ticket #2790: 2790.patch

_samples/api_dialog/api_dialog.css

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+.cke_skin_default a.cke_button.cke_button_custom .cke_icon
+{
+        display: none;
+}
+
+.cke_skin_default a.cke_button.cke_button_custom .cke_label
+{
+        display: inline;
+}

_samples/api_dialog/api_dialog.js

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+(function()
+{
+        function hook( obj, name, func )
+        {
+                if ( obj.attachEvent )
+                        return obj.attachEvent( 'on' + name, func );
+                else
+                        return obj.addEventListener( name, func, false );
+        }
+
+        function init()
+        {
+                CKEDITOR.replace( 'editor1',
+                        {
+                                plugins : 'basicstyles,button,dialog,elementspath,htmldataprocessor,keystrokes,sourcearea,tab,toolbar,wysiwygarea',
+                                toolbar : [ [ 'Source', '-', 'Bold', 'Italic', 'Underline', 'Strike', '-', 'Custom' ] ]
+                        } );
+
+                var editor = CKEDITOR.instances.editor1,
+                        // This adds a second page and third page after the first.
+                        addPages = function( definition )
+                        {
+                                definition.addContents( {
+                                                id : 'tab2',
+                                                label : 'Second Tab',
+                                                title : 'Second Tab Title',
+                                                accessKey : 'W',
+                                                elements : [
+                                                        {
+                                                                type : 'hbox',
+                                                                children : [
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 4',
+                                                                                title : 'Your love is like bad medicine!',
+                                                                                id : 'testText4',
+                                                                                'default' : 'hello world!',
+                                                                                validate : function( dialog )
+                                                                                {
+                                                                                        var valid = /^[A-Z a-z!]+$/.test( this.getValue() );
+                                                                                        if ( !valid )
+                                                                                        {
+                                                                                                this.select();
+                                                                                                alert( 'Test Text 4 must only contain alphanumeric characters, space, or ! and must not be empty.' );
+                                                                                        }
+                                                                                        return valid;
+                                                                                },
+                                                                                isChanged : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 5',
+                                                                                id : 'testText5',
+                                                                                'default' : 'Wheee'
+                                                                        },
+
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 6',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                id : 'testText6',
+                                                                                'default' : 'Blah blah'
+                                                                        }
+                                                                ]
+                                                        }
+                                                ]
+                                        } );
+                                definition.addContents( {
+                                                id : 'tab3',
+                                                label : 'Third Tab',
+                                                title : 'Third Tab Title',
+                                                accessKey : 'E',
+                                                elements : [
+                                                        {
+                                                                type : 'vbox',
+                                                                children : [
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable this',
+                                                                                title : 'Shake it up, just like bad medicine!',
+                                                                                accessKey : 'T',
+                                                                                checked : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable that',
+                                                                                checked : true
+                                                                        },
+
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable those',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                checked : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'radio',
+                                                                                label : 'Include library:',
+                                                                                title : 'Trying to include a library in LOLCODE.',
+                                                                                'default' : 'stdio',
+                                                                                accessKey : 'Y',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                items : [
+                                                                                        [ 'Standard I/O', 'stdio', 'You need this to write Hello World.' ],
+                                                                                        [ 'Standard C Library', 'stdlib', 'You need this to exit.' ],
+                                                                                        [ 'POSIX Library', 'unistd', 'You need this to sleep.' ],
+                                                                                        [ 'Signal Library', 'signal' ]
+                                                                                ]
+                                                                        },
+
+                                                                        {
+                                                                                type : 'button',
+                                                                                label : 'Click Me',
+                                                                                title : 'Click me plz!',
+                                                                                accessKey : 'U',
+                                                                                onClick : function( evt )
+                                                                                {
+                                                                                        console.log( 'Clicked!!' );
+                                                                                }
+                                                                        },
+
+                                                                        {
+                                                                                type : 'html',
+                                                                                html : '<strong>CKEditor rocks.</strong>'
+                                                                        }
+                                                                ]
+                                                        }
+                                                ]
+                                        } );
+                        },
+                        // This removes the second page.
+                        removePages = function( definition )
+                        {
+                                definition.removeContents( 'tab2' );
+                        },
+                        // This adds three text fields in the first page.
+                        addFields = function( definition )
+                        {
+                                var page1 = definition.getContents( 'tab1' );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 1',
+                                                id : 'testText1',
+                                                'default' : 'hello world!',
+                                                accessKey : 'R'
+                                        } );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 2',
+                                                id : 'testText2',
+                                                'default' : 'Wheee'
+                                        } );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 3',
+                                                id : 'testText3',
+                                                'default' : 'Blah blah'
+                                        } );
+                        },
+                        // This removes the first text field (originally defined in custom_dialog.js)
+                        // in the first page.
+                        removeFields = function( definition )
+                        {
+                                var page1 = definition.getContents( 'tab1' );
+                                page1.remove( 'input1' );
+                        },
+                        // This sets the default value of the 'testText1' text field in the first
+                        // page.
+                        setDefaultValues = function( definition )
+                        {
+                                var testText1 = definition.getContents( 'tab1' ).get( 'testText1' );
+                                testText1['default'] = 'Modified';
+                        },
+                        // This modifies the default size of the dialog.
+                        setDefaultSize = function( definition )
+                        {
+                                definition.minWidth = 500;
+                                definition.minHeight = 400;
+                        },
+                        // This modifies the custom dialog's definition when it's created.
+                        modifyDefinition = function( evt )
+                        {
+                                if ( evt.data.name != 'custom' )
+                                        return;
+
+                                var definition = evt.data.definition;
+                                addPages( definition );
+                                removePages( definition );
+                                addFields( definition );
+                                removeFields( definition );
+                                setDefaultValues( definition );
+                                setDefaultSize( definition );
+
+                                return evt.data;
+                        },
+                        addDialog = function()
+                        {
+                                // Register the custom dialog.
+                                var href = document.location.href.split( '/' );
+                                href.pop();
+                                href.push( 'api_dialog', 'custom_dialog.js' );
+                                CKEDITOR.dialog.add( 'custom', href.join( '/' ) );
+
+                                // Add the custom dialog buttons.
+                                editor.addCommand( 'custom', new CKEDITOR.dialogCommand( 'custom' ) );
+                                editor.ui.addButton( 'Custom',
+                                        {
+                                                label : 'Custom Dialog',
+                                                command : 'custom'
+                                        } );
+
+                                // Add .css file related to custom dialog button.
+                                var doc = new CKEDITOR.dom.document( document );
+                                href.pop();
+                                href.push( 'api_dialog.css' );
+                                doc.appendStyleSheet( href.join( '/' ) );
+
+                                // Modify the dialog definition to demonstrate the API.
+                                editor.on( 'dialogDefinition', modifyDefinition );
+                        };
+
+                // Add the custom dialog after the dialog plugin loaded.
+                if ( typeof( editor.openDialog ) == 'function' )
+                        addDialog();
+                else
+                        editor.on( 'dialogPluginLoaded', addDialog );
+        }
+
+        hook( window, 'load', init );
+})();

_samples/api_dialog/custom_dialog.js

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+CKEDITOR.dialog.add( 'custom', function( editor )
+{
+        return {
+                title : 'Custom Dialog',
+                minWidth : 400,
+                minHeight : 320,
+                contents : [
+                        {
+                                id : 'tab1',
+                                label : 'First Tab',
+                                title : 'First Tab',
+                                elements :
+                                [
+                                        {
+                                                id : 'input1',
+                                                type : 'text',
+                                                label : 'Input 1'
+                                        }
+                                ]
+                        }
+                ]
+        };
+} );

_samples/api_dialog.html

@@ +1 @@
+<!DOCTYPE html>
+<!--
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+-->
+<html>
+        <head>
+                <title>Dialog API - CKEditor Sample</title>
+                <script type="text/javascript" src="../ckeditor_source.js"></script>
+                <script type="text/javascript" src="api_dialog/api_dialog.js"></script>
+                <link type="text/css" rel="stylesheet" href="sample.css" />
+                <meta content="text/html; charset=utf-8" http-equiv="content-type" />
+        </head>
+        <body>
+                <h1>CKEditor Sample</h1>
+                <p>This sample shows how the dialog API can be used to</p>
+                <ol>
+                        <li>Add dialog pages;</li>
+                        <li>Remove dialog pages;</li>
+                        <li>Add dialog fields;</li>
+                        <li>Remove dialog fields;</li>
+                        <li>Set default values.</li>
+                </ol>
+                <p>Without modifying the original dialog's .js file.</p>
+                <fieldset title="Editor">
+                        <textarea id="editor1" name="editor1" rows="10" cols="80">&lt;p&gt;This is some &lt;strong&gt;sample text&lt;/strong&gt;. You are using &lt;a href="http://www.fckeditor.net/"&gt;FCKeditor&lt;/a&gt;.&lt;/p&gt;</textarea>
+                </fieldset>
+                <div id="footer">
+                        <hr/>
+                        <p>
+                                CKEditor - The text editor for Internet - <a href="http://ckeditor.com/">http://ckeditor.com</a>
+                        </p>
+                        <p id="copy">
+                                Copyright © 2003-2009, <a href="http://cksource.com/">CKSource</a> - Frederico Knabben. All rights reserved.
+                        </p>
+                </div>
+        </body>
+</html>

_samples/api_dialog/api_dialog.css

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+.cke_skin_default a.cke_button.cke_button_custom .cke_icon
+{
+        display: none;
+}
+
+.cke_skin_default a.cke_button.cke_button_custom .cke_label
+{
+        display: inline;
+}

_samples/api_dialog/api_dialog.js

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+(function()
+{
+        function hook( obj, name, func )
+        {
+                if ( obj.attachEvent )
+                        return obj.attachEvent( 'on' + name, func );
+                else
+                        return obj.addEventListener( name, func, false );
+        }
+
+        function init()
+        {
+                CKEDITOR.replace( 'editor1',
+                        {
+                                plugins : 'basicstyles,button,dialog,elementspath,htmldataprocessor,keystrokes,sourcearea,tab,toolbar,wysiwygarea',
+                                toolbar : [ [ 'Source', '-', 'Bold', 'Italic', 'Underline', 'Strike', '-', 'Custom' ] ]
+                        } );
+
+                var editor = CKEDITOR.instances.editor1,
+                        // This adds a second page and third page after the first.
+                        addPages = function( definition )
+                        {
+                                definition.addContents( {
+                                                id : 'tab2',
+                                                label : 'Second Tab',
+                                                title : 'Second Tab Title',
+                                                accessKey : 'W',
+                                                elements : [
+                                                        {
+                                                                type : 'hbox',
+                                                                children : [
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 4',
+                                                                                title : 'Your love is like bad medicine!',
+                                                                                id : 'testText4',
+                                                                                'default' : 'hello world!',
+                                                                                validate : function( dialog )
+                                                                                {
+                                                                                        var valid = /^[A-Z a-z!]+$/.test( this.getValue() );
+                                                                                        if ( !valid )
+                                                                                        {
+                                                                                                this.select();
+                                                                                                alert( 'Test Text 4 must only contain alphanumeric characters, space, or ! and must not be empty.' );
+                                                                                        }
+                                                                                        return valid;
+                                                                                },
+                                                                                isChanged : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 5',
+                                                                                id : 'testText5',
+                                                                                'default' : 'Wheee'
+                                                                        },
+
+                                                                        {
+                                                                                type : 'text',
+                                                                                label : 'Test Text 6',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                id : 'testText6',
+                                                                                'default' : 'Blah blah'
+                                                                        }
+                                                                ]
+                                                        }
+                                                ]
+                                        } );
+                                definition.addContents( {
+                                                id : 'tab3',
+                                                label : 'Third Tab',
+                                                title : 'Third Tab Title',
+                                                accessKey : 'E',
+                                                elements : [
+                                                        {
+                                                                type : 'vbox',
+                                                                children : [
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable this',
+                                                                                title : 'Shake it up, just like bad medicine!',
+                                                                                accessKey : 'T',
+                                                                                checked : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable that',
+                                                                                checked : true
+                                                                        },
+
+                                                                        {
+                                                                                type : 'checkbox',
+                                                                                label : 'Enable those',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                checked : false
+                                                                        },
+
+                                                                        {
+                                                                                type : 'radio',
+                                                                                label : 'Include library:',
+                                                                                title : 'Trying to include a library in LOLCODE.',
+                                                                                'default' : 'stdio',
+                                                                                accessKey : 'Y',
+                                                                                onChange : function(){ console.log( this.getValue() ); },
+                                                                                items : [
+                                                                                        [ 'Standard I/O', 'stdio', 'You need this to write Hello World.' ],
+                                                                                        [ 'Standard C Library', 'stdlib', 'You need this to exit.' ],
+                                                                                        [ 'POSIX Library', 'unistd', 'You need this to sleep.' ],
+                                                                                        [ 'Signal Library', 'signal' ]
+                                                                                ]
+                                                                        },
+
+                                                                        {
+                                                                                type : 'button',
+                                                                                label : 'Click Me',
+                                                                                title : 'Click me plz!',
+                                                                                accessKey : 'U',
+                                                                                onClick : function( evt )
+                                                                                {
+                                                                                        console.log( 'Clicked!!' );
+                                                                                }
+                                                                        },
+
+                                                                        {
+                                                                                type : 'html',
+                                                                                html : '<strong>CKEditor rocks.</strong>'
+                                                                        }
+                                                                ]
+                                                        }
+                                                ]
+                                        } );
+                        },
+                        // This removes the second page.
+                        removePages = function( definition )
+                        {
+                                definition.removeContents( 'tab2' );
+                        },
+                        // This adds three text fields in the first page.
+                        addFields = function( definition )
+                        {
+                                var page1 = definition.getContents( 'tab1' );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 1',
+                                                id : 'testText1',
+                                                'default' : 'hello world!',
+                                                accessKey : 'R'
+                                        } );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 2',
+                                                id : 'testText2',
+                                                'default' : 'Wheee'
+                                        } );
+                                page1.add( {
+                                                type : 'text',
+                                                label : 'Test Text 3',
+                                                id : 'testText3',
+                                                'default' : 'Blah blah'
+                                        } );
+                        },
+                        // This removes the first text field (originally defined in custom_dialog.js)
+                        // in the first page.
+                        removeFields = function( definition )
+                        {
+                                var page1 = definition.getContents( 'tab1' );
+                                page1.remove( 'input1' );
+                        },
+                        // This sets the default value of the 'testText1' text field in the first
+                        // page.
+                        setDefaultValues = function( definition )
+                        {
+                                var testText1 = definition.getContents( 'tab1' ).get( 'testText1' );
+                                testText1['default'] = 'Modified';
+                        },
+                        // This modifies the default size of the dialog.
+                        setDefaultSize = function( definition )
+                        {
+                                definition.minWidth = 500;
+                                definition.minHeight = 400;
+                        },
+                        // This modifies the custom dialog's definition when it's created.
+                        modifyDefinition = function( evt )
+                        {
+                                if ( evt.data.name != 'custom' )
+                                        return;
+
+                                var definition = evt.data.definition;
+                                addPages( definition );
+                                removePages( definition );
+                                addFields( definition );
+                                removeFields( definition );
+                                setDefaultValues( definition );
+                                setDefaultSize( definition );
+
+                                return evt.data;
+                        },
+                        addDialog = function()
+                        {
+                                // Register the custom dialog.
+                                var href = document.location.href.split( '/' );
+                                href.pop();
+                                href.push( 'api_dialog', 'custom_dialog.js' );
+                                CKEDITOR.dialog.add( 'custom', href.join( '/' ) );
+
+                                // Add the custom dialog buttons.
+                                editor.addCommand( 'custom', new CKEDITOR.dialogCommand( 'custom' ) );
+                                editor.ui.addButton( 'Custom',
+                                        {
+                                                label : 'Custom Dialog',
+                                                command : 'custom'
+                                        } );
+
+                                // Add .css file related to custom dialog button.
+                                var doc = new CKEDITOR.dom.document( document );
+                                href.pop();
+                                href.push( 'api_dialog.css' );
+                                doc.appendStyleSheet( href.join( '/' ) );
+
+                                // Modify the dialog definition to demonstrate the API.
+                                editor.on( 'dialogDefinition', modifyDefinition );
+                        };
+
+                // Add the custom dialog after the dialog plugin loaded.
+                if ( typeof( editor.openDialog ) == 'function' )
+                        addDialog();
+                else
+                        editor.on( 'dialogPluginLoaded', addDialog );
+        }
+
+        hook( window, 'load', init );
+})();

_samples/api_dialog/custom_dialog.js

@@ +1 @@
+/*
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+For licensing, see LICENSE.html or http://ckeditor.com/license
+*/
+
+CKEDITOR.dialog.add( 'custom', function( editor )
+{
+        return {
+                title : 'Custom Dialog',
+                minWidth : 400,
+                minHeight : 320,
+                contents : [
+                        {
+                                id : 'tab1',
+                                label : 'First Tab',
+                                title : 'First Tab',
+                                elements :
+                                [
+                                        {
+                                                id : 'input1',
+                                                type : 'text',
+                                                label : 'Input 1'
+                                        }
+                                ]
+                        }
+                ]
+        };
+} );

_source/plugins/dialog/plugin.js

@@ -9 +9 @@
 
 CKEDITOR.plugins.add( 'dialog',
         {
-                requires : [ 'dialogui' ]
+                requires : [ 'dialogui' ],
+
+                init : function( editor, pluginPath )
+                {
+                        editor.fire( 'dialogPluginLoaded' );
+                }
         });
 
 /**
@@ -69 +74 @@
                 return;
         }
         definition = new CKEDITOR.dialog._.definitionObject( this, definition );
-        definition = CKEDITOR.fire( 'dialogDefinition', { name : dialogName, definition : definition }, editor ).definition;
+        definition = editor.fire( 'dialogDefinition', { name : dialogName, definition : definition }, editor ).definition;
 
         // Initialize some basic parameters.
         CKEDITOR.tools.extend( ( this._ || ( this._ = {} ) ), {
@@ -1243 +1248 @@
 
         currentZIndex : null,
 
-        storedDialogs : {},
-
         margins : [0, 0, 0, 0],
 
         /**
@@ -2129 +2132 @@
                         // If the dialogDefinition is already loaded, open it immediately.
                         if ( typeof( CKEDITOR.dialog._.dialogDefinitions[dialogName] ) == 'function' )
                         {
-                                var dialog = CKEDITOR.dialog._.storedDialogs[dialogName] || new CKEDITOR.dialog( this, dialogName );
-                                CKEDITOR.dialog._.storedDialogs[dialogName] = dialog;
+                                if ( !this._.storedDialogs )
+                                        this._.storedDialogs = {};
+
+                                var dialog = this._.storedDialogs[dialogName] || new CKEDITOR.dialog( this, dialogName );
+                                this._.storedDialogs[dialogName] = dialog;
                                 dialog.show();
                                 return dialog;
                         }

_source/plugins/dialogui/plugin.js

@@ -360 +360 @@
                                         this._['default'] = [ elementDefinition.items[0][1] ] ;
                                 if ( elementDefinition.validate )
                                         this.validate = elementDefinition.valdiate;
-                                var children = [];
+                                var children = [], me = this;
 
                                 /** @ignore */
                                 var innerHTML = function()
@@ -392 +392 @@
                                                                 name : commonName,
                                                                 value : value
                                                         };
-                                                if ( this.getDefault() == value )
+                                                if ( me.getDefault() == value )
                                                         inputAttributes.checked = 'checked';
                                                 cleanInnerDefinition( inputDefinition );
                                                 cleanInnerDefinition( labelDefinition );