关于多页编辑器中不同Editor之间的Redo&Undo冲突的解决

在我们的插件工具的开发过程中碰到一个问题,就是在编辑xml文件的时候,因为采用了EMF建模,导致在使用Eclipse Forms编辑节点和属性与编辑事件的JavaScript脚本的Editor之间二者的Redo&Undo功能有一定的冲突,EMF的Redo&Undo不可用,当把JavaScript编辑器中TextViewer的UndoManager屏蔽了之后,EMF的Redo&Undo才能正常,开始跟踪调试代码,始终没有找到问题的症结所在,经过几天的摸索,最终找到了答案.
原来跟ContributorActionBar有关,在插件中,对于Editor(这里的Editor是指的多页编辑器外面的那个总的Editor不是里面每一页中的Editor)来说,我们必须为其指定一个ContributorActionBar,在该类的初始化方法:
void org.eclipse.ui.part.EditorActionBarContributor.init(IActionBars bars)
中需要为IActionBars添加各种Action,比如CopyAction, DeleteAction, CutAction这里面就包括RedoAction和UndoAction,例如在
void org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor.init(IActionBars actionBars)中就是这样来做的:

java 代码

deleteAction = new DeleteAction(removeAllReferencesOnDelete());
deleteAction.setImageDescriptor(sharedImages.getImageDescriptor(ISharedImages.IMG_TOOL_DELETE));
actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(), deleteAction);

上面的代码将系统的Undo&Redo快捷键以及Eclipse菜单项Delete与deleteAction关联起来了.
如果多页编辑器里面使用了一个另外一个TextEditor,那么在这个TextEditor中对Redo&Undo Action会调用org.eclipse.ui.texteditor.AbstractTextEditor.createUndoRedoActions()方法,其中代码如下:

java 代码

IUndoContext undoContext= getUndoContext();
        if (undoContext != null) {
            // Use actions provided by global undo/redo

            // Create the undo action
            OperationHistoryActionHandler undoAction= new UndoActionHandler(getEditorSite(), undoContext);
            PlatformUI.getWorkbench().getHelpSystem().setHelp(undoAction, IAbstractTextEditorHelpContextIds.UNDO_ACTION);
            undoAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.UNDO);
            registerUndoRedoAction(ITextEditorActionConstants.UNDO, undoAction);
            ... ...

在registerUndoRedoAction方法中:

java 代码

private void registerUndoRedoAction(String actionId, OperationHistoryActionHandler action) {
        IAction oldAction= getAction(actionId);
        if (oldAction instanceof OperationHistoryActionHandler)
            ((OperationHistoryActionHandler)oldAction).dispose();

        setAction(actionId, action);

        IActionBars actionBars= getEditorSite().getActionBars();
        if (actionBars != null)
            actionBars.setGlobalActionHandler(actionId, action);
    }

会再一次的将指定的Action与全局ActionId关联起来,这样我们前面制定的Action就会被屏蔽掉,导致使用了TextEditor的UndoManager之后,EMF的模型编辑的Redo&Undo无法使用,找到了问题所在,至于解决办法就好搞定了.

另:

研究Undo&Redo的入口在void org.eclipse.swt.custom.StyledText.modifyContent(Event event, boolean updateCaret)
然后是void org.eclipse.swt.custom.StyledTextContent.replaceTextRange(int start, int replaceLength, String text)
StyledTextContent这个类是用来链接TextViewer和Document之间的适配器,TextViewer默认的实现是DefaultDocumentAdapter,如果需要提供自己的DocumentAdapter的实现需要复写 TextViewer 的 createDocumentAdapter() 方法,所有的操作会转交给当前编辑的Document,对于UndoMananger来说,它会在每个TextViewer上所编辑的Document注册一些监听器,用来监听Document的改变,当Document发生改变的时候,会触发这些监听器,这些监听器,根据Document的改变生成一个一个的Command或者Operation并保存在StackCommand或者是History中,以便Undo的时候从StackCommand和History中取出来执行