Refactor FormatPainter code

- We're not going to sub-class FormatPainterToolEntry so remove that support. This was added in 2011 and, 13 years later, we haven't sub-classed it. :-) - Get rid of PaintFormat inner class - Modernise code
archimatetool · Jul 29, 2024 · 7ae3813 · 7ae3813
1 parent f412315
commit 7ae3813
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 147 deletions.
diff --git a/com.archimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterInfo.java b/com.archimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterInfo.java
@@ -23,85 +23,49 @@
 
 
 /**
- * FormatPainter Singleton state of format and cursor
+ * FormatPainter Singleton state of format and cursor.
+ * This is a a global class that stores the state of the FormatPainterInfo and the tool's cursor.
+ * This is so that the FormatPainter can be use across different instances of diagrams.
  * 
  * @author Phillip Beauvoir
  */
 public class FormatPainterInfo {
 
-    public static FormatPainterInfo INSTANCE = new FormatPainterInfo();
-
     /**
-     * Paint format information containing cursor color and source component
+     * Global static instance
      */
-    public static class PaintFormat {
-        private IDiagramModelComponent component;
-        private RGB cursorColor;
-
-        public PaintFormat(IDiagramModelComponent component) {
-            this.component = component;
-
-            // Default
-            cursorColor = new RGB(255, 255, 255);
-
-            if(component instanceof IDiagramModelConnection) {
-                // Line color
-                String colorValue = ((IDiagramModelConnection)component).getLineColor();
-                cursorColor = ColorFactory.convertStringToRGB(colorValue);
-                if(cursorColor == null) {
-                    cursorColor = ColorFactory.getDefaultLineColor(component).getRGB();
-                }
-            }
-            else if(component instanceof IDiagramModelObject) {
-                // Fill color
-                String colorValue = ((IDiagramModelObject)component).getFillColor();
-                cursorColor = ColorFactory.convertStringToRGB(colorValue);
-                if(cursorColor == null) {
-                    cursorColor = ColorFactory.getDefaultFillColor(component).getRGB();
-                }
-            }
-        }
-
-        public IDiagramModelComponent getSourceComponent() {
-            return component;
-        }
-
-        public RGB getCursorColor() {
-            return cursorColor;
-        }
-    }
-
-    FormatPainterInfo() {}
+    public static FormatPainterInfo INSTANCE = new FormatPainterInfo();
 
-    private PaintFormat pf;
+    private IDiagramModelComponent sourceComponent;
+    private RGB cursorColor;
     private Cursor coloredCursor, defaultCursor;
     private PropertyChangeSupport listeners = new PropertyChangeSupport(this);
 
-    PaintFormat getPaintFormat() {
-        return pf;
-    }
+    // package protected constructor for unit tests
+    FormatPainterInfo() {}
 
-    void updatePaintFormat(IDiagramModelComponent component) {
-        if(component != null) {
-            pf = new PaintFormat(component);
-        }
-        else {
-            pf = null;
-        }
-        updateColoredCursor();
+    /**
+     * Reset source component to null and notify listeners.
+     */
+    public void reset() {
+        setSourceComponent(null);
         fireUpdated();
     }
 
     /**
-     * Reset all copied information
+     * Set the source component that we will copy formatting from and update the cursor.
      */
-    public void reset() {
-        pf = null;
+    void updateWithSourceComponent(IDiagramModelComponent component) {
+        setSourceComponent(component);
+        updateColoredCursor();
         fireUpdated();
     }
 
+    /**
+     * Get the cursor to use for the tool.
+     */
     Cursor getCursor() {
-        return pf == null ? getDefaultCursor() : coloredCursor;
+        return hasSourceComponent() ? coloredCursor : getDefaultCursor();
     }
 
     private Cursor getDefaultCursor() {
@@ -113,8 +77,44 @@ private Cursor getDefaultCursor() {
         return defaultCursor;
     }
 
-    boolean isFat() {
-        return pf != null;
+    /**
+     * @return true if we have a source component that we will copy the format from.
+     */
+    boolean hasSourceComponent() {
+        return getSourceComponent() != null;
+    }
+
+    IDiagramModelComponent getSourceComponent() {
+        return sourceComponent;
+    }
+
+    RGB getCursorColor() {
+        return cursorColor;
+    }
+
+    /**
+     * Set the source component from which we will copy the formatting
+     */
+    private void setSourceComponent(IDiagramModelComponent component) {
+        sourceComponent = component;
+        cursorColor = new RGB(255, 255, 255); // default
+
+        if(component instanceof IDiagramModelConnection dmc) {
+            // Line color
+            String colorValue = dmc.getLineColor();
+            cursorColor = ColorFactory.convertStringToRGB(colorValue);
+            if(cursorColor == null) {
+                cursorColor = ColorFactory.getDefaultLineColor(component).getRGB();
+            }
+        }
+        else if(component instanceof IDiagramModelObject dmo) {
+            // Fill color
+            String colorValue = dmo.getFillColor();
+            cursorColor = ColorFactory.convertStringToRGB(colorValue);
+            if(cursorColor == null) {
+                cursorColor = ColorFactory.getDefaultFillColor(component).getRGB();
+            }
+        }
     }
 
     /**
@@ -127,10 +127,10 @@ private void updateColoredCursor() {
 
         ImageData cursorImageData = IArchiImages.ImageFactory.getImage(IArchiImages.CURSOR_FORMAT_PAINTER).getImageData(ImageFactory.getCursorDeviceZoom());
 
-        if(pf.getCursorColor() != null) {
+        if(getCursorColor() != null) {
             PaletteData pData = cursorImageData.palette;
             int whitePixel = pData.getPixel(new RGB(255, 255, 255));
-            int fillColor = pData.getPixel(pf.getCursorColor());
+            int fillColor = pData.getPixel(getCursorColor());
 
             for(int i = 0; i < cursorImageData.width; i++) {
                 for(int j = 0; j < cursorImageData.height; j++) {

diff --git a/com.archimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterTool.java b/com.archimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterTool.java
@@ -26,7 +26,6 @@
 import com.archimatetool.editor.diagram.commands.LineWidthCommand;
 import com.archimatetool.editor.diagram.commands.TextAlignmentCommand;
 import com.archimatetool.editor.diagram.commands.TextPositionCommand;
-import com.archimatetool.editor.diagram.tools.FormatPainterInfo.PaintFormat;
 import com.archimatetool.editor.model.IArchiveManager;
 import com.archimatetool.editor.model.commands.EObjectFeatureCommand;
 import com.archimatetool.editor.model.commands.FeatureCommand;
@@ -73,12 +72,12 @@ protected boolean handleButtonUp(int button) {
             if(editpart != null && editpart.getModel() != null) {
                 Object object = editpart.getModel();
                 if(isPaintableObject(object)) {
-                    PaintFormat pf = FormatPainterInfo.INSTANCE.getPaintFormat();
-                    if(pf == null) {
-                        FormatPainterInfo.INSTANCE.updatePaintFormat((IDiagramModelComponent)object);
+                    IDiagramModelComponent sourceComponent = FormatPainterInfo.INSTANCE.getSourceComponent();
+                    if(sourceComponent == null) {
+                        FormatPainterInfo.INSTANCE.updateWithSourceComponent((IDiagramModelComponent)object);
                     }
                     else if(!isObjectLocked(object)) {
-                        Command cmd = createCommand(pf, (IDiagramModelComponent)object);
+                        Command cmd = createCommand(sourceComponent, (IDiagramModelComponent)object);
                         if(cmd.canExecute()) {
                             executeCommand(cmd);
                         }
@@ -104,18 +103,18 @@ protected boolean handleDoubleClick(int button) {
                 FormatPainterInfo.INSTANCE.reset();
                 return true;
             }
-            else return handleButtonUp(1);
         }
+
         return false;
     }
 
-    protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent targetComponent) {
+    protected CompoundCommand createCommand(IDiagramModelComponent sourceComponent, IDiagramModelComponent targetComponent) {
         CompoundCommand result = new CompoundCommand(Messages.FormatPainterTool_0);
 
         IObjectUIProvider provider = ObjectUIFactory.INSTANCE.getProvider(targetComponent);
 
         // IFontAttribute
-        if(pf.getSourceComponent() instanceof IFontAttribute source && targetComponent instanceof IFontAttribute target) {
+        if(sourceComponent instanceof IFontAttribute source && targetComponent instanceof IFontAttribute target) {
             Command cmd = new FontStyleCommand(target, source.getFont());
             if(cmd.canExecute()) {
                 result.add(cmd);
@@ -128,7 +127,7 @@ protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent t
         }
 
         // ILineObject
-        if(pf.getSourceComponent() instanceof ILineObject source && targetComponent instanceof ILineObject target && provider != null) {
+        if(sourceComponent instanceof ILineObject source && targetComponent instanceof ILineObject target && provider != null) {
             // Line color
             if(provider.shouldExposeFeature(IArchimatePackage.Literals.LINE_OBJECT__LINE_COLOR.getName())) {
                 Command cmd = new LineColorCommand(target, source.getLineColor());
@@ -147,39 +146,39 @@ protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent t
         }
 
         // IBorderObject
-        if(pf.getSourceComponent() instanceof IBorderObject source && targetComponent instanceof IBorderObject target) {
+        if(sourceComponent instanceof IBorderObject source && targetComponent instanceof IBorderObject target) {
             Command cmd = new BorderColorCommand(target, source.getBorderColor());
             if(cmd.canExecute()) {
                 result.add(cmd);
             }
         }
 
         // IBorderType
-        if(pf.getSourceComponent() instanceof IBorderType source && targetComponent instanceof IBorderType target && source.eClass() == target.eClass()) {
+        if(sourceComponent instanceof IBorderType source && targetComponent instanceof IBorderType target && source.eClass() == target.eClass()) {
             Command cmd = new EObjectFeatureCommand("", target, IArchimatePackage.Literals.BORDER_TYPE__BORDER_TYPE, source.getBorderType()); //$NON-NLS-1$
             if(cmd.canExecute()) {
                 result.add(cmd);
             }
         }
 
         // ITextPosition
-        if(pf.getSourceComponent() instanceof ITextPosition source && targetComponent instanceof ITextPosition target) {
+        if(sourceComponent instanceof ITextPosition source && targetComponent instanceof ITextPosition target) {
             Command cmd = new TextPositionCommand(target, source.getTextPosition());
             if(cmd.canExecute()) {
                 result.add(cmd);
             }
         }
 
         // ITextAlignment
-        if(pf.getSourceComponent() instanceof ITextAlignment source && targetComponent instanceof ITextAlignment target) {
+        if(sourceComponent instanceof ITextAlignment source && targetComponent instanceof ITextAlignment target) {
             Command cmd = new TextAlignmentCommand(target, source.getTextAlignment());
             if(cmd.canExecute()) {
                 result.add(cmd);
             }
         }
 
         // IDiagramModelObject
-        if(pf.getSourceComponent() instanceof IDiagramModelObject source && targetComponent instanceof IDiagramModelObject target) {
+        if(sourceComponent instanceof IDiagramModelObject source && targetComponent instanceof IDiagramModelObject target) {
             // Source fill colour is null which is "default"
             String fillColorString = source.getFillColor();
             if(fillColorString == null) {
@@ -236,7 +235,7 @@ protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent t
         }
 
         // Archimate objects
-        if(pf.getSourceComponent() instanceof IDiagramModelArchimateObject source && targetComponent instanceof IDiagramModelArchimateObject target) {
+        if(sourceComponent instanceof IDiagramModelArchimateObject source && targetComponent instanceof IDiagramModelArchimateObject target) {
             // Image Source
             Command cmd = new FeatureCommand("", target, IDiagramModelArchimateObject.FEATURE_IMAGE_SOURCE, //$NON-NLS-1$
                     source.getImageSource(), IDiagramModelArchimateObject.FEATURE_IMAGE_SOURCE_DEFAULT);
@@ -246,7 +245,7 @@ protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent t
         }
 
         // IDiagramModelConnection
-        if(pf.getSourceComponent() instanceof IDiagramModelConnection source && targetComponent instanceof IDiagramModelConnection target) {
+        if(sourceComponent instanceof IDiagramModelConnection source && targetComponent instanceof IDiagramModelConnection target) {
             // Connection text position
             Command cmd = new ConnectionTextPositionCommand(target, source.getTextPosition());
             if(cmd.canExecute()) {
@@ -263,7 +262,7 @@ protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent t
         }
 
         // IIconic
-        if(pf.getSourceComponent() instanceof IIconic source && targetComponent instanceof IIconic target) {
+        if(sourceComponent instanceof IIconic source && targetComponent instanceof IIconic target) {
             // If we have an image path and the source and target models are different, copy the image bytes
             String imagePath = source.getImagePath();
             if(imagePath != null && source.getArchimateModel() != target.getArchimateModel()) {
@@ -317,5 +316,4 @@ protected boolean isPaintableObject(Object object) {
     protected String getCommandName() {
         return "FormatPaint"; //$NON-NLS-1$
     }
-
 }
diff --git a/...chimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterToolEntry.java b/...chimatetool.editor/src/com/archimatetool/editor/diagram/tools/FormatPainterToolEntry.java
@@ -9,13 +9,9 @@
 import java.beans.PropertyChangeListener;
 
 import org.eclipse.gef.Tool;
-import org.eclipse.gef.commands.Command;
-import org.eclipse.gef.commands.CompoundCommand;
 import org.eclipse.gef.palette.ToolEntry;
 
-import com.archimatetool.editor.diagram.tools.FormatPainterInfo.PaintFormat;
 import com.archimatetool.editor.ui.IArchiImages;
-import com.archimatetool.model.IDiagramModelComponent;
 import com.archimatetool.model.IDiagramModelConnection;
 
 
@@ -39,50 +35,24 @@ public FormatPainterToolEntry() {
 
     @Override
     public Tool createTool() {
-        tool = new FormatPainterTool() {
-            @Override
-            protected CompoundCommand createCommand(PaintFormat pf, IDiagramModelComponent targetComponent) {
-                CompoundCommand result = super.createCommand(pf, targetComponent);
-
-                // Add any additional commands from Sub-classes
-                Command extraCommand = FormatPainterToolEntry.this.getCommand(pf.getSourceComponent(), targetComponent);
-                if(extraCommand != null && extraCommand.canExecute()) {
-                    result.add(extraCommand);
-                }
-
-                return result;
-            }
-        };
-        tool.setProperties(getToolProperties());
+        tool = (FormatPainterTool)super.createTool();
         return tool;
     }
 
-    /**
-     * Sub-classes can add additional commands to the Main Command that will be executed when the format paint is applied
-     * @param sourceComponent 
-     * @param targetComponent 
-     */
-    public Command getCommand(IDiagramModelComponent sourceComponent, IDiagramModelComponent targetComponent) {
-        return null;
-    }
-
     @Override
     public void propertyChange(PropertyChangeEvent evt) {
-        if(tool != null) {
-            tool.setDefaultCursor(FormatPainterInfo.INSTANCE.getCursor());
-        }
-
+        tool.setDefaultCursor(FormatPainterInfo.INSTANCE.getCursor());
         setLabels();
         setIcons();
     }
 
-    protected void setLabels() {
-        if(FormatPainterInfo.INSTANCE.isFat()) {
+    private void setLabels() {
+        if(FormatPainterInfo.INSTANCE.hasSourceComponent()) {
             setLabel(Messages.FormatPainterToolEntry_0);
 
             String description1 = Messages.FormatPainterToolEntry_1;
             String description2 = Messages.FormatPainterToolEntry_2;
-            String description = (FormatPainterInfo.INSTANCE.getPaintFormat().getSourceComponent() instanceof IDiagramModelConnection) ?
+            String description = (FormatPainterInfo.INSTANCE.getSourceComponent() instanceof IDiagramModelConnection) ?
                     description1 : description2;
 
             description += "\n" + Messages.FormatPainterToolEntry_3; //$NON-NLS-1$
@@ -94,8 +64,8 @@ protected void setLabels() {
         }
     }
 
-    protected void setIcons() {
-        if(FormatPainterInfo.INSTANCE.isFat()) {
+    private void setIcons() {
+        if(FormatPainterInfo.INSTANCE.hasSourceComponent()) {
             setLargeIcon(IArchiImages.ImageFactory.getImageDescriptor(IArchiImages.ICON_FORMAT_PAINTER));
             setSmallIcon(IArchiImages.ImageFactory.getImageDescriptor(IArchiImages.ICON_FORMAT_PAINTER));
         }