1 /*
   2  * Copyright (c) 2012, 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.job.atomic.SetFxomRootJob;
  36 import com.oracle.javafx.scenebuilder.kit.editor.selection.AbstractSelectionGroup;
  37 import com.oracle.javafx.scenebuilder.kit.editor.selection.ObjectSelectionGroup;
  38 import com.oracle.javafx.scenebuilder.kit.fxom.FXOMObject;
  39 import com.oracle.javafx.scenebuilder.kit.metadata.util.DesignHierarchyMask;
  40 import java.util.ArrayList;
  41 import java.util.List;
  42 
  43 /**
  44  *
  45  */
  46 public class SetDocumentRootJob extends BatchSelectionJob {
  47 
  48     private final FXOMObject newRoot;
  49     private final boolean usePredefinedSize;
  50     private final String description;
  51 
  52     public SetDocumentRootJob(FXOMObject newRoot,
  53             boolean usePredefinedSize,
  54             String description,
  55             EditorController editorController) {
  56         super(editorController);
  57 
  58         assert editorController.getFxomDocument() != null;
  59         assert (newRoot == null) || (newRoot.getFxomDocument() == editorController.getFxomDocument());
  60         assert description != null;
  61 
  62         this.newRoot = newRoot;
  63         this.usePredefinedSize = usePredefinedSize;
  64         this.description = description;
  65     }
  66 
  67     public SetDocumentRootJob(FXOMObject newRoot, EditorController editorController) {
  68         this(newRoot, false /* usePredefinedSize */,
  69                 SetDocumentRootJob.class.getSimpleName(), editorController);
  70     }
  71 
  72     public FXOMObject getNewRoot() {
  73         return newRoot;
  74     }
  75 
  76     @Override
  77     protected List<Job> makeSubJobs() {
  78         final List<Job> result = new ArrayList<>();
  79         if (newRoot != getEditorController().getFxomDocument().getFxomRoot()) {
  80             // Before setting newRoot as the root of the fxom document,
  81             // we must remove its static properties.
  82             // We create a RemovePropertyJob for each existing static property
  83             if (newRoot != null) {
  84                 result.add(new PrunePropertiesJob(newRoot, null, getEditorController()));
  85             }
  86 
  87             // Adds job that effectively modifes the root
  88             result.add(new SetFxomRootJob(newRoot, getEditorController()));
  89 
  90             // If need, we add a job for resizing the root object
  91             if ((newRoot != null) && usePredefinedSize) {
  92                 final DesignHierarchyMask mask = new DesignHierarchyMask(newRoot);
  93                 if (mask.needResizeWhenTopElement()) {
  94                     result.add(new UsePredefinedSizeJob(getEditorController(),
  95                             EditorController.Size.SIZE_DEFAULT, newRoot));
  96                 }
  97             }
  98         }
  99         return result;
 100     }
 101 
 102     @Override
 103     protected String makeDescription() {
 104         return description;
 105     }
 106 
 107     @Override
 108     protected AbstractSelectionGroup getNewSelectionGroup() {
 109         if (newRoot == null) {
 110             return null;
 111         }
 112         List<FXOMObject> newObjects = new ArrayList<>();
 113         newObjects.add(newRoot);
 114         return new ObjectSelectionGroup(newObjects, newRoot, null);
 115     }
 116 }