Ticket #1968: pwa-centering-deni.patch

modules/org.sophie2.main.app.commons/src/main/java/org/sophie2/main/app/commons/book/BaseBookDocView.java

@@ -9 +9 @@
 import org.sophie2.base.commons.gui.CustomScrollPane;
 import org.sophie2.base.commons.util.ImageUtil;
 import org.sophie2.base.commons.util.ImmImage;
+import org.sophie2.base.commons.util.position.ImmSize;
 import org.sophie2.base.layout.model.DocView;
 import org.sophie2.base.media.AudioChunk;
 import org.sophie2.base.media.MediaComposite;
@@ -231 +232 @@
                                 modelSwing.removeAll();
 
                                 modelSwing.setLayout(new BorderLayout());
-
+                                
+                                ImmSize scrollPaneSize = null; 
+                                
                                 if (bookView().get().getViewOptions().isShowViewControls()) {
                                         modelSwing.add(viewOptionsScrollPane().get().swingComponent(), BorderLayout.NORTH);
                                         modelSwing.add(workAreaPane().get(), BorderLayout.CENTER);
+                        
+//                                      scrollPaneSize = new ImmSize(workAreaPane().get().getSize());
+//                                      System.out.println(scrollPaneSize);
+                                        workArea().get().sceneVisual().get().scrollPane().set(workAreaPane().get());            
                                 } else {
                                         modelSwing.add(workArea().get().swingComponent().get());
                                 }

modules/org.sophie2.base.layout/src/test/java/org/sophie2/base/layout/model/LayoutDemo.java

@@ +1 @@
+package org.sophie2.base.layout.model;
+
+import java.awt.BorderLayout;
+
+import javax.swing.JDesktopPane;
+import javax.swing.JFrame;
+import javax.swing.JInternalFrame;
+import javax.swing.JLayeredPane;
+
+/**
+ * Demo for demonstrating the usage of {@link CustomLayout}.
+ * @author tanya
+ */
+public class LayoutDemo {
+
+        /**
+         * Constructor that creates {@link JFrame}, adds a {@link JDesktopPane} with
+         * {@link CustomLayout} and set different layers to be with different
+         * layouts.
+         */
+        public LayoutDemo() {
+                
+                JFrame frame = new JFrame();
+                frame.setSize(300, 300);
+                frame.setVisible(true);
+                
+                JDesktopPane pane = new JDesktopPane();
+                
+                frame.setContentPane(pane);
+                pane.setLayout(new CustomLayout(new BorderLayout()));
+                
+                JInternalFrame frame1 = new JInternalFrame();
+                frame1.setLocation(10, 10);
+                frame1.setSize(90, 90);
+                frame1.setVisible(true);
+                
+                pane.setLayer(frame1, JLayeredPane.DEFAULT_LAYER);
+                
+                pane.add(frame1, BorderLayout.CENTER);
+                
+                JInternalFrame frame2 = new JInternalFrame();
+                frame2.setLocation(110, 110);
+                frame2.setSize(90, 90);
+                frame2.setVisible(true);
+                
+                pane.setLayer(frame2, JLayeredPane.PALETTE_LAYER);
+                
+                pane.add(frame2, CustomLayout.CUSTOM);
+        }
+        
+        /**
+         * The main method.
+         * @param args
+         */
+        public static void main(String args[]) {
+                new LayoutDemo();
+        }
+}
+

modules/org.sophie2.main.app.commons/src/main/java/org/sophie2/main/app/commons/app/AppMainWindow.java

@@ -14 +14 @@
 import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.halos.HaloMenu;
 import org.sophie2.base.layout.impl.DefaultMainWindow;
+import org.sophie2.base.layout.model.CustomLayout;
 import org.sophie2.base.layout.model.DocView;
 import org.sophie2.base.media.MediaComposite;
 import org.sophie2.base.media.MediaUtil;
