Adds animate, move and resize functionality

Author: alump

README.md

@@ -60,6 +60,13 @@ Official releases of this add-on are available at Vaadin Directory. For Maven in
 
 ## Release notes
 
+### Version 0.3.0 (2016-05-18)
+- Possibility to move and resize already added children
+- Adds animate option to allow nice transitions when moving children
+- gridstack.js updated to 0.2.5
+- Deprecated API removed
+- Fix error in getComponent method with coordinates (could have returned wrong components)
+
 ### Version 0.2.1 (2015-12-23)
 - Add missing API to define cell height, min width and vertical margins
 - API to set wrappers un-scrollable

gridstack-addon/assembly/assembly.xml

@@ -20,6 +20,8 @@
 			<directory>..</directory>
 			<includes>
 				<include>LICENSE.txt</include>
+				<include>GRIDSTACK_LICENSE.txt</include>
+				<include>LODASH_LICENSE.txt</include>
 				<include>README.md</include>
 			</includes>
 		</fileSet>

gridstack-addon/pom.xml

@@ -5,12 +5,12 @@
 	<groupId>org.vaadin.alump.gridstack</groupId>
 	<artifactId>gridstack-addon</artifactId>
 	<packaging>bundle</packaging>
-	<version>0.2.1</version>
+	<version>0.3.0</version>
 	<name>GridStack Add-on</name>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-		<vaadin.version>7.5.10</vaadin.version>
+		<vaadin.version>7.6.6</vaadin.version>
 		<vaadin.plugin.version>${vaadin.version}</vaadin.plugin.version>
 
 		<!-- ZIP Manifest fields -->

gridstack-addon/src/main/java/org/vaadin/alump/gridstack/GridStackCoordinates.java

@@ -33,6 +33,10 @@ public GridStackCoordinates(int x, int y, int width, int height) {
         this.height = height;
     }
 
+    public boolean isXAndY(int x, int y) {
+        return this.x == x && this.y == y;
+    }
+
     public int getX() {
         return x;
     }

gridstack-addon/src/main/java/org/vaadin/alump/gridstack/GridStackLayout.java

@@ -45,6 +45,11 @@ public class GridStackLayout extends AbstractLayout implements LayoutEvents.Layo
 
     private final List<GridStackMoveEvent.GridStackMoveListener> moveListeners = new ArrayList<GridStackMoveEvent.GridStackMoveListener>();
 
