Use SourceFigure for ScrollableThumbnail handling

org.eclipse.draw2d/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Plugin.name
 Bundle-SymbolicName: org.eclipse.draw2d;singleton:=true
-Bundle-Version: 3.13.100.qualifier
+Bundle-Version: 3.14.0.qualifier
 Bundle-Vendor: %Plugin.providerName
 Bundle-Localization: plugin
 Export-Package: org.eclipse.draw2d,

org.eclipse.draw2d/src/org/eclipse/draw2d/parts/ScrollableThumbnail.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2023 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -10,7 +10,6 @@
  *******************************************************************************/
 package org.eclipse.draw2d.parts;
 
-import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
 
 import org.eclipse.swt.SWT;
@@ -46,17 +45,22 @@ public class ScrollableThumbnail extends Thumbnail {
 	private class ClickScrollerAndDragTransferrer extends MouseMotionListener.Stub implements MouseListener {
 		private boolean dragTransfer;
 
+		@Override
 		public void mouseDoubleClicked(MouseEvent me) {
 		}
 
+		@Override
 		public void mouseDragged(MouseEvent me) {
-			if (dragTransfer)
+			if (dragTransfer) {
 				syncher.mouseDragged(me);
+			}
 		}
 
+		@Override
 		public void mousePressed(MouseEvent me) {
-			if (!(ScrollableThumbnail.this.getClientArea().contains(me.getLocation())))
+			if (!(ScrollableThumbnail.this.getClientArea().contains(me.getLocation()))) {
 				return;
+			}
 			Dimension selectorCenter = selector.getBounds().getSize().scale(0.5f);
 			Point scrollPoint = me.getLocation().getTranslated(getLocation().getNegated())
 					.translate(selectorCenter.negate()).scale(1.0f / getViewportScaleX(), 1.0f / getViewportScaleY())
@@ -67,6 +71,7 @@ public void mousePressed(MouseEvent me) {
 			dragTransfer = true;
 		}
 
+		@Override
 		public void mouseReleased(MouseEvent me) {
 			syncher.mouseReleased(me);
 			dragTransfer = false;
@@ -77,9 +82,11 @@ private class ScrollSynchronizer extends MouseMotionListener.Stub implements Mou
 		private Point startLocation;
 		private Point viewLocation;
 
+		@Override
 		public void mouseDoubleClicked(MouseEvent me) {
 		}
 
+		@Override
 		public void mouseDragged(MouseEvent me) {
 			if (startLocation != null) {
 				Dimension d = me.getLocation().getDifference(startLocation);
@@ -89,21 +96,23 @@ public void mouseDragged(MouseEvent me) {
 			}
 		}
 
+		@Override
 		public void mousePressed(MouseEvent me) {
 			startLocation = me.getLocation();
 			viewLocation = viewport.getViewLocation();
 			me.consume();
 		}
 
+		@Override
 		public void mouseReleased(MouseEvent me) {
 		}
 	}
 
 	private class SelectorFigure extends Figure {
 
-		private Rectangle iBounds;
+		private final Rectangle iBounds;
 
-		private ImageData iData;
+		private final ImageData iData;
 
 		public SelectorFigure() {
 			PaletteData pData = new PaletteData(0xFF, 0xFF00, 0xFF0000);
@@ -115,19 +124,22 @@ public SelectorFigure() {
 			iBounds = new Rectangle(0, 0, 1, 1);
 		}
 
+		@Override
 		public void paintFigure(Graphics g) {
 			Rectangle bounds = getBounds().getCopy();
 
 			// Avoid drawing images that are 0 in dimension
-			if (bounds.width < 5 || bounds.height < 5)
+			if (bounds.width < 5 || bounds.height < 5) {
 				return;
+			}
 
 			// Don't paint the selector figure if the entire source is visible.
 			Dimension thumbnailSize = new Dimension(getThumbnailImage());
 			// expand to compensate for rounding errors in calculating bounds
 			Dimension size = getSize().getExpanded(1, 1);
-			if (size.contains(thumbnailSize))
+			if (size.contains(thumbnailSize)) {
 				return;
+			}
 
 			bounds.height--;
 			bounds.width--;
@@ -141,70 +153,90 @@ public void paintFigure(Graphics g) {
 		}
 	}
 
-	private FigureListener figureListener = new FigureListener() {
-		public void figureMoved(IFigure source) {
-			reconfigureSelectorBounds();
-		}
-	};
-	private KeyListener keyListener = new KeyListener.Stub() {
+	private final FigureListener figureListener = source -> reconfigureSelectorBounds();
+	private final KeyListener keyListener = new KeyListener.Stub() {
+		@Override
 		public void keyPressed(KeyEvent ke) {
 			int moveX = viewport.getClientArea().width / 4;
 			int moveY = viewport.getClientArea().height / 4;
-			if (ke.keycode == SWT.HOME || (isMirrored() ? ke.keycode == SWT.ARROW_RIGHT : ke.keycode == SWT.ARROW_LEFT))
+			if (ke.keycode == SWT.HOME
+					|| (isMirrored() ? ke.keycode == SWT.ARROW_RIGHT : ke.keycode == SWT.ARROW_LEFT)) {
 				viewport.setViewLocation(viewport.getViewLocation().translate(-moveX, 0));
-			else if (ke.keycode == SWT.END
-					|| (isMirrored() ? ke.keycode == SWT.ARROW_LEFT : ke.keycode == SWT.ARROW_RIGHT))
+			} else if (ke.keycode == SWT.END
+					|| (isMirrored() ? ke.keycode == SWT.ARROW_LEFT : ke.keycode == SWT.ARROW_RIGHT)) {
 				viewport.setViewLocation(viewport.getViewLocation().translate(moveX, 0));
-			else if (ke.keycode == SWT.ARROW_UP || ke.keycode == SWT.PAGE_UP)
+			} else if (ke.keycode == SWT.ARROW_UP || ke.keycode == SWT.PAGE_UP) {
 				viewport.setViewLocation(viewport.getViewLocation().translate(0, -moveY));
-			else if (ke.keycode == SWT.ARROW_DOWN || ke.keycode == SWT.PAGE_DOWN)
+			} else if (ke.keycode == SWT.ARROW_DOWN || ke.keycode == SWT.PAGE_DOWN) {
 				viewport.setViewLocation(viewport.getViewLocation().translate(0, moveY));
+			}
 		}
 	};
 
-	private PropertyChangeListener propListener = new PropertyChangeListener() {
-		public void propertyChange(PropertyChangeEvent evt) {
-			reconfigureSelectorBounds();
-		}
-	};
+	private final PropertyChangeListener propListener = evt -> reconfigureSelectorBounds();
 
 	private ScrollSynchronizer syncher;
 	private IFigure selector;
 	private Viewport viewport;
 
-	/**
-	 * Creates a new ScrollableThumbnail.
-	 */
+	/** Creates a new ScrollableThumbnail. */
 	public ScrollableThumbnail() {
-		super();
 		initialize();
 	}
 
 	/**
 	 * Creates a new ScrollableThumbnail that synchs with the given Viewport.
-	 * 
+	 *
 	 * @param port The Viewport
 	 */
 	public ScrollableThumbnail(Viewport port) {
-		super();
 		setViewport(port);
 		initialize();
 	}
 
-	/**
-	 * @see Thumbnail#deactivate()
-	 */
+	/** @see Thumbnail#deactivate() */
+	@Override
 	public void deactivate() {
 		unhookViewport();
 		unhookSelector();
 		super.deactivate();
 	}
 
-	private double getViewportScaleX() {
-		return (double) targetSize.width / viewport.getContents().getBounds().width;
+	/**
+	 * Get the viewport used for this ScrollableThumbnail
+	 *
+	 * @return the viewport
+	 * @since 3.14
+	 */
+	public final Viewport getViewport() {
+		return viewport;
 	}
 
-	private double getViewportScaleY() {
+	/**
+	 * Calculate the scale factor in x direction to be used between viewport and
+	 * thumbnail.
+	 *
+	 * Subclasses may override if they only want to show parts of the overall
+	 * viewport.
+	 *
+	 * @return the viewport scale factor for X
+	 * @since 3.14
+	 */
+	protected double getViewportScaleX() {
+		return (double) targetSize.width / viewport.getContents().getBounds().width();
+	}
+
+	/**
+	 * Calculate the scale factor in y direction to be used between viewport and
+	 * thumbnail.
+	 *
+	 * Subclasses may override if they only want to show parts of the overall
+	 * viewport.
+	 *
+	 * @return the viewport scale factor for Y
+	 * @since 3.14
+	 */
+	protected double getViewportScaleY() {
 		return (double) targetSize.height / viewport.getContents().getBounds().height;
 	}
 
@@ -230,6 +262,18 @@ private void initialize() {
 	}
 
 	private void reconfigureSelectorBounds() {
+		selector.setBounds(calculateSelectorBounds());
+	}
+
+	/**
+	 * Calculate the size and position of the selector
+	 *
+	 * Subclasses may override if they only want to show parts of the overall
+	 * viewport. Especially the offset calculation may need to be adjusted.
+	 *
+	 * @since 3.14
+	 */
+	protected Rectangle calculateSelectorBounds() {
 		Rectangle rect = new Rectangle();
 		Point offset = viewport.getViewLocation();
 		offset.x -= viewport.getHorizontalRangeModel().getMinimum();
@@ -238,27 +282,29 @@ private void reconfigureSelectorBounds() {
 		rect.setSize(viewport.getClientArea().getSize());
 		rect.scale(getViewportScaleX(), getViewportScaleY());
 		rect.translate(getClientArea().getLocation());
-		selector.setBounds(rect);
+		return rect;
 	}
 
 	/**
 	 * Reconfigures the SelectorFigure's bounds if the scales have changed.
-	 * 
+	 *
 	 * @param scaleX The X scale
 	 * @param scaleY The Y scale
 	 * @see org.eclipse.draw2d.parts.Thumbnail#setScales(float, float)
 	 */
+	@Override
 	protected void setScales(float scaleX, float scaleY) {
-		if (scaleX == getScaleX() && scaleY == getScaleY())
+		if (scaleX == getScaleX() && scaleY == getScaleY()) {
 			return;
+		}
 
 		super.setScales(scaleX, scaleY);
 		reconfigureSelectorBounds();
 	}
 
 	/**
 	 * Sets the Viewport that this ScrollableThumbnail will synch with.
-	 * 
+	 *
 	 * @param port The Viewport
 	 */
 	public void setViewport(Viewport port) {

org.eclipse.draw2d/src/org/eclipse/draw2d/parts/Thumbnail.java

@@ -66,9 +66,7 @@ class ThumbnailUpdater implements Runnable {
 		// GC used to copy from the tile image into the thumbnail image
 		private GC thumbnailGC;
 
-		/**
-		 * Stops the updater and disposes of any resources.
-		 */
+		/** Stops the updater and disposes of any resources. */
 		public void deactivate() {
 			setActive(false);
 			stop();
@@ -143,9 +141,7 @@ public void resetTileValues() {
 			currentVTile = 0;
 		}
 
-		/**
-		 * Restarts the updater.
-		 */
+		/** Restarts the updater. */
 		public void restart() {
 			stop();
 			start();
@@ -287,9 +283,7 @@ public void start() {
 			Display.getCurrent().asyncExec(this);
 		}
 
-		/**
-		 * Create new GC, SWTGraphics, and ScaledGraphics instances
-		 */
+		/** Create new GC, SWTGraphics, and ScaledGraphics instances */
 		private void createTileGraphics() {
 			// For the Mac fixe we have to create a new GC instance to flush the previous
 			// tile image...
@@ -417,9 +411,7 @@ private Dimension adjustToAspectRatio(Dimension size, boolean adjustToMaxDimensi
 		return size.expand(borderSize);
 	}
 
-	/**
-	 * Deactivates this Thumbnail.
-	 */
+	/** Deactivates this Thumbnail. */
 	public void deactivate() {
 		sourceFigure.getUpdateManager().removeUpdateListener(this);
 		updater.deactivate();
@@ -522,9 +514,7 @@ protected boolean isDirty() {
 		return isDirty;
 	}
 
-	/**
-	 * @see org.eclipse.draw2d.UpdateListener#notifyPainting(Rectangle, Map)
-	 */
+	/** @see org.eclipse.draw2d.UpdateListener#notifyPainting(Rectangle, Map) */
 	@Override
 	public void notifyPainting(Rectangle damage, Map dirtyRegions) {
 		Iterator dirtyFigures = dirtyRegions.keySet().iterator();
@@ -541,18 +531,14 @@ public void notifyPainting(Rectangle damage, Map dirtyRegions) {
 		}
 	}
 
-	/**
-	 * @see org.eclipse.draw2d.UpdateListener#notifyValidating()
-	 */
+	/** @see org.eclipse.draw2d.UpdateListener#notifyValidating() */
 	@Override
 	public void notifyValidating() {
 		// setDirty(true);
 		// revalidate();
 	}
 
-	/**
-	 * @see org.eclipse.draw2d.Figure#paintFigure(Graphics)
-	 */
+	/** @see org.eclipse.draw2d.Figure#paintFigure(Graphics) */
 	@Override
 	protected void paintFigure(Graphics graphics) {
 		Image thumbnail = getThumbnailImage();
@@ -605,4 +591,14 @@ public void setSource(IFigure fig) {
 		}
 	}
 
+	/**
+	 * Returns the target size of the thumbnail.
+	 *
+	 * @return the target size
+	 * @since 3.14
+	 */
+	protected Dimension getTargetSize() {
+		return targetSize;
+	}
+
 }