@@ -210 +211 @@
                                 for (HaloMenu hm : haloMenus().get()) {
                                         if (hm.visible().get()) {
                                                 for (JComponent c : hm.swingComponents().get()) {
-
-                                                        res.add(c, JLayeredPane.PALETTE_LAYER);
+                                                        res.setLayer(c, JLayeredPane.PALETTE_LAYER); 
+                                                        res.add(c, CustomLayout.CUSTOM); 
                                                 }
                                         }
                                 }

modules/org.sophie2.base.scene/src/test/java/org/sophie2/base/scene/SceneDemo.java

@@ -7 +7 @@
 import javax.swing.JComponent;
 import javax.swing.JFrame;
 import javax.swing.JPanel;
+import javax.swing.JScrollPane;
 import javax.swing.JTextPane;
 import javax.swing.SwingUtilities;
 
@@ -469 +470 @@
                                         ImmRect.ZERO_RECT);
                 }
 
-                public RwProp<ImmRect> minimalViewRect() { 
-                        return getBean().makeValueProp("minimalViewRect", ImmRect.class, null); 
+                public RwProp<JScrollPane> scrollPane() {
+                        return getBean().makeValueProp("scrollPane", JScrollPane.class, null);
                 } 
-
-                public RwProp<ImmRect> actualViewRectCache() { 
-                        return getBean().makeValueProp("actualViewRectCache", ImmRect.class, null); 
-                } 
         }
 
         /**

modules/org.sophie2.base.scene/src/main/java/org/sophie2/base/scene/interfaces/Scene.java

@@ -1 +1 @@
 package org.sophie2.base.scene.interfaces;
 
 import org.sophie2.base.commons.util.ImmColor;
+import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.scene.helpers.SceneHelper;
 import org.sophie2.core.prolib.impl.BaseProObject;
 import org.sophie2.core.prolib.interfaces.Prop;
@@ -81 +82 @@
                 return getBean().makeValueProp("mouseOverElement", SceneElement.class,
                                 null);
         }
+        
+        /** 
+         * The rectangle over which the actual view rectangle will be centered. 
+         *  
+         * @return The property 
+         */ 
+        public abstract RwProp<ImmRect> centeringRect();
 }
+ No newline at end of file

modules/org.sophie2.base.scene/src/main/java/org/sophie2/base/scene/impl/BaseScene.java

@@ -1 +1 @@
 package org.sophie2.base.scene.impl;
 
 import org.sophie2.base.commons.util.ImmColor;
+import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.scene.interfaces.Scene;
 import org.sophie2.base.scene.interfaces.SceneElement;
 import org.sophie2.core.prolib.impl.ResourceProperty;
@@ -65 +66 @@
                 //Do nothing            
         }
 
+        @Override
+        public RwProp<ImmRect> centeringRect() {
+                return getBean().makeValueProp("centeringRect", ImmRect.class, ImmRect.ZERO_RECT);
+        }
+
 }

modules/org.sophie2.main.scene.simple/src/main/java/org/sophie2/main/scene/simple/SimpleSceneVisual.java

@@ -7 +7 @@
 import javax.swing.JPanel;
 
 import org.sophie2.base.commons.util.position.ImmRect;
+import org.sophie2.base.commons.util.position.ImmSize;
 import org.sophie2.base.scene.BaseSceneVisual;
 import org.sophie2.base.scene.SceneVisual;
 import org.sophie2.base.scene.helpers.SceneHelper;
@@ -51 +52 @@
                         SophieLog.trace("paintComponent: bounds=" + getBounds());
                         SophieLog.trace("paintComponent: swing=" + toString());
                         SophieLog.trace("paintComponent: parent=" + getParent());
+                        
+                        Graphics2D g2d = (Graphics2D) graphics.create();
+                
+                        if (scrollPane().get() != null) {
+                                viewportSize().set(new ImmSize(scrollPane().get().getSize()));
+                        }
 
-                        Graphics2D g2d = (Graphics2D) graphics.create();
                         ImmRect visRect = actualViewRect().get();
 
                         SceneHelper.paint(g2d, visRect, scene().get());

