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.fxom.FXOMDocument;
  36 import java.util.Collections;
  37 import java.util.List;
  38 
  39 /**
  40  * This Job updates the FXOM document at execution time. The selection is not
  41  * updated.
  42  *
  43  * The sub jobs are created and executed just after.
  44  */
  45 public abstract class InlineDocumentJob extends CompositeJob {
  46 
  47     private List<Job> subJobs;
  48 
  49     public InlineDocumentJob(EditorController editorController) {
  50         super(editorController);
  51     }
  52 
  53     @Override
  54     public final List<Job> getSubJobs() {
  55         return subJobs;
  56     }
  57 
  58     @Override
  59     public void execute() {
  60         final FXOMDocument fxomDocument
  61                 = getEditorController().getFxomDocument();
  62         fxomDocument.beginUpdate();
  63         subJobs = Collections.unmodifiableList(makeAndExecuteSubJobs());
  64         fxomDocument.endUpdate();
  65     }
  66 
  67     @Override
  68     public void undo() {
  69         final FXOMDocument fxomDocument
  70                 = getEditorController().getFxomDocument();
  71         fxomDocument.beginUpdate();
  72         for (int i = getSubJobs().size() - 1; i >= 0; i--) {
  73             getSubJobs().get(i).undo();
  74         }
  75         fxomDocument.endUpdate();
  76     }
  77 
  78     @Override
  79     public void redo() {
  80         final FXOMDocument fxomDocument
  81                 = getEditorController().getFxomDocument();
  82         fxomDocument.beginUpdate();
  83         for (Job subJob : getSubJobs()) {
  84             subJob.redo();
  85         }
  86         fxomDocument.endUpdate();
  87     }
  88 
  89     protected abstract List<Job> makeAndExecuteSubJobs();
  90 }