Ticket #2307: dnd-visual-indication-templates.patch

src/main/java/org/sophie2/base/scene/helpers/ElementHelper.java

@@ -279 +279 @@
         public void touch() {
                 getEffectiveTransform();
                 getVisibleArea();
+                getElement().effects().get();
                 drawContent((Graphics2D)null);
         }
 

src/main/java/org/sophie2/main/app/commons/page/RootPageView.java

@@ -72 +72 @@
          * 
          * @return The property.
          */
-        public AutoProperty<PartPageView> mainPartView() {
-                class mainPartView extends AutoProperty<PartPageView> {
+        public AutoProperty<MainPageView> mainPartView() {
+                class mainPartView extends AutoProperty<MainPageView> {
 
                         @Override
-                        protected PartPageView compute() {
+                        protected MainPageView compute() {
                                 if (getLastValue() == null) {
-                                        return AppViewUtil.getView(RootPageView.this, getAccess(), PartPageView.class);
+                                        return AppViewUtil.getView(RootPageView.this, getAccess(), MainPageView.class);
                                 }
                                 return getLastValue();
                         }

src/main/java/org/sophie2/main/app/commons/page/MainPageView.java

@@ -3 +3 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.sophie2.base.commons.util.ImmColor;
 import org.sophie2.base.commons.util.position.ImmArea;
 import org.sophie2.base.commons.util.position.ImmPoint;
 import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.model.book.PageLinkTriggers;
+import org.sophie2.base.model.book.frame.BoundMode;
 import org.sophie2.base.model.book.links.LinkTrigger;
 import org.sophie2.base.model.resources.r4.access.ResourceAccess;
 import org.sophie2.base.scene.effects.ClipEffect;
 import org.sophie2.base.scene.impl.DefaultCompositeSceneElement;
+import org.sophie2.base.scene.impl.DefaultShapeSceneElement;
+import org.sophie2.base.scene.interfaces.SceneElement;
+import org.sophie2.core.prolib.impl.AutoProperty;
+import org.sophie2.core.prolib.interfaces.Prop;
+import org.sophie2.core.prolib.interfaces.RwProp;
+import org.sophie2.main.app.commons.frame.ContentManipulationView;
 
 /**
  * A view for all page elements.
@@ -46 +54 @@
         protected List<LinkTrigger> getLinkTriggers() {
                  return Arrays.<LinkTrigger>asList(PageLinkTriggers.values());
         }
+        
+        @Override
+        protected void setupSceneElements(List<SceneElement> res) {             
+                if (!ImmColor.TRANSPARENT.equals(dndVisualIndicationColor().get())) {
+                        res.add(dndVisualIndicationElement().get());
+                }
+
+                super.setupSceneElements(res);
+        }
+        
+        public RwProp<ImmColor> dndVisualIndicationColor() {
+                return getBean().makeValueProp("dndVisualIndicationColor", ImmColor.class, ImmColor.TRANSPARENT);
+        }
+        
+        public RwProp<ImmRect> dndVisualIndicationRect() {
+                return getBean().makeValueProp("dndVisualIndicationRect", ImmRect.class, ImmRect.ZERO_RECT);
+        }
+        
+        private Prop<SceneElement> dndVisualIndicationElement() {
+                class dndVisualIndicationElement extends AutoProperty<SceneElement> {
+
+                        @Override
+                        protected SceneElement compute() {
+                                return new DefaultShapeSceneElement() {
+                                        
+                                        @Override
+                                        protected void setupDynamic() {
+                                                shape().set(new ImmArea(dndVisualIndicationRect().get()));
+                                                
+                                                filling().set(dndVisualIndicationColor().get());
+                                        }
+                                };
+                        }
+
+                }               
+                return getBean().makeProp(dndVisualIndicationElement.class);
+        }
+        
 }

src/main/java/org/sophie2/main/app/commons/frame/FrameViewLogic.java

@@ -1 +1 @@
 package org.sophie2.main.app.commons.frame;
 
+import org.sophie2.base.commons.util.ImmColor;
 import org.sophie2.base.commons.util.position.ImmPoint;
 import org.sophie2.base.dnd.DndTransferable;
 import org.sophie2.base.dnd.SophieDragDropHandler;
@@ -12 +13 @@
 import org.sophie2.base.model.resources.r4.access.ResourceAccess;
 import org.sophie2.base.model.resources.r4.changes.AutoAction;
 import org.sophie2.base.model.resources.r4.changes.ResourceChanger;
+import org.sophie2.base.visual.interaction.InputEventR3;
 import org.sophie2.core.mvc.EventFilterBuilder;
 import org.sophie2.core.mvc.OperationDef;
 import org.sophie2.core.mvc.SortKey;
 import org.sophie2.core.mvc.events.EventR3;
 import org.sophie2.main.app.commons.book.BookView;
+import org.sophie2.main.app.commons.page.MainPageView;
 import org.sophie2.main.dnd.dnddata.ResourceRefData;
 
 /**
@@ -25 +28 @@
  * @author tanya
  */
 public enum FrameViewLogic implements OperationDef {
+        
+        /**
+         * Removes the DnD visual indication of a frame.
+         */
+        // TODO: should handle a DRAG_ENTER event (which will be created soon)
+        ON_MOUSE_EXITED_FRAME {
 
+                public void defineFilter(EventFilterBuilder filter) {
+                        filter.setSourceClass(FrameView.class);
+                        filter.setEventId(InputEventR3.MOUSE_EXITED);
+                }
+
+                public boolean handle(EventR3 event) {
+                        FrameView frameView = event.getSource(FrameView.class);
+                        
+                        frameView.dndVisualIndicationColor().set(ImmColor.TRANSPARENT);
+                        
+                        System.out.println("<><><><><>");
+                        
+                        return false;
+                }               
+        },
+        
         /**
+         * Removes the DnD visual indication of a page.
+         */
+        // TODO: should handle a DRAG_ENTER event (which will be created soon)
+        // TODO: maybe move somewhere else?
+        ON_MOUSE_EXITED {
+
+                public void defineFilter(EventFilterBuilder filter) {
+                        filter.setSourceClass(MainPageView.class);
+                        filter.setEventId(InputEventR3.MOUSE_EXITED);
+                }
+
+                public boolean handle(EventR3 event) {
+                        MainPageView pageView = event.getSource(MainPageView.class);
+                        
+                        pageView.dndVisualIndicationColor().set(ImmColor.TRANSPARENT);
+                        
+                        return false;
+                }               
+        },
+
+        /**
          * Handles dropping images over the padding of frame. For now, if handles events 
          * only if {@link ResourceRefData} is transferred.
          */

src/main/java/org/sophie2/main/app/commons/page/ScenePageLogic.java

@@ -232 +232 @@
                 }
         },
 
-        /**
-         * Handles pre-importing on data in drag'n'drop operation. Defines whether
-         * the transferred {@link DndData} can be imported. Responsible for
-         * {@link SophieDragDropHandler#dragOver}.
-         */
-        ON_DND_PRE_IMPORT {
+//      /**
+//       * Handles pre-importing on data in drag'n'drop operation. Defines whether
+//       * the transferred {@link DndData} can be imported. Responsible for
+//       * {@link SophieDragDropHandler#dragOver}.
+//       */
+//      ON_DND_PRE_IMPORT {
+//
+//              public void defineFilter(EventFilterBuilder filter) {
+//                      filter.setSourceClass(PageWorkArea.class);
+//                      filter.setEventId(SophieDragDropHandler.TransferEventIds.DND_PRE_IMPORT);
+//              }
+//
+//              @SuppressWarnings("unchecked")
+//              public boolean handle(EventR3 event) {
+//
+//                      SophieLog.info(event);
+//
+//                      PageWorkArea pwa = event.getSource(PageWorkArea.class);
+//
+//                      BookDocView bookDocView = pwa.findParentElement(BookDocView.class);
+//                      if (bookDocView != null) {
+//                              BookViewOptions viewOptions = bookDocView.bookView().get().getViewOptions();
+//                              
+//                              // Forbid drop over books in preview mode.
+//                              if (!viewOptions.isPreviewMode()) {
+//
+//                                      DndPreImport preImport = event.getEventParam(
+//                                                      SophieDragDropHandler.TransferEventIds.TRANSACTION_PARAM_INDEX,
+//                                                      DndPreImport.class);
+//
+//                                      preImport.setImportable(ResourceRefData.class, ResourceRevisionData.class,
+//                                                      RtfData.class, ImageData.class, StringData.class, FileListData.class,
+//                                                      TemplateRefData.class);
+//                              }
+//                      }
+//                      return true;
+//              }
+//      },
 
-                public void defineFilter(EventFilterBuilder filter) {
-                        filter.setSourceClass(PageWorkArea.class);
-                        filter.setEventId(SophieDragDropHandler.TransferEventIds.DND_PRE_IMPORT);
-                }
-
-                @SuppressWarnings("unchecked")
-                public boolean handle(EventR3 event) {
-
-                        SophieLog.info(event);
-
-                        PageWorkArea pwa = event.getSource(PageWorkArea.class);
-
-                        BookDocView bookDocView = pwa.findParentElement(BookDocView.class);
-                        if (bookDocView != null) {
-                                BookViewOptions viewOptions = bookDocView.bookView().get().getViewOptions();
-                                
-                                // Forbid drop over books in preview mode.
-                                if (!viewOptions.isPreviewMode()) {
-
-                                        DndPreImport preImport = event.getEventParam(
-                                                        SophieDragDropHandler.TransferEventIds.TRANSACTION_PARAM_INDEX,
-                                                        DndPreImport.class);
-
-                                        preImport.setImportable(ResourceRefData.class, ResourceRevisionData.class,
-                                                        RtfData.class, ImageData.class, StringData.class, FileListData.class,
-                                                        TemplateRefData.class);
-                                }
-                        }
-                        return true;
-                }
-        },
-
         /**
          * Returns the swing focus to the scene after closing a hud. 
          */

src/main/java/org/sophie2/main/app/commons/frame/FrameView.java

@@ -37 +37 @@
 import org.sophie2.base.scene.impl.DefaultShapeSceneElement;
 import org.sophie2.base.scene.impl.DefaultTextSceneElement;
 import org.sophie2.base.scene.interfaces.Scene;
+import org.sophie2.base.scene.interfaces.SceneEffect;
 import org.sophie2.base.scene.interfaces.SceneElement;
 import org.sophie2.base.scene.model.LineStyle;
 import org.sophie2.base.scene.model.SceneTextRun;
@@ -155 +156 @@
                 if (!getViewOptions().isPreviewMode()) {
                         res.add(resizeArea().get());
                 }
+                
+                if (!ImmColor.TRANSPARENT.equals(dndVisualIndicationColor().get())) {
+                        res.add(dndVisualIndicationElement().get());
+                }
 
                 super.setupSceneElements(res);
         }
@@ -183 +188 @@
                                                                 shadowOpacity));
                                 
                                 element.effects().add(shadow);
-                                
-                        } 
-                        
+                        }               
                 }
                 
         }
         