modules/org.sophie2.base.scene/src/main/java/org/sophie2/base/scene/BaseSceneVisual.java

@@ -4 +4 @@
 import java.util.List;
 
 import javax.swing.JComponent;
+import javax.swing.JScrollPane;
 
 import org.sophie2.base.commons.util.OSUtil;
 import org.sophie2.base.commons.util.position.ImmRect;
+import org.sophie2.base.commons.util.position.ImmSize;
+import org.sophie2.base.commons.util.position.Position;
 import org.sophie2.base.dnd.SophieDragDropHandler;
 import org.sophie2.base.scene.helpers.ElementHelper;
 import org.sophie2.base.scene.helpers.SceneHelper;
@@ -78 +81 @@
                 return getBean().makeValueProp("wantedViewRect", ImmRect.class, null);
         }
 
-        public RwProp<ImmRect> minimalViewRect() { 
-                return getBean().makeValueProp("minimalViewRect", ImmRect.class, null); 
-        } 
-
-        public RwProp<ImmRect> actualViewRectCache() { 
-                return getBean().makeValueProp("actualViewRectCache", ImmRect.class, null); 
-        } 
-
         @Own
         public RwProp<Scene> scene() {
                 return getBean().makeValueProp("scene", Scene.class);
@@ -96 +91 @@
                         @Override
                         protected JComponent create() {
                                 JComponent res = createSwingComponent();
+                                
+                                // (deni) might be necessary to 
+                                // res.setLayout(null); 
+                                
                                 SwingEventAdapter.registerComponent(res,
                                                 BaseSceneVisual.this, null, res);
 
@@ -111 +110 @@
                         }
 
                         @Override
-                        protected void setup(JComponent res) {
+                        protected void setup(JComponent res) {                          
                                 Dimension size = actualViewRect().get().getSize().toDimension();
                                 res.setSize(size);
                                 res.setPreferredSize(size);
@@ -123 +122 @@
                         @Setup
                         protected void setupTooltip(JComponent res) {
                                 Scene scene = scene().get();
-                                if ( scene != null) {
+                                if (scene != null) {
                                         SceneElement overElement = scene.mouseOverElement().get();
                                         if (overElement != null) {
                                                 res.setToolTipText(overElement.tooltip().get());
@@ -163 +162 @@
          */
         protected static final ImmRect DEFAULT_VIEW_RECT =
                 new ImmRect(0, 0, 256, 256);
+        
+        
 
         public Prop<ImmRect> actualViewRect() {
                 class actualViewRect extends AutoProperty<ImmRect> {
@@ -182 +183 @@
                                                         bound.getY() - DEFAULT_PADDING_T, 
                                                         bound.getWidth() + DEFAULT_PADDING_R + DEFAULT_PADDING_L, 
                                                         bound.getHeight() + DEFAULT_PADDING_B + DEFAULT_PADDING_T);
+                                        
+                                        ImmRect centeringRect = scene().get().centeringRect().get(); 
+                                        
+                                        if (!centeringRect.equals(ImmRect.ZERO_RECT)) { 
+                                                ImmRect toUnite = new ImmRect(Position.CENTER, centeringRect.getPoint(Position.CENTER),
+                                                                viewportSize().get()); 
+                                                res = res.union(toUnite); 
+                                        } else { 
+                                                ImmRect toUnite = new ImmRect(res.getLocation(), viewportSize().get()); 
+                                                res = res.union(toUnite); 
+                                        }
+                                        
                                 } else {
                                         // can not determine...
-                                        // just make something...
+                                        // just do something...
                                         res = DEFAULT_VIEW_RECT;
                                 }
-
-                                // Center the actualRect on the minimalViewRect 
-                                // wantedViewRect is set by halo mouse tracking to limit the rect,  
-                                // so do nothing if wantedViewRect is not null 
-                                if (wantedViewRect().get() == null) { 
-                                        ImmRect myMinimalViewRect = minimalViewRect().get(); 
-                                        if (myMinimalViewRect != null) { 
-                                                float xOffset =
-                                                        Math.max((myMinimalViewRect.getWidth() - res.getWidth()) / 2, 0); 
-                                                float yOffset =
-                                                        Math.max((myMinimalViewRect.getHeight() - res.getHeight()) / 2, 0); 
-                                                res = new ImmRect(res.getX() - xOffset, 
-                                                                res.getY() - yOffset, 
-                                                                Math.max(res.getWidth(), myMinimalViewRect.getWidth()), 
-                                                                Math.max(res.getHeight(), myMinimalViewRect.getHeight())); 
-                                        } 
-
-                                        if (!res.equals(actualViewRectCache().get())) { 
-                                                actualViewRectCache().set(res); 
-                                        } 
+                                
+                                if (scrollPane().get() != null) {
+                                        // if there will be some scrollbars, 
+                                        // remove their width/height from the actualViewRect
+                                        
+                                        int hScrollHeight = scrollPane().get().getHorizontalScrollBar().getHeight();
+                                        int vScrollWidth = scrollPane().get().getVerticalScrollBar().getWidth();
+                                        
+                                        float width = res.getWidth();
+                                        float height = res.getHeight();                                 
+                                
+                                        if (height > viewportSize().get().getHeight()
+                                                        && width <= viewportSize().get().getWidth()) { 
+                                                width -= hScrollHeight;
+                                        }
+                                        
+                                        if (width > viewportSize().get().getWidth()
+                                                        && height <= viewportSize().get().getHeight()) {
+                                                height -= vScrollWidth;
+                                        }
+                                        
+                                        res = new ImmRect(res.getLocation(), new ImmSize(width, height));
                                 }
-
+                                
                                 assert res != null;
                                 return res;
                         }
@@ -229 +244 @@
         protected boolean computeVisible() {
                 return true;
         }
+        
+        public RwProp<JScrollPane> scrollPane() {
+                return getBean().makeValueProp("scrollPane", JScrollPane.class, null);
+        }
+        
+        /** 
+         * The size of the component where the scene is painted. This is the size which will be used for centering into it. 
+         *  
+         * @return The property. 
+         */ 
+        public RwProp<ImmSize> viewportSize() { 
+                return getBean().makeValueProp("viewportSize", ImmSize.class, ImmSize.ZERO); 
+        }
 }

modules/org.sophie2.base.layout/src/main/java/org/sophie2/base/layout/model/CustomLayout.java

@@ +1 @@
+package org.sophie2.base.layout.model;
+
+import java.awt.BorderLayout;
+import java.awt.Component;
+import java.awt.Container;
+import java.awt.Dimension;
+import java.awt.LayoutManager2;
+import java.io.Serializable;
+
+import javax.swing.JDesktopPane;
+import javax.swing.JLayeredPane;
+
+/**
+ * LayoutManager that supports adding of components with different layouts - null
+ * and some specific layout. An object is created with a specific
+ * {@link LayoutManager2}. When different components are added, they can be with
+ * constraint - CustomLayout.CUSTOM. This means that for laying out of these
+ * components will be used null layout. For all other components added, it will
+ * be used the given layout manager. This layout manager can be used for example
+ * for {@link JDesktopPane}. For example, components at
+ * {@link JLayeredPane#DEFAULT_LAYER} can be with {@link BorderLayout} and the
+ * components at {@link JLayeredPane#PALETTE_LAYER} to be with null layout.
+ * 
+ * @author tanya
+ */
+public class CustomLayout implements LayoutManager2, Serializable {
+
+        /**
+         * Used for serialization.
+         */
+        private static final long serialVersionUID = 810513263396699528L;
+
+        private LayoutManager2 layoutManager;
+        
+        /**
+         * The constraint for the objects which we want to be with null layout.
+         */
+        public static final String CUSTOM   = "Custom";
+        
+        /**
+         * Constructs an object with another layout manager. The components added
+         * will be with null layout or will be added according
+         * 
+         * @param manager
+         *            The manager which will be responsible for how the components
+         *            will be added and how will be laid out.
+         */
+        public CustomLayout(LayoutManager2 manager) {
+                this.layoutManager = manager;
+        }
+        
+        public void addLayoutComponent(Component comp, Object constraints) {
+                if (constraints != CUSTOM && this.layoutManager != null) {
+                        this.layoutManager.addLayoutComponent(comp, constraints);
+                }
+        }
+
+        public float getLayoutAlignmentX(Container target) {
+                if (this.layoutManager != null) {
+                        return this.layoutManager.getLayoutAlignmentX(target);
+                }
+
+                return 0f;
+        }
+
+        public float getLayoutAlignmentY(Container target) {
+                if (this.layoutManager != null) {
+                        return this.layoutManager.getLayoutAlignmentY(target);
+                }
+                
+                return 0f;
+        }
+
+        public void invalidateLayout(Container target) {
+                if (this.layoutManager != null) {
+                        this.layoutManager.invalidateLayout(target);
+                }
+        }
+
+        public Dimension maximumLayoutSize(Container target) {
+                if (this.layoutManager != null) {
+                        return this.layoutManager.maximumLayoutSize(target);
+                }
+                
+                return null;
+        }
+
+        public void addLayoutComponent(String name, Component comp) {
+                if (this.layoutManager != null) {
+                        this.layoutManager.addLayoutComponent(name, comp);
+                }
+        }
+
+        public void layoutContainer(Container parent) {
+                if (this.layoutManager != null) {
+                        this.layoutManager.layoutContainer(parent);
+                }
+        }
+
+        public Dimension minimumLayoutSize(Container parent) {
+                if (this.layoutManager != null) {
+                        return this.layoutManager.minimumLayoutSize(parent);
+                }
+                
+                return null;
+        }
+
+        public Dimension preferredLayoutSize(Container parent) {
+                if (this.layoutManager != null) {
+                        return this.layoutManager.preferredLayoutSize(parent);
+                }
+                
+                return null;
+        }
+
+        public void removeLayoutComponent(Component comp) {
+                if (this.layoutManager != null) {
+                        this.layoutManager.removeLayoutComponent(comp);
+                }
+        }
+}
+ No newline at end of file

modules/org.sophie2.main.app.commons/src/main/java/org/sophie2/main/app/commons/page/PageWorkArea.java

@@ -1 +1 @@
 package org.sophie2.main.app.commons.page;
 
+import java.awt.BorderLayout;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -10 +11 @@
 import org.sophie2.base.commons.util.ImmColor;
 import org.sophie2.base.commons.util.position.ImmArea;
 import org.sophie2.base.commons.util.position.ImmMatrix;
+import org.sophie2.base.commons.util.position.ImmPoint;
 import org.sophie2.base.commons.util.position.ImmRect;
+import org.sophie2.base.commons.util.position.ImmSize;
+import org.sophie2.base.layout.model.CustomLayout;
 import org.sophie2.base.model.book.PageH;
 import org.sophie2.base.scene.SceneVisual;
 import org.sophie2.base.scene.effects.ColorEffect;
@@ -189 +193 @@
                                         protected void setupScene() {
                                                 rootElement().set(rootSceneElement().get());
                                                 topEventSource().set(PageWorkArea.this);
+                                                
+                                                // TODO: maybe should check whether it is the desktop book
+//                                              AppMainWindow mainWindow = AppViewUtil.findMainWindow(PageWorkArea.this);
+//                                              DocView desktopDocument = mainWindow.desktopDocument().get()
+//                                              bookView().get().parent().get()
+//                                              ((BaseBookDocView)mainWindow.desktopDocument().get()).bookView()
+//                                              boolean isDesktopBook = !(bookView().get());  
+//                                              if (!isDesktopBook) {
+                                                // TODO: move in a separate setup
+                                                
+                                                ImmPoint pageLocation = ImmPoint.ZERO; 
+                                                float zoom = bookView().get().getViewOptions().getZoom(); 
+                                                ImmSize pageSize = bookView().get().model().get().getPageSize(); 
+                                                pageSize = new ImmSize(pageSize.getWidth() * zoom, pageSize.getHeight() * zoom); 
+                                                ImmRect centeringRect = new ImmRect(pageLocation, pageSize); 
+
+                                                centeringRect().set(centeringRect); 
+//                                              } 
                                         }
                                 };
                         }
@@ -238 +260 @@
 
                         @Override
                         protected void setup(JDesktopPane res) {
+                                
+                                res.setLayout(new CustomLayout(new BorderLayout())); 
                         
                                 JComponent sceneComp = sceneVisual().get().swingComponent().get();
 
@@ -245 +269 @@
                                 SophieLog.debug("PageWorkArea.layeredPage: sceneComp:" + sceneComp);
 
                                 res.removeAll();
-                                res.add(sceneComp, JLayeredPane.DEFAULT_LAYER);
+                                res.setLayer(sceneComp, JLayeredPane.DEFAULT_LAYER); 
+                                                
+                                res.add(sceneComp, BorderLayout.CENTER);
 
                                 res.revalidate();
                                 res.repaint();
                         }
 
-                        // TODO (r4) reimplement the page-work-area centering
                         @SuppressWarnings("unused")
                         @Setup
                         protected void setupActualSize(JLayeredPane res) {

modules/org.sophie2.base.scene/src/main/java/org/sophie2/base/scene/SceneVisual.java

@@ -1 +1 @@
 package org.sophie2.base.scene;
 
 import javax.swing.JComponent;
+import javax.swing.JScrollPane;
 
 import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.scene.interfaces.Scene;
@@ -33 +34 @@
          */
         RwProp<ImmRect> wantedViewRect();
 
-        /** 
-         * The smallest rectangle this scene should have. 
-         *  
-         * Use this to tell the scene it should be larger than its components, for example, 
-         * to fill out a window. 
-         *  
-         * @return property 
-         */ 
-        RwProp<ImmRect> minimalViewRect(); 
-
-        /** 
-         * Last known value of the actual view rect, so PageWorkArea can listen for changes 
-         *  
-         * Only set this value when it has actually changed 
-         *  
-         * @return property 
-         */ 
-        RwProp<ImmRect> actualViewRectCache(); 
         /**
          * The swing component displaying the scene.
          * 
@@ -73 +56 @@
          * @return property
          */
         Prop<ImmRect> actualViewRect();
+        
+        /** 
+         * The size of the component where the scene is painted. This is the size which will be used for centering into it. 
+         *  
+         * @return property. 
+         */ 
+        RwProp<JScrollPane> scrollPane();
 }

modules/org.sophie2.main.app.commons/src/main/java/org/sophie2/main/app/commons/app/DocumentsLogic.java

@@ -7 +7 @@
 import org.sophie2.base.model.resources.r4.access.ResourceAccess;
 import org.sophie2.base.model.resources.r4.changes.AutoAction;
 import org.sophie2.base.skins.Message;
-import org.sophie2.core.logging.SophieLog;
 import org.sophie2.core.modularity.SortKey;
 import org.sophie2.core.mvc.EventFilterBuilder;
 import org.sophie2.core.mvc.EventParams;
@@ -158 +157 @@
                         return true;
                 }
                 
-        },
-
-        
-        /**
-         * Handles resizing of the window by the user. Should center the page in the
-         * window.
-         */
-        @SortKey("fff-document-resize")
-        ON_RESIZE {
-
-                public void defineFilter(EventFilterBuilder filter) {
-                        filter.setEventId(DefaultDocView.EventIds.RESIZE);
-                        filter.setSourceClass(DefaultDocView.class);
-                }
-
-                public boolean handle(EventR3 event) {
-                        // FIXME (R4) Reimplement page centering. This might need to go down to the layout.
-                        SophieLog.warn("(R4) Reimplement page centering!");
-                        return false;
-                }
-
         };
         
         /**