在基于表单的编辑器中实现撤消重做

时间:2013-01-07 09:38:33

标签: java xml eclipse-plugin undo-redo

我正在开发一个多页面编辑器,用于在Eclipse中编辑/创建自定义XML文件。 结构看起来像:

  • 实现类是MyXMLFormEditor,它扩展了FormEditor。
  • FormEditor的每一页都扩展了FormPage(即MyXMLFormPage扩展了FormPage)。
  • 在FormEditor和实际的XML文件之间,我正在维护JDOM模型。
  • 我还实现了脏标记处理。因此,用户对表单编辑器的输入将保存到JDOM中,直到用户按下“保存”按钮为止。当用户按下保存按钮时,JDOM被写入/序列化为XML文件。

在具有上述功能的编辑器中,我想实现撤消/重做功能,如下所示:

当编辑器变脏(用户将某些内容更改为表单编辑器并且未保存)时,撤消操作应将表单编辑器和JDOM中的更改恢复为其原始状态(即编辑器非脏时的状态)和重做操作应该再次将更改恢复到FormEditor以及JDOM和编辑器应该变脏。

以下是我的代码段

MyXMLFormEditor.java

public class MyXMLFormEditor extends FormEditor {

    MyXMLFormEditor(){
                                super();                                
                                }

                @Override
                protected FormToolkit createToolkit(Display display) {
                                // Create a toolkit that shares colors between editors.
                                return new FormToolkit(Activator.getDefault().getFormColors(display));
                }

                @Override
                public void init(IEditorSite site, IEditorInput editorInput) {
                                setSite(site);
                                mSite = site;
                                setInput(editorInput);
                                try {
                                                super.init(site, editorInput);
                                } catch (PartInitException e1) {
                                                e1.printStackTrace();
                                }
                                if (!(editorInput instanceof IFileEditorInput))
                                                try {
                                                                throw new PartInitException("Invalid Input: Must be IFileEditorInput");
                                                                } catch (PartInitException e) {
                                                                                e.printStackTrace();
                                                                }
                                setPartName(fileName);
                }
                public void setUpProgFile(IEditorSite site, IEditorInput editorInput){                       
                                IFileEditorInput fileInput = ((IFileEditorInput) editorInput);

                                //create document builder and prepare JDom model for xml file.
                }


                @Override
                protected void addPages() {
                                try {
                                                //add 'Main' page
                                                objMyXMLFormPage = new MyXMLFormPage (this, "FirstPage","Main");
                                                //set rootNode of MyXMLFormPage 
                                                objMyXMLFormPage.rootNode = getRootNode();
                                                objMyXMLFormPage.filePath = filePath;
                                                objMyXMLFormPage.document = document;
                                                addPage(objMyXMLFormPage);

                                } catch (PartInitException e) {
                                                e.printStackTrace();
                                }
                }

                @Override
                public void doSave(IProgressMonitor monitor) {
                                System.out.println("MyXMLFormEditor: doSave");

                                //logic to write jdom contents into xml file.
                                objMyXMLFormPage.setDirty(false);
                }

                @Override
                public void doSaveAs() {
                                System.out.println("MyXMLFormEditor: doSaveAs");
                }
                @Override
                public boolean isSaveAsAllowed() {
                                System.out.println("MyXMLFormEditor: isSaveAsAllowed");
                                return true;
                }

}

MyXMLFormPage .java

public class MyXMLFormPage  extends FormPage{

                //private members declaration.

                public MyXMLFormPage (MyXMLFormEditor editor,String title, String id) {
                                // initialize the editor and set its title and name.
                                super(editor,title,id );
                                }

                @Override
                public void createFormContent(IManagedForm managedForm) {
                    // Set page title
                                super.createFormContent(managedForm);

                                FormToolkit mMyXMLFormPage Toolkit = managedForm.getToolkit();

                                //Logic to creat UI and populating its contents from JDom

                }


                private void makeEditorDirty() {
                                updateJdom =  true;       
                                setDirty(true);                                                   
                }

                private void updateJDom() {
                                if(updateJdom){
                                                System.out.println("*** Jdom updated ***");
                                                updateJdom = false;
                                }
                }

                @Override
                public boolean isDirty() {
                                return isDirtyFlag;
                }

                protected void setDirty(boolean value) {
                                isDirtyFlag = value;
                                dirtyStateChanged();
                }

                public void dirtyStateChanged() {
                                getEditor().editorDirtyStateChanged();

                }

                @Override
                public boolean isSaveAsAllowed() {
                                System.out.println("MyXMLFormPage .isSaveAsAllowed");
                      return false;
                   }

                @Override
                public void doSave(IProgressMonitor monitor) {
                                System.out.println("MyXMLFormPage .doSave");
                }

}

有人可以提供关于如何在FormEditor中实现撤消/重做功能的指针/示例吗?如果该方法使用Eclipse PDE或工作台的现有撤消/重做框架,那将是很好的。

1 个答案:

答案 0 :(得分:0)

关于Eclipse中多页面编辑器实现所使用的模式,有几点需要注意。可能还有其他方法可以做到,但Eclipse中的编辑似乎坚持这些观点:

  • 维护编辑器中页面共享的数据模型(您正在执行此操作)。
  • 仅在要显示页面时刷新包含模型数据的页面。请勿尝试使未显示的页面与模型保持同步。
  • 执行撤消或重做时,对模型进行适当的更改(根据@ Scorpion的评论),然后刷新当前页面。
  • 每个页面都应该有一个ok-to-leave-this-page方法(我不记得名字),这个方法被调用以确保显示的数据没有足够的错误以允许页面被更改(您不希望非显示数据出错)。
  • 页面有一个即将离开此页面的方法,在切换页面之前,该方法被调用以保存对模型的任何更改。大多数页面在这里没有做任何事情,因为模型有时会被每次击键修改,但源页面会使用此方法将模型完全替换为文本编辑器内容的解析结果。

这意味着您的表单不必自行执行撤消/重做。相反,表示多页面编辑器页面的类将在模型更改时与模型交互,然后传递正确的数据以显示给表单。

表单需要侦听撤消/重做键事件,并通过命令模式将这些事件传递给模型。