api_dialog sample could be improved

[Wiktor Walc]

The api_dialog sample shows some interesting things that can be done with CKEditor dialog, but some of them are not working as one would expect or simply do not show something that could be considered as useful.

1. "Adding dialog window tabs – "My Tab" in the "Link" dialog window."
   • we have an extra tab in the Link dialog, but values from this tab are not used at all when inserting / editing a link
   • same with "My Custom Field"

For me this sample is not very useful, because it does not show how actually one could modify the link itself using values taken from those extra fields added to the dialog.

Perhaps instead of using plain text fields in "My Tab" (we already have one - "My Custom Field") we could offer there a select field where user could select a link from a predefined set of links. Such "tab" could be called "My Link Browser" instead of "My tab". Selecting a link could result in filling the "Url" field automatically and setting focus to "Link Info" tab.

2. "Creating a custom dialog window – "My Dialog" dialog window opened with the "My Dialog" toolbar button."
   • we could call insertText or insertHtml to insert entered text, right now one can type something there and when closing the dialog nothing else happens.

[davh@…]

The example is rather useless because it is not POSSIBLE to save those values anywhere.

I have added this to link.js in onOk, right above the "if (data.adv)"

// Custom attributes.
if ( data.customAttr )
{
 var custAttr = function( inputName, attrName )
 {
  var value = data.customAttr[ inputName ];
  if ( value )
    attributes[attrName] = value;
  else
    removeAttributes.push( attrName );
 };
 for(attr in data.customAttr)
   custAttr(x);
}

Then the fields in could have a similar commit function to these

commit: function(data){
 if (!data.customAttr)
   data.customAttr = {};
 data.customAttr['whatever'] = this.getValue();
}

I havent come up with a nice way to do the setup though... It looks very hackish (but atleast this can be done without hacking the source)

setup: function(v) {
 if (this._.dialog._.selectedElement)
   this.setValue(this._.dialog._.selectedElement.getAttribute("whatever"));
}

[Jakub Ś]

Confirmed.
I think this should be treated more in terms of a task then a feature request :)