+    /**
+     * Use this as x or y coordinate if you want to leave slot selection of component to client side
+     */
+    public final static int CLIENT_SIDE_SELECTS = -1;
+
     private GridStackServerRpc serverRpc = new GridStackServerRpc() {
 
         @Override
@@ -130,7 +135,7 @@ protected GridStackLayoutState getState(boolean markDirty) {
      */
     @Override
     public void addComponent(Component component) {
-        addComponent(component, -1, -1);
+        addComponent(component, CLIENT_SIDE_SELECTS, CLIENT_SIDE_SELECTS);
     }
 
     /**
@@ -141,7 +146,7 @@ public void addComponent(Component component) {
      *                      is or contains any active components (buttons etc..)
      */
     public void addComponent(Component component, boolean useDragHandle) {
-        addComponent(component, -1, -1, useDragHandle);
+        addComponent(component, CLIENT_SIDE_SELECTS, CLIENT_SIDE_SELECTS, useDragHandle);
     }
 
     /**
@@ -203,6 +208,66 @@ public void addComponent(Component component, int x, int y, int width, int heigh
         getState().childOptions.put(component, info);
     }
 
+    /**
+     * Reset component's position and allow child side define new position for it.
+     * @param component Child component which position is reset
+     */
+    public void resetComponentPosition(Component component) {
+        moveComponent(component, CLIENT_SIDE_SELECTS, CLIENT_SIDE_SELECTS);
+    }
+
+    /**
+     * Move given child component
+     * @param component Child component moved and/or resized
+     * @param x When defined component's X value is updated, if null old value is kept
+     * @param y When defined component's Y value is updated, if null old value is kept
+     * @throws IllegalArgumentException If given value are invalid (eg. component is not child of this layout)
+     */
+    public void moveComponent(Component component, Integer x, Integer y) throws IllegalArgumentException {
+        moveAndResizeComponent(component, x, y, null, null);
+    }
+
+    /**
+     * Move given child component
+     * @param component Child component moved and/or resized
+     * @param width When defined component's width is updated, if null old value is kept
+     * @param height When defined component's height is updated, if null old value is kept
+     * @throws IllegalArgumentException If given value are invalid (eg. component is not child of this layout)
+     */
+    public void resizeComponent(Component component, Integer width, Integer height) throws IllegalArgumentException {
+        moveAndResizeComponent(component, null, null, width, height);
+    }
+
+    /**
+     * Move and/or resize given child component
+     * @param component Child component moved and/or resized
+     * @param x When defined component's X value is updated, if null old value is kept
+     * @param y When defined component's Y value is updated, if null old value is kept
+     * @param width When defined component's width is updated, if null old value is kept
+     * @param height When defined component's height is updated, if null old value is kept
+     * @throws IllegalArgumentException If given value are invalid (eg. component is not child of this layout)
+     */
+    public void moveAndResizeComponent(Component component, Integer x, Integer y, Integer width, Integer height)
+            throws IllegalArgumentException {
+
+        GridStackChildOptions info = getState().childOptions.get(component);
+        if(info == null) {
+            throw new IllegalArgumentException("Given component is not child of GridStackLayout");
+        }
+        if(x != null) {
+            info.x = x;
+        }
+        if(y != null) {
+            info.y = y;
+        }
+        if(width != null) {
+            info.width = width;
+        }
+        if(height != null) {
+            info.height = height;
+        }
+    }
+
     /**
      * Get component with given slot coordinate
      * @param x Slot's X coordinate
@@ -224,7 +289,7 @@ public Component getComponent(int x, int y, boolean acceptInsideHit) {
         for(Connector connector : getState().childOptions.keySet()) {
             GridStackChildOptions info = getState().childOptions.get(connector);
             if(acceptInsideHit) {
-                if(x >= info.x && y < (info.x + info.width) && y >= info.y && y < (info.y + info.width)) {
+                if(x >= info.x && x < (info.x + info.width) && y >= info.y && y < (info.y + info.width)) {
                     return (Component) connector;
                 }
             } else {
@@ -310,19 +375,6 @@ public void removeListener(LayoutEvents.LayoutClickListener layoutClickListener)
         removeLayoutClickListener(layoutClickListener);
     }
 
-    /**
-     * This call is deprecated and will be removed in 0.3.0. Please use setVerticalMargin, setCellHeight, setMinWidth
-     * and setStaticGrid methods.
-     * @return Access to gridstack.js's grid options
-     */
-    @Deprecated
-    public GridStackOptions getOptions() {
-        if(initialClientResponseSent) {
-            throw new IllegalStateException("Options can not be modified after initial response has been sent to client");
-        }
-        return getState().gridStackOptions;
-    }
-
     /**
      * Add listener for component move events
      * @param listener Listener added
@@ -421,14 +473,32 @@ protected GridStackChildOptions getComponentOptions(Component child, boolean mod
         return opt;
     }
 
+    /**
+     * Define if layout is animated when child components are moved
+     * @param animate true to animate, false to not animate
+     * @return This GridStackLayout for command chaining
+     */
+    public GridStackLayout setAnimate(boolean animate) {
+        getState().gridStackOptions.animate = animate;
+        return this;
+    }
+
+    /**
+     * Check if layout is animated
+     * @return true if animated, false if not
+     */
+    public boolean isAnimate() {
+        return getState(false).gridStackOptions.animate;
+    }
+
     /**
      * Set layout static (no dragging of resizing) or dynamic (dragging and resizing allowed)
      * @param staticGrid true to set static (no dragging of resizing), false to set dynamic (dragging and resizing
      *                   allowed)
      * @return This GridStackLayout for command chaining
      */
     public GridStackLayout setStaticGrid(boolean staticGrid) {
-        getState(true).gridStackOptions.staticGrid = staticGrid;
+        getState().gridStackOptions.staticGrid = staticGrid;
         return this;
     }
 
@@ -528,4 +598,49 @@ public boolean isWrapperScrolling(Component child) {
         return getComponentOptions(child, false).disableScrolling;
     }
 
+    /**
+     * Check if given area is empty. Remember that any client side defined positioning not yet reported back to
+     * server side will be unknown and so can result work results.
+     * @param x Left edge coordinate of area
+     * @param x Top edge coordinate of area
+     * @param width Width of area in slots
+     * @param height Height of area in slots
+     * @throws IllegalArgumentException If invalid values given
+     */
+    public boolean isAreaEmpty(int x, int y, int width, int height) throws IllegalArgumentException {
+        return isAreaEmpty(new GridStackCoordinates(x, y, width, height));
+    }
+
+    /**
+     * Check if given area is empty. Remember that any client side defined positioning not yet reported back to
+     * server side will be unknown and so can result work results.
+     * @param coordinates Coordinate area checked (x, y, width, height)
+     * @throws IllegalArgumentException If invalid values given
+     */
+    public boolean isAreaEmpty(GridStackCoordinates coordinates) throws IllegalArgumentException {
+        if(coordinates.getX() < 0) {
+            throw new IllegalArgumentException("X can not be negative");
+        }
+        if(coordinates.getY() < 0) {
+            throw new IllegalArgumentException("Y can not be negative");
+        }
+        if(coordinates.getWidth() <= 0) {
+            throw new IllegalArgumentException("Width most be larger than zero");
+        }
+        if(coordinates.getHeight() <= 0) {
+            throw new IllegalArgumentException("Height most be larger than zero");
+        }
+
+        for(int dx = 0; dx < coordinates.getWidth(); ++dx) {
+            for(int dy = 0; dy < coordinates.getHeight(); ++dy) {
+                Component occupant = getComponent(coordinates.getX() + dx, coordinates.getY() + dy, true);
+                if(occupant != null) {
+                    return false;
+                }
+            }
+        }
+
+        return true;
+    }
+
 }

gridstack-addon/src/main/java/org/vaadin/alump/gridstack/client/GridStackLayoutConnector.java

@@ -41,7 +41,7 @@
 @Connect(org.vaadin.alump.gridstack.GridStackLayout.class)
 public class GridStackLayoutConnector extends AbstractLayoutConnector {
 
-    private final static Logger LOGGER = Logger.getLogger(GridStackLayoutConnector.class.getName());
+    private transient final static Logger LOGGER = Logger.getLogger(GridStackLayoutConnector.class.getName());
 
     @Override
     public void init() {
@@ -129,7 +129,7 @@ public void updateCaption(ComponentConnector componentConnector) {
         //ignore for now
     }
 
-    private final LayoutClickEventHandler clickEventHandler = new LayoutClickEventHandler(this) {
+    private transient final LayoutClickEventHandler clickEventHandler = new LayoutClickEventHandler(this) {
 
         @Override
         protected ComponentConnector getChildComponent(Element element) {