1 /*
   2  * Copyright (c) 2014, Oracle and/or its affiliates.
   3  * All rights reserved. Use is subject to license terms.
   4  *
   5  * This file is available and licensed under the following license:
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  *  - Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *  - Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the distribution.
  16  *  - Neither the name of Oracle Corporation nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 package com.oracle.javafx.scenebuilder.kit.editor.job;
  33 
  34 import com.oracle.javafx.scenebuilder.kit.editor.EditorController;
  35 import com.oracle.javafx.scenebuilder.kit.editor.selection.AbstractSelectionGroup;
  36 import com.oracle.javafx.scenebuilder.kit.editor.selection.Selection;
  37 import java.util.List;
  38 
  39 /**
  40  * This Job updates the FXOM document AND the selection at execution time.
  41  *
  42  * The sub jobs are FIRST all created, THEN executed.
  43  */
  44 public abstract class BatchSelectionJob extends BatchDocumentJob {
  45 
  46     private AbstractSelectionGroup oldSelectionGroup;
  47     private AbstractSelectionGroup newSelectionGroup;
  48 
  49     public BatchSelectionJob(EditorController editorController) {
  50         super(editorController);
  51     }
  52 
  53     protected final AbstractSelectionGroup getOldSelectionGroup() {
  54         return oldSelectionGroup;
  55     }
  56 
  57     protected abstract AbstractSelectionGroup getNewSelectionGroup();
  58 
  59     @Override
  60     public final void execute() {
  61         final Selection selection = getEditorController().getSelection();
  62         try {
  63             selection.beginUpdate();
  64             oldSelectionGroup = selection.getGroup() == null ? null
  65                     : selection.getGroup().clone();
  66             super.execute();
  67             newSelectionGroup = getNewSelectionGroup();
  68             selection.select(newSelectionGroup);
  69             selection.endUpdate();
  70 
  71         } catch (CloneNotSupportedException x) {
  72             // Emergency code
  73             throw new RuntimeException(x);
  74         }
  75     }
  76 
  77     @Override
  78     public final void undo() {
  79         final Selection selection = getEditorController().getSelection();
  80         selection.beginUpdate();
  81         super.undo();
  82         selection.select(oldSelectionGroup);
  83         selection.endUpdate();
  84     }
  85 
  86     @Override
  87     public final void redo() {
  88         final Selection selection = getEditorController().getSelection();
  89         selection.beginUpdate();
  90         super.redo();
  91         selection.select(newSelectionGroup);
  92         selection.endUpdate();
  93     }
  94 
  95     @Override
  96     protected abstract List<Job> makeSubJobs();
  97 }