Forms plugin

[Artur Formella]

Use of setup, commit, setupContent() and commitContent() in all dialogs in the Forms plugin

Example:

validate: function()
{
	var func = CKEDITOR.dialog.validate.integer( editor.lang.common.validateNumberFailed );
	return func.apply( this );
},
setup : function( element )
{
	this.setValue( element.getAttribute( 'rows' ) );
},
commit : function( element )
{
	element.setAttribute( 'rows', this.getValue() );
}

[Frederico Caldeira Knabben]

The patch is almost good. It misses the changes to the "select" dialog though.

Also, the reason for this changes is to have the element logic attached to the element itself. In this way, the dialog continue working even if we remove one of the elements. For that, we need to make the onShow and onOk implementations quite generic, independent of specific elements. So, calls like getContentElement must be avoided inside those functions.

I've noted that most of the dialogs are still using getContentElement inside onShow, to set the startup element focus. Other than the problem I've just described, this is something that must not be handled by the dialog definition, but by the API itself, which should automatically set the caret position.

So, a new patch should be provided without those getContentElement calls.

[Artur Formella]

How to set initial focus?

[Frederico Caldeira Knabben]

This is not a patch to trunk. Can you please recreate it?

[Artur Formella]

In plugin.js (near line 113):

oOption = documentObject.createElement( "OPTION" );
var indexOpt = combo.getChild( index );
indexOpt.insertBeforeMe( oOption );

It doesn't work in IE and I don't know why.

[Frederico Caldeira Knabben]

• The CKEDITOR.plugins.forms.select definition is not required into the plugin.js file. It can safely go inside the selection dialog file.

• You have tried to copy the original V2 code for the select tools, but it's not said that it work in the same way for V3. Things can be simplified there. The "_getObject" function usefulness is quite unclear.

• There is an evident repetition inside the init() funciton at plugin.js. The same thing happened for the basicstyles plugin, and a solution similar to what we have there could be applied here (having a function that does the job repeatedly.

• We don't need accesskeys for content pages of dialogs with a single page only (the "I" key is being defined for all "info" pages).

As there is a dependency on the image plugin, this one will hold on until it is not available into the trunk.

[Artur Formella]

I made CKEDITOR.plugins.forms.select to allow developers to use it in their plugins. _getObject() provides abstraction - they could easily use this plugin to edit all select inputs (even in dialogs or on the outer page). We can also move it to CKEDITOR.dom.element.

[Artur Formella]

I need to improve coding style and select dialog in IE.

[Frederico Caldeira Knabben]

• Please add the following to the init function, so the forms get visible, just like V2:

editor.addCss(
	'form' +
	'{' +
		'border: 1px dotted #FF0000;' +
		'padding: 2px;' +
	'}' );

• You still have problems with missing "var" statements. For example:

// Patch code:
removeSelectedOptions = function ( combo )

// Correct code:
var removeSelectedOptions = function( combo )

// For private functions, even better:
function removeSelectedOptions( combo )

We'll have a Review+ after these fixes.

[Frederico Caldeira Knabben]

Also, the form must have something inside of it when created (a <br> is ok), otherwise it gets rendered collapsed.

[Artur Formella]

Fixed with [3114]