undoManager.update does not refresh command state

[dggtydnk]

Calls to the update() in undo Manager should also call undoManager.onChange() to refresh the state of the toolbar. I have a command that does something like:

editor.fire("saveSnapshot");
editor.fire("lockSnapshot");
var span = new CKEDITOR.dom.element("span");
span.setText("Loading...");
editor.insertElemenent(span);
// load data into span via AJAX call here - code omitted
function ajaxLoaded(contents) {
  span.setText(contents);
  editor.fire("unlockSnapshot")
}

I lock the snapshot before setting the "Loading..." text so it does not appear in the undo history stack.

I am left with a toolbar that has both the undo and redo buttons on, even though undoManager.redoable() is false. I think if undoManager.fireChange() (or even just undoManager.onChange()) were called in undoManager.update() (since update() is called in undoManager.unlock()), the toolbar would be in the proper state.

[Piotrek Koszuliński]

I attached sample. Open it, click both buttons and see that undo recorded all states. This is incorrect behaviour - undo shouldn't record changes done between lock and unlock.

I checked that this usage of lock/unlock is conflicting with fixDom which does the same - locks and unlocks undoM. So there is:

• lock - called from sample
• lock - called before fixDom triggered after sample called insertElement
• unlock - called after fixDom

All changes done later are recorded.

Thus, undoM#locked should be an integer counting how deeply it's locked :). Two lock calls should require two unlock calls to unlock undoM.

[Jakub Ś]

Events lockSnapshot and unlockSnapshot were introduced in CKEditor 4.0 so this is the starting point.

[Alfonso Martínez de Lizarrondo]

A minor note: the documentation for those events lack the @since to state that 4.0 version.

[Piotrek Koszuliński]

Thanks Alfonso, fixed docs with ​git:0b97fc7.

[Piotrek Koszuliński]

Pushed ​t/10131 on dev and tests.

[Frederico Caldeira Knabben]

Let's move this ahead so we can see the effects of it in practice.

[Piotrek Koszuliński]

Fixed on master with ​git:25d174d and on tests with 312b9b3.