Ticket #2311: template_visualization.patch

src/main/java/org/sophie2/main/app/layout/left/pages/PagePreviewPaletteLogic.java

@@ -1 +1 @@
 package org.sophie2.main.app.layout.left.pages;
 
+import java.awt.Point;
 import java.awt.Rectangle;
 
+import javax.swing.JList;
+
+import org.sophie2.base.commons.util.ImmList;
 import org.sophie2.base.commons.util.position.ImmArea;
 import org.sophie2.base.commons.util.position.ImmPoint;
 import org.sophie2.base.commons.util.position.ImmRect;
@@ -150 +154 @@
         },
         
         /**
-         * Handles pre-importing template data in drag'n'drop operation.
+         * Handles dropping a page template over the {@link PagePreviewPalette}.
+         * Applies the template to the page over which it was dropped or creates a new page
+         * if it was dropped over the blank space between page items.
          */
         ON_DND_PRE_IMPORT_TEMPLATE {
                 
@@ -169 +175 @@
                 }
 
                 public boolean handle(EventR3 event) {
- 
+                        
                         PagePreviewPalette palette = event.getSource(PagePreviewPalette.class);
                         BookView bookView = AppViewUtil.getCurrentBookView(palette);
                         if (bookView.getViewOptions().isPreviewMode()) {
@@ -203 +209 @@
                         
                         if (innerRect.contains(point)) {
                                 
+                                palette.removeSeparators();
+                                
                                 MainPageView mainPageView = pageItem.pageView().get().mainPartView().get();
                                 
                                 ImmRect rect = new ImmRect (ImmPoint.ZERO, book.getPageSize());
@@ -219 +227 @@
                         
                         CreatePageByTemplateHandler handler = CreatePageByTemplateHandler.get();
                         handler.setView(pageItem.pageView().get().mainPartView().get());
-                        if (topPaddingRect.contains(point)) {                   
+                        if (topPaddingRect.contains(point)) {
+                                
                                 // a page should be inserted before the current pageItem
                                 handler.setAfter(false);
+                                
+                                palette.visualizeSeparators(index, true);
                         } else {
                                 assert bottomPaddingRect.contains(point) || !bounds.contains(point.toPoint());
                                 
                                 // a page should be inserted after the current pageItem
                                 handler.setAfter(true);
+                                
+                                palette.visualizeSeparators(index, false);
                         }
 
                         preImport.setHandler(handler);
@@ -238 +251 @@
         /**
          * Handles pre-importing a page in a drag'n'drop operation.
          */
-        ON_DND_PRE_IMPORT_PAGE {
+        ON_DND_PAGE_REORDER {
 
                 public void defineFilter(EventFilterBuilder filter) {
                         filter.setSourceClass(PagePreviewPalette.class);
@@ -262 +275 @@
                                         ImmPoint.class);
                         
                         PagePreviewPalette palette = event.getSource(PagePreviewPalette.class);
-                        final int dropIndex = palette.mainComponent().get().locationToIndex(point.toPoint());
+                        int dropIndex = palette.mainComponent().get().locationToIndex(point.toPoint());
                         
                         BookH book = AppViewUtil.getCurrentBook(palette);
                         final int dragIndex = book.getIndexOf(data.getResourceRef());
@@ -271 +284 @@
                                 return false;
                         }
                         
-                        RootPageView pageView = palette.items().get().get(dropIndex).pageView().get();
+                        
+                        JList list = palette.mainComponent().get();
+                        
+                        Point dropPoint = point.toPoint();
+                        Rectangle dropRect = list.getCellBounds(dropIndex, dropIndex);
+                        
+                        double dropPos = dropPoint.getY();
+                        double rectBegin = dropRect.getY();
+                        double rectEnd = dropRect.getY() + dropRect.getHeight();
+                        
+                        if (rectEnd - dropPos < dropPos - rectBegin) {
+                                dropIndex++;
+                        }
+                        
+                        ImmList<PageItem> items = palette.items().get();
+                        
+                        palette.removeSeparators();
+                        
+                        int index = dropIndex;
+                        boolean north = true;
+                        if (dropIndex == items.size()) {
+                                index = dropIndex - 1;
+                                north = false;
+                        }
+                        palette.visualizeSeparators(index , north);
+                        
+                        palette.mainComponent().get().validate();
+                        palette.mainComponent().get().repaint();
+                        
+
+                        if (dragIndex < dropIndex) {
+                                dropIndex--;
+                        }
+                        
+                        RootPageView pageView = items.get(dropIndex).pageView().get();
                         PageReorderHandler handler = PageReorderHandler.get();
                         handler.setView(pageView);
                         preImport.setHandler(handler);

src/main/java/org/sophie2/main/app/layout/right/library/CreatePageByTemplateHandler.java

@@ -6 +6 @@
 import org.sophie2.main.app.commons.book.BookView;
 import org.sophie2.main.app.commons.element.ElementDropHandler;
 import org.sophie2.main.app.commons.page.MainPageView;
+import org.sophie2.main.app.layout.left.pages.PagePreviewPalette;
 import org.sophie2.main.dnd.TemplateRefData;
 
 /**
@@ -79 +80 @@
                 }
 
                 bookView.addNewPage(index, templateRef);
+                
+                PagePreviewPalette palette = getView().findNearestElement(null, PagePreviewPalette.class);
+                palette.removeSeparators();
         }
-
+        
+        @Override
+        public void handleExit() {
+                if (getView() != null) {
+                        PagePreviewPalette palette = getView().findNearestElement(null, 
+                                        PagePreviewPalette.class);
+                        
+                        palette.removeSeparators();
+                }
+        }
 
 
 }

src/main/java/org/sophie2/main/app/layout/left/pages/PagePreviewPalette.java

@@ -1 +1 @@
 package org.sophie2.main.app.layout.left.pages;
 
+import java.awt.BorderLayout;
 import java.awt.event.KeyEvent;
 import java.util.HashMap;
 import java.util.Map;
@@ -177 +178 @@
                 public PageItem(RootPageView pageView) {
                         getBean().init(pageView(), pageView);
                         this.result.setName(getElementId() + "/thumbnailHolder");
+                        this.rollOverPanelSouth.setName(getElementId() + "/thumbnailHolder");
+                        this.rollOverPanelNorth.setName(getElementId() + "/thumbnailHolder");
                 }
 
                 private JPanel centerPanel = new JPanel();
@@ -184 +187 @@
 
                 private PageThumbnail thumbnail = new PageThumbnail();
 
+                /**
+                 * These panel are used to be set at the north and at the south part of the result panel.
+                 * When skinned, they play the role of separators.
+                 */
+                private JPanel rollOverPanelNorth = new JPanel();
+                private JPanel rollOverPanelSouth = new JPanel();
+
+
+                /**
+                 * Used for skinning of the north and the south panels of the
+                 * {@link PageItem}.
+                 * 
+                 * @param name
+                 *            The name to be set for the skin.
+                 * @param north
+                 *            Boolean parameter to indicate if north or south panel
+                 *            should be skinned. If <b>true</b> the north panel should
+                 *            be skinned, otherwise the south one.
+                 */
+                @SuppressWarnings("synthetic-access")
+                public void setSkinIcon(String name, Boolean north) {
+                        if (north) {
+                                this.rollOverPanelNorth.setName(getElementId() + name);
+                        } else {
+                                this.rollOverPanelSouth.setName(getElementId() + name);
+                        }
+                }
+                
                 @Override
                 public JPanel render() {
 
                         this.centerPanel.removeAll();
                         this.result.removeAll();
                         this.thumbnail.removeAll();
+                        this.rollOverPanelSouth.removeAll();
+                        this.rollOverPanelNorth.removeAll();
 
                         BaseScene scene = new BaseScene();
                         RootPageView pageView = pageView().get();
@@ -208 +241 @@
                                         this.centerPanel.add(this.thumbnail);
                                         JLabel pageNumberLabel = new JLabel("" + pageNumber);
                                         this.centerPanel.add(pageNumberLabel);
-                                        this.result.add(this.centerPanel);
+                                        this.result.setLayout(new BorderLayout());
+                                        
+                                        JPanel tmp = new JPanel();
+                                        tmp.add(this.centerPanel);
+                                        this.result.add(tmp, BorderLayout.CENTER);
+                                        this.result.add(this.rollOverPanelSouth, BorderLayout.SOUTH);
+                                        this.result.add(this.rollOverPanelNorth, BorderLayout.NORTH);
                                 }
                         }
                         return this.result;
@@ -463 +502 @@
                 }
         }
 
+        /**
+         * Removes the separators between {@link PageItem}s in drag'n'drop operation.
+         */
+        public void removeSeparators() {
+                for (ListPaletteItem listItem : this.items().get()) {
+                        PageItem item = (PageItem) listItem;
+                        item.setSkinIcon("/thumbnailHolder", false);
+                        item.setSkinIcon("/thumbnailHolder", true);
+                }
+        }
+        
+        /**
+         * Visualizes separator between {@link PageItem}s in drag'n'drop operation.
+         * 
+         * @param index
+         *            The index of {@link PageItem} over which is mouse cursor is.
+         * @param before
+         *            Define whether separator before the item should be visualized
+         *            or not. If it is <b>false</b>, then the separator before the
+         *            next item will be visualized.
+         */
+        public void visualizeSeparators(int index, boolean before) {
+                
+                int size = this.items().get().size();
+                
+                PageItem pageItem = null;
+                boolean north;
+                if (before) {
+                        pageItem = this.items().get().get(index);
+                        north = true;
+                } else if (index < size - 1) {
+                        pageItem = this.items().get().get(index + 1);
+                        north = true;
+                } else {
+                        pageItem = this.items().get().get(index);
+                        north = false;
+                }
+
+                pageItem.setSkinIcon("/thumbnailDragOver", north);
+        }
+                
+        
         @Own
         private Prop<LogicR3Button> removePageButton() {
                 class removePageButton extends AutoProperty<LogicR3Button> {

src/main/java/org/sophie2/main/app/layout/left/pages/PageReorderHandler.java

@@ -55 +55 @@
                         }
                         
                 }.register(book.getAccess());
+                
+                PagePreviewPalette palette = getView().findNearestElement(null, PagePreviewPalette.class);
+                palette.removeSeparators();
+        }
+        
+        @Override
+        public void handleExit() {
+                if (getView() != null) {
+                        PagePreviewPalette palette = getView().findNearestElement(null, 
+                                        PagePreviewPalette.class);
+                        palette.removeSeparators();
+                }
         }
 }