No checkWidgets after editor#insertHtml and #insertText

[Alfonso Martínez de Lizarrondo]

TC1

Use the API sample and add the image2 plugin, now insert an image with the textarea to test the API and that image can't be edited because it isn't a widget.

TC2

Go to placeholder sample and execute:

CKEDITOR.instances.editor1.insertText( '[[foo]]' )

Text will be upcasted to widget, but widget won't be initialized on it.

Workaround

After inserting HTML/text call:

editor1.widgets.fire( 'checkWidgets' )

[Piotrek Koszuliński]

Another case - insert template with image - image won't be a widget (actually, it will be gone, but due to: #11170).

[Olek Nowodziński]

cc

[Alfonso Martínez de Lizarrondo]

Besides inserting content with insertHtml, another way to add content to the editor is by directly creating the DOM elements and inserting them.

In that case the images don't get the wrapping span and all those properties and the call to widgets.checkWidgets() doesn't do anything.

Is there a way to fully initialize a widget on a specific DOM element? (ie: I call something like editor.widgets.initialize(element) and the editor takes care to check if that element must be converted to a widget)

[Piotrek Koszuliński]

There are two ways to wrap element into a widget (we call this upcasting).

• First is by using data processor if upcast method was defined - this happens on insertHtml and insertText, but that means operating on HTML string.
• Second way is by using editor.widgets.wrapElement - this method can be called on detached or wired element, both on dom.element and htmlParser.element. After wrapping, widget still has to be initialised.
• And there's a third way which reuses the second way - editor.widgets.initOn. This method will wrap element and then initialise widget on it.

Regarding checkWidgets - it has only two jobs - destroying vanished widgets and initialising widgets on wrapped (upcasted) elements which don't have instances yet.

[Alfonso Martínez de Lizarrondo]

Thanks, but the problem with editor.widgets.wrapElement (or editor.widgets.initOn) is that besides the element, it requires to know the widget that I want to use and my request is to say to CKEditor:

Hello, I've inserted this element, I've finished. Can you check now if some widget wants to do something about it?

I don't want to reimplement any logic to find out which widgets are active, which elements they want to work on and which elements they avoid, I want an API call that will detect what to do with that element.

[Piotrek Koszuliński]

To reuse widgets' upcast methods you have to use insertHtml() rather than insertElement(). I understand your point, but this is a limitation which couldn't be overcome without a code duplication in widgets definitions. Widgets' upcast methods work only with htmlParser.element, so they cannot be used in insertElement().

[Jakub Ś]

#11210 was marked as duplicate.