Refactored margin handlers (#8292)

Only layouts actually supporting margins now implement MarginHandler
CssLayout should be simplified before 7.0.0 so margin support was removed. GridLayout, VerticalLayout and HorizontalLayout were the only other layouts which actually supported margin.
MarginInfo is now passed directly in the state.

6 files changed, 79 insertions, 120 deletions

diff --git a/server/src/com/vaadin/ui/AbstractLayout.java b/server/src/com/vaadin/ui/AbstractLayout.java
index c26812f3fc..dd1d5eab12 100644
--- a/server/src/com/vaadin/ui/AbstractLayout.java
+++ b/server/src/com/vaadin/ui/AbstractLayout.java
@@ -17,7 +17,6 @@
 package com.vaadin.ui;
 
 import com.vaadin.shared.ui.AbstractLayoutState;
-import com.vaadin.ui.Layout.MarginHandler;
 
 /**
  * An abstract class that defines default implementation for the {@link Layout}
@@ -26,62 +25,12 @@ import com.vaadin.ui.Layout.MarginHandler;
  * @author Vaadin Ltd.
  * @since 5.0
  */
-@SuppressWarnings("serial")
 public abstract class AbstractLayout extends AbstractComponentContainer
-        implements Layout, MarginHandler {
-
-    protected MarginInfo margins = new MarginInfo(false);
+        implements Layout {
 
     @Override
     public AbstractLayoutState getState() {
         return (AbstractLayoutState) super.getState();
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see com.vaadin.ui.Layout#setMargin(boolean)
-     */
-    @Override
-    public void setMargin(boolean enabled) {
-        margins.setMargins(enabled);
-        getState().setMarginsBitmask(margins.getBitMask());
-        requestRepaint();
-    }
-
-    /*
-     * (non-Javadoc)
-     * 
-     * @see com.vaadin.ui.Layout.MarginHandler#getMargin()
-     */
-    @Override
-    public MarginInfo getMargin() {
-        return margins;
-    }
-
-    /*
-     * (non-Javadoc)
-     * 
-     * @see com.vaadin.ui.Layout.MarginHandler#setMargin(MarginInfo)
-     */
-    @Override
-    public void setMargin(MarginInfo marginInfo) {
-        margins.setMargins(marginInfo);
-        getState().setMarginsBitmask(margins.getBitMask());
-        requestRepaint();
-    }
-
-    /*
-     * (non-Javadoc)
-     * 
-     * @see com.vaadin.ui.Layout#setMargin(boolean, boolean, boolean, boolean)
-     */
-    @Override
-    public void setMargin(boolean topEnabled, boolean rightEnabled,
-            boolean bottomEnabled, boolean leftEnabled) {
-        margins.setMargins(topEnabled, rightEnabled, bottomEnabled, leftEnabled);
-        getState().setMarginsBitmask(margins.getBitMask());
-        requestRepaint();
-    }
-
 }
diff --git a/server/src/com/vaadin/ui/AbstractOrderedLayout.java b/server/src/com/vaadin/ui/AbstractOrderedLayout.java
index a7cc780414..3ac4e76bdb 100644
--- a/server/src/com/vaadin/ui/AbstractOrderedLayout.java
+++ b/server/src/com/vaadin/ui/AbstractOrderedLayout.java
@@ -25,6 +25,7 @@ import com.vaadin.event.LayoutEvents.LayoutClickNotifier;
 import com.vaadin.shared.Connector;
 import com.vaadin.shared.EventId;
 import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.MarginInfo;
 import com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutServerRpc;
 import com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutState;
 import com.vaadin.shared.ui.orderedlayout.AbstractOrderedLayoutState.ChildComponentData;
@@ -32,7 +33,8 @@ import com.vaadin.terminal.Sizeable;
 
 @SuppressWarnings("serial")
 public abstract class AbstractOrderedLayout extends AbstractLayout implements
-        Layout.AlignmentHandler, Layout.SpacingHandler, LayoutClickNotifier {
+        Layout.AlignmentHandler, Layout.SpacingHandler, LayoutClickNotifier,
+        Layout.MarginHandler {
 
     private AbstractOrderedLayoutServerRpc rpc = new AbstractOrderedLayoutServerRpc() {
 
@@ -392,4 +394,26 @@ public abstract class AbstractOrderedLayout extends AbstractLayout implements
         return components.get(index);
     }
 
+    public void setMargin(boolean enabled) {
+        setMargin(new MarginInfo(enabled));
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.Layout.MarginHandler#getMargin()
+     */
+    public MarginInfo getMargin() {
+        return new MarginInfo(getState().getMarginsBitmask());
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.Layout.MarginHandler#setMargin(MarginInfo)
+     */
+    public void setMargin(MarginInfo marginInfo) {
+        getState().setMarginsBitmask(marginInfo.getBitMask());
+        requestRepaint();
+    }
 }
diff --git a/server/src/com/vaadin/ui/CustomLayout.java b/server/src/com/vaadin/ui/CustomLayout.java
index 2da443bfa5..d47b2f92b3 100644
--- a/server/src/com/vaadin/ui/CustomLayout.java
+++ b/server/src/com/vaadin/ui/CustomLayout.java
@@ -291,33 +291,6 @@ public class CustomLayout extends AbstractLayout implements Vaadin6Component {
         requestRepaint();
     }
 
-    /**
-     * Although most layouts support margins, CustomLayout does not. The
-     * behaviour of this layout is determined almost completely by the actual
-     * template.
-     * 
-     * @throws UnsupportedOperationException
-     */
-    @Override
-    public void setMargin(boolean enabled) {
-        throw new UnsupportedOperationException(
-                "CustomLayout does not support margins.");
-    }
-
-    /**
-     * Although most layouts support margins, CustomLayout does not. The
-     * behaviour of this layout is determined almost completely by the actual
-     * template.
-     * 
-     * @throws UnsupportedOperationException
-     */
-    @Override
-    public void setMargin(boolean topEnabled, boolean rightEnabled,
-            boolean bottomEnabled, boolean leftEnabled) {
-        throw new UnsupportedOperationException(
-                "CustomLayout does not support margins.");
-    }
-
     @Override
     public void changeVariables(Object source, Map<String, Object> variables) {
         // Nothing to see here
diff --git a/server/src/com/vaadin/ui/FormLayout.java b/server/src/com/vaadin/ui/FormLayout.java
index c4ba4665ea..15ea478597 100644
--- a/server/src/com/vaadin/ui/FormLayout.java
+++ b/server/src/com/vaadin/ui/FormLayout.java
@@ -16,6 +16,8 @@
 
 package com.vaadin.ui;
 
+import com.vaadin.shared.ui.MarginInfo;
+
 /**
  * FormLayout is used by {@link Form} to layout fields. It may also be used
  * separately without {@link Form}.
@@ -36,7 +38,7 @@ public class FormLayout extends AbstractOrderedLayout {
     public FormLayout() {
         super();
         setSpacing(true);
-        setMargin(true, false, true, false);
+        setMargin(new MarginInfo(true, false, true, false));
         setWidth(100, UNITS_PERCENTAGE);
     }
 
diff --git a/server/src/com/vaadin/ui/GridLayout.java b/server/src/com/vaadin/ui/GridLayout.java
index 5a748c04f6..b31ab82741 100644
--- a/server/src/com/vaadin/ui/GridLayout.java
+++ b/server/src/com/vaadin/ui/GridLayout.java
@@ -30,6 +30,7 @@ import com.vaadin.event.LayoutEvents.LayoutClickNotifier;
 import com.vaadin.shared.Connector;
 import com.vaadin.shared.EventId;
 import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.MarginInfo;
 import com.vaadin.shared.ui.gridlayout.GridLayoutServerRpc;
 import com.vaadin.shared.ui.gridlayout.GridLayoutState;
 import com.vaadin.terminal.LegacyPaint;
@@ -63,8 +64,8 @@ import com.vaadin.terminal.Vaadin6Component;
  */
 @SuppressWarnings("serial")
 public class GridLayout extends AbstractLayout implements
-        Layout.AlignmentHandler, Layout.SpacingHandler, LayoutClickNotifier,
-        Vaadin6Component {
+        Layout.AlignmentHandler, Layout.SpacingHandler, Layout.MarginHandler,
+        LayoutClickNotifier, Vaadin6Component {
 
     private GridLayoutServerRpc rpc = new GridLayoutServerRpc() {
 
@@ -1416,4 +1417,37 @@ public class GridLayout extends AbstractLayout implements
                 LayoutClickEvent.class, listener);
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.Layout.MarginHandler#setMargin(boolean)
+     */
+    @Override
+    public void setMargin(boolean enabled) {
+        setMargin(new MarginInfo(enabled));
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.Layout.MarginHandler#setMargin(com.vaadin.shared.ui.MarginInfo
+     * )
+     */
+    @Override
+    public void setMargin(MarginInfo marginInfo) {
+        getState().setMarginsBitmask(marginInfo.getBitMask());
+        requestRepaint();
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.Layout.MarginHandler#getMargin()
+     */
+    @Override
+    public MarginInfo getMargin() {
+        return new MarginInfo(getState().getMarginsBitmask());
+    }
+
 }
diff --git a/server/src/com/vaadin/ui/Layout.java b/server/src/com/vaadin/ui/Layout.java
index 6a95d23f8c..9c7cd2b477 100644
--- a/server/src/com/vaadin/ui/Layout.java
+++ b/server/src/com/vaadin/ui/Layout.java
@@ -18,8 +18,8 @@ package com.vaadin.ui;
 
 import java.io.Serializable;
 
-import com.vaadin.shared.ui.VMarginInfo;
 import com.vaadin.shared.ui.AlignmentInfo.Bits;
+import com.vaadin.shared.ui.MarginInfo;
 
 /**
  * Extension to the {@link ComponentContainer} interface which adds the
@@ -33,30 +33,6 @@ import com.vaadin.shared.ui.AlignmentInfo.Bits;
 public interface Layout extends ComponentContainer, Serializable {
 
     /**
-     * Enable layout margins. Affects all four sides of the layout. This will
-     * tell the client-side implementation to leave extra space around the
-     * layout. The client-side implementation decides the actual amount, and it
-     * can vary between themes.
-     * 
-     * @param enabled
-     */
-    public void setMargin(boolean enabled);
-
-    /**
-     * Enable specific layout margins. This will tell the client-side
-     * implementation to leave extra space around the layout in specified edges,
-     * clockwise from top (top, right, bottom, left). The client-side
-     * implementation decides the actual amount, and it can vary between themes.
-     * 
-     * @param top
-     * @param right
-     * @param bottom
-     * @param left
-     */
-    public void setMargin(boolean top, boolean right, boolean bottom,
-            boolean left);
-
-    /**
      * AlignmentHandler is most commonly an advanced {@link Layout} that can
      * align its components.
      */
@@ -197,6 +173,19 @@ public interface Layout extends ComponentContainer, Serializable {
      * its components).
      */
     public interface MarginHandler extends Serializable {
+
+        /**
+         * Enable layout margins. Affects all four sides of the layout. This
+         * will tell the client-side implementation to leave extra space around
+         * the layout. The client-side implementation decides the actual amount,
+         * and it can vary between themes.
+         * 
+         * @param enabled
+         *            true if margins should be enabled on all sides, false to
+         *            disable all margins
+         */
+        public void setMargin(boolean enabled);
+
         /**
          * Enable margins for this layout.
          * 
@@ -224,16 +213,4 @@ public interface Layout extends ComponentContainer, Serializable {
         public MarginInfo getMargin();
     }
 
-    @SuppressWarnings("serial")
-    public static class MarginInfo extends VMarginInfo implements Serializable {
-
-        public MarginInfo(boolean enabled) {
-            super(enabled, enabled, enabled, enabled);
-        }
-
-        public MarginInfo(boolean top, boolean right, boolean bottom,
-                boolean left) {
-            super(top, right, bottom, left);
-        }
-    }
 }