+        public RwProp<ImmColor> dndVisualIndicationColor() {
+                return getBean().makeValueProp("dndVisualIndicationColor", ImmColor.class, ImmColor.TRANSPARENT);
+        }
+        
+        public RwProp<BoundMode> dndVisualIndicationBoundMode() {
+                return getBean().makeValueProp("dndVisualIndicationBoundMode", BoundMode.class, BoundMode.CONTENT);
+        }
+        
+        private Prop<SceneElement> dndVisualIndicationElement() {
+                class dndVisualIndicationElement extends AutoProperty<SceneElement> {
+
+                        @Override
+                        protected SceneElement compute() {
+                                return new DefaultShapeSceneElement() {
+                                        
+                                        @Override
+                                        protected void setupDynamic() {
+                                                ImmRect rect = getLocalRect(dndVisualIndicationBoundMode().get());
+                                                shape().set(new ImmArea(rect));
+                                                
+                                                filling().set(dndVisualIndicationColor().get());
+                                        }
+                                };
+                        }
+
+                }               
+                return getBean().makeProp(dndVisualIndicationElement.class);
+        }
+        
         /**
          * The scene element representing the frame border (the actual border).
          * 

src/main/java/org/sophie2/base/dnd/SophieDragDropHandler.java

@@ -157 +157 @@
                  */
                 public void setImportable(Class<? extends DndData>... supported) {
 
-                        this.importable = false;
-
                         for (Class<? extends DndData> dndData : supported) {
 
                                 if (getTransferable().isDndDataSupported(dndData)) {

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

@@ -2 +2 @@
 
 import javax.swing.JComponent;
 
+import org.sophie2.base.commons.util.ImmColor;
 import org.sophie2.base.commons.util.ImmList;
 import org.sophie2.base.commons.util.NaiveImmList;
 import org.sophie2.base.commons.util.position.ImmPoint;
+import org.sophie2.base.commons.util.position.ImmRect;
 import org.sophie2.base.dialogs.DialogManager;
 import org.sophie2.base.dnd.DndTransferable;
 import org.sophie2.base.dnd.SophieDragDropHandler;
 import org.sophie2.base.dnd.SophieTransferable;
 import org.sophie2.base.dnd.SophieDragDropHandler.DndExport;
 import org.sophie2.base.dnd.SophieDragDropHandler.DndImport;
+import org.sophie2.base.dnd.SophieDragDropHandler.DndPreImport;
 import org.sophie2.base.layout.model.ListPalette;
 import org.sophie2.base.model.book.BookH;
 import org.sophie2.base.model.book.FrameH;
 import org.sophie2.base.model.book.PageH;
+import org.sophie2.base.model.book.frame.BoundMode;
 import org.sophie2.base.model.book.frame.FrameR4;
 import org.sophie2.base.model.book.interfaces.CompositeElement;
 import org.sophie2.base.model.book.resource.r4.BookR4;
@@ -39 +43 @@
 import org.sophie2.main.app.commons.app.AppMainWindow;
 import org.sophie2.main.app.commons.book.BookDocView;
 import org.sophie2.main.app.commons.frame.FrameView;
+import org.sophie2.main.app.commons.page.MainPageView;
 import org.sophie2.main.app.commons.page.PageWorkArea;
 import org.sophie2.main.app.commons.page.RootPageView;
 import org.sophie2.main.app.commons.util.AppViewUtil;
@@ -195 +200 @@
                         return true;
                 }
         },
+        
+        /**
+         * Handles pre-importing (dragging) a template over a {@link FrameView}.
+         * Adds the appropriate visual indications to the frame view.
+         */
+        ON_FRAME_TEMPLATE_PRE_IMPORT {
 
+                public void defineFilter(EventFilterBuilder filter) {
+                        filter.setSourceClass(FrameView.class);
+                        filter.setEventId(SophieDragDropHandler.TransferEventIds.DND_PRE_IMPORT);
+                }
+
+                @SuppressWarnings("unchecked")
+                public boolean handle(EventR3 event) {
+                        DndPreImport preImport = event.getEventParam(
+                                        SophieDragDropHandler.TransferEventIds.TRANSACTION_PARAM_INDEX,
+                                        DndPreImport.class);
+                        
+                        FrameView frameView = event.getSource(FrameView.class);
+                        if (frameView.getViewOptions().isPreviewMode()) {
+                                return false;
+                        }
+                        
+                        preImport.setImportable(TemplateRefData.class);
+                        if (!preImport.getImportable()) {
+                                return false;
+                        }
+                        
+                        // TODO: consider creating FrameTemplateData and PageTemplateData instead of this check
+                        TemplateRefData data = preImport.getTransferable().getDndData(TemplateRefData.class);
+                        BookH book = AppViewUtil.getCurrentBook(frameView);
+                        if (!TemplateUtil.isFrameTemplate(book, data.getTemplateRef())) {
+                                return false;
+                        }
+                        
+                        frameView.dndVisualIndicationBoundMode().set(BoundMode.OUT_BORDER);
+                        frameView.dndVisualIndicationColor().set(new ImmColor(1.0f, 0.68f, 0.68f, 0.5f));
+                                                                
+                        return true;
+                }
+        },
+
         /**
          * Handles the dropping a frame template over a {@link FrameView}.
          * Applies the template to the view's model.
@@ -249 +295 @@
 
                         }.register(frameAccess);
 
+                        source.dndVisualIndicationColor().set(ImmColor.TRANSPARENT);
+                        
                         return true;
                 }
 
@@ -445 +493 @@
                         return true;
                 }
         },
+        
+        /**
+         * Handles pre-importing (dragging) a template over a {@link RootPageView}.
+         * Adds the appropriate visual indications to the page view.
+         */
+        ON_PAGE_TEMPLATE_PRE_IMPORT {
 
+                public void defineFilter(EventFilterBuilder filter) {
+                        filter.setSourceClass(RootPageView.class);
+                        filter.setEventId(SophieDragDropHandler.TransferEventIds.DND_PRE_IMPORT);
+                }
+
+                @SuppressWarnings("unchecked")
+                public boolean handle(EventR3 event) {
+                        DndPreImport preImport = event.getEventParam(
+                                        SophieDragDropHandler.TransferEventIds.TRANSACTION_PARAM_INDEX,
+                                        DndPreImport.class);
+                        
+                        RootPageView pageView = event.getSource(RootPageView.class);
+                        if (pageView.getViewOptions().isPreviewMode()) {
+                                return false;
+                        }
+                        
+                        preImport.setImportable(TemplateRefData.class);
+                        if (!preImport.getImportable()) {
+                                return false;
+                        }
+                        
+                        // TODO: consider creating FrameTemplateData and PageTemplateData instead of this check
+                        TemplateRefData data = preImport.getTransferable().getDndData(TemplateRefData.class);
+                        BookH book = AppViewUtil.getCurrentBook(pageView);
+                        if (!TemplateUtil.isPageTemplate(book, data.getTemplateRef())) {
+                                return false;
+                        }
+                        
+                        MainPageView mainPageView = pageView.mainPartView().get();
+                        mainPageView.dndVisualIndicationColor().set(new ImmColor(1.0f, 0.68f, 0.68f, 0.5f));
+                        
+                        ImmRect rect = new ImmRect(ImmPoint.ZERO, book.getPageSize());                  
+                        mainPageView.dndVisualIndicationRect().set(rect);
+                        
+                        return true;
+                }
+        },
+
         /**
          * Handles dropping a page template over the {@link RootPageView}.
          * Applies the template to the view's model.
@@ -474 +566 @@
                         DndTransferable transferable = dndImport.getTransferable();
 
                         BookH book = source.getBookView().model().get();
+                        
+                        source.mainPartView().get().dndVisualIndicationColor().set(ImmColor.TRANSPARENT);
                         return TemplateUtil.applyPageTemplate(transferable, source.model().get(), book);
                 }
         },