Extends LayoutOperation with more data and add to layout as parameter (#259)

Relates to eclipse-glsp/glsp#1561

Author: martin-fleck-at

examples/org.eclipse.glsp.example.workflow/src/org/eclipse/glsp/example/workflow/layout/WorkflowLayoutEngine.java

@@ -15,13 +15,16 @@
  ********************************************************************************/
 package org.eclipse.glsp.example.workflow.layout;
 
+import java.util.Optional;
+
 import org.eclipse.elk.alg.layered.options.FixedAlignment;
 import org.eclipse.elk.alg.layered.options.LayeredOptions;
 import org.eclipse.glsp.graph.GEdge;
 import org.eclipse.glsp.graph.GGraph;
 import org.eclipse.glsp.layout.ElkLayoutEngine;
 import org.eclipse.glsp.layout.GLSPLayoutConfigurator;
 import org.eclipse.glsp.server.model.GModelState;
+import org.eclipse.glsp.server.operations.LayoutOperation;
 
 import com.google.inject.Inject;
 
@@ -31,7 +34,7 @@ public class WorkflowLayoutEngine extends ElkLayoutEngine {
    protected GModelState modelState;
 
    @Override
-   public void layout() {
+   public void layout(final Optional<LayoutOperation> operation) {
       if (modelState.getRoot() instanceof GGraph) {
          GLSPLayoutConfigurator configurator = new GLSPLayoutConfigurator();
          configurator.configureByType("graph")

plugins/org.eclipse.glsp.layout/src/org/eclipse/glsp/layout/ElkLayoutEngine.java

@@ -25,6 +25,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 
 import org.eclipse.elk.core.IGraphLayoutEngine;
 import org.eclipse.elk.core.RecursiveGraphLayoutEngine;
@@ -63,6 +64,7 @@
 import org.eclipse.glsp.graph.GraphFactory;
 import org.eclipse.glsp.server.layout.LayoutEngine;
 import org.eclipse.glsp.server.model.GModelState;
+import org.eclipse.glsp.server.operations.LayoutOperation;
 
 import com.google.inject.Inject;
 
@@ -100,7 +102,7 @@ public static void initialize(final ILayoutMetaDataProvider... providers) {
     * for your model using a {@link SprottyLayoutConfigurator}.
     */
    @Override
-   public void layout() {
+   public void layout(final Optional<LayoutOperation> operation) {
       if (modelState.getRoot() instanceof GGraph) {
          layout((GGraph) modelState.getRoot(), null);
       }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/features/core/model/ModelSubmissionHandler.java

@@ -154,7 +154,7 @@ public List<Action> submitModel() {
    public List<Action> submitModelDirectly(final String reason) {
       GModelRoot gModel = modelState.getRoot();
       if (diagramConfiguration.getLayoutKind() == ServerLayoutKind.AUTOMATIC && layoutEngine.isPresent()) {
-         layoutEngine.get().layout();
+         layoutEngine.get().layout(Optional.empty());
       }
       Action modelAction = this.requestModelAction.isPresent()
          ? createSetModeAction(gModel)

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/layout/LayoutEngine.java

@@ -15,12 +15,18 @@
  ******************************************************************************/
 package org.eclipse.glsp.server.layout;
 
+import java.util.Optional;
+
+import org.eclipse.glsp.server.operations.LayoutOperation;
+
 /**
  * A layout engine is able to compute layout information for a model.
  */
 public interface LayoutEngine {
    /**
     * Compute a layout for the model state and modify the model accordingly.
+    *
+    * @param layoutOperation The optional operation that triggered this layout.
     */
-   void layout();
+   void layout(Optional<LayoutOperation> layoutOperation);
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/operations/LayoutOperation.java

@@ -17,13 +17,21 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
+
+import org.eclipse.glsp.graph.GBounds;
+import org.eclipse.glsp.server.types.Viewport;
 
 public class LayoutOperation extends Operation {
 
    public static final String KIND = "layout";
 
    private List<String> elementIds;
 
+   private Optional<GBounds> canvasBounds;
+
+   private Optional<Viewport> viewport;
+
    public LayoutOperation() {
       this(new ArrayList<>());
    }
@@ -33,8 +41,22 @@ public LayoutOperation(final List<String> elementIds) {
       this.elementIds = elementIds;
    }
 
+   public LayoutOperation(final List<String> elementIds, final GBounds canvasBounds, final Viewport viewport) {
+      this(elementIds);
+      this.canvasBounds = Optional.ofNullable(canvasBounds);
+      this.viewport = Optional.ofNullable(viewport);
+   }
+
    public List<String> getElementIds() { return elementIds; }
 
    public void setElementIds(final List<String> elementIds) { this.elementIds = elementIds; }
 
+   public Optional<GBounds> getCanvasBounds() { return canvasBounds; }
+
+   public void setCanvasBounds(final GBounds canvasBounds) { this.canvasBounds = Optional.ofNullable(canvasBounds); }
+
+   public Optional<Viewport> getViewport() { return viewport; }
+
+   public void setViewport(final Viewport viewport) { this.viewport = Optional.ofNullable(viewport); }
+
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/operations/LayoutOperationHandler.java

@@ -42,7 +42,9 @@ public class LayoutOperationHandler extends BasicOperationHandler<LayoutOperatio
    public Optional<Command> createCommand(final LayoutOperation operation) {
       return layoutEngine.isEmpty() || diagramConfiguration.getLayoutKind() != ServerLayoutKind.MANUAL
          ? doNothing()
-         : Optional.of(new GModelRecordingCommand(modelState.getRoot(), getLabel(), () -> layoutEngine.get().layout()));
+         : Optional.of(
+            new GModelRecordingCommand(modelState.getRoot(), getLabel(),
+               () -> layoutEngine.get().layout(Optional.of(operation))));
    }
 
 }

plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/types/Viewport.java

@@ -36,9 +36,19 @@ public Viewport(final double x, final double y, final double zoom) {
 
    public double getZoom() { return zoom; }
 
+   @Override
+   public String toString() {
+      StringBuilder result = new StringBuilder(getClass().getSimpleName());
+      result.append(" [scroll: ");
+      result.append(scroll);
+      result.append(", zoom: ");
+      result.append(zoom);
+      result.append(']');
+      return result.toString();
+   }
+
    @SuppressWarnings("checkstyle:VisibilityModifier")
    class Point {
-
       final double x;
       final double y;
 
@@ -48,6 +58,17 @@ class Point {
          this.y = y;
       }
 
+      @Override
+      public String toString() {
+         StringBuilder result = new StringBuilder(getClass().getSimpleName());
+         result.append(" [x: ");
+         result.append(x);
+         result.append(", y: ");
+         result.append(y);
+         result.append(']');
+         return result.toString();
+      }
+
    }
 
 }