Mark several deprecated Draw2D fields and methods as "for removal"

ptziegler · azoitl · commit efb1ee1408b2 · 2025-07-30T19:13:08.000+02:00
A lot of those elements have been marked as deprecated since forever,
with replacements being available. By marking them for removal, we are
able to remove/internalize them after 2027.
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/Figure.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/Figure.java
@@ -100,33 +100,38 @@ public class Figure implements IFigure {
 	protected Dimension maxSize;
 
 	/**
-	 * @deprecated access using {@link #getLocalFont()}
+	 * @deprecated access using {@link #getLocalFont()}. This field will be made
+	 *             private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected Font font;
 
 	/**
-	 * @deprecated access using {@link #getLocalBackgroundColor()}.
+	 * @deprecated access using {@link #getLocalBackgroundColor()}. This field will
+	 *             be made private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected Color bgColor;
 
 	/**
-	 * @deprecated access using {@link #getLocalForegroundColor()}.
+	 * @deprecated access using {@link #getLocalForegroundColor()}. This field will
+	 *             be made private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected Color fgColor;
 
 	/**
-	 * @deprecated access using {@link #getBorder()}
+	 * @deprecated access using {@link #getBorder()} This field will be made private
+	 *             after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected Border border;
 
 	/**
-	 * @deprecated access using {@link #getToolTip()}
+	 * @deprecated access using {@link #getToolTip()} This field will be made
+	 *             private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected IFigure toolTip;
 
 	private AncestorHelper ancestorHelper;
@@ -2201,9 +2206,10 @@ public void setConstraint(IFigure child, Object constraint) {
 	/**
 	 * Iterates over a Figure's children in reverse order.
 	 *
-	 * @deprecated use ReverseFigureChildrenIterator instead
+	 * @deprecated use ReverseFigureChildrenIterator instead. This class will be
+	 *             removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static class FigureIterator {
 		private final List<? extends IFigure> list;
 		private int index;
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/FlowLayout.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/FlowLayout.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2024 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -42,17 +42,19 @@ protected class WorkingData {
 	/**
 	 * Constant to specify components to be aligned on the left/top
 	 *
-	 * @deprecated Use {@link OrderedLayout#ALIGN_TOPLEFT} instead.
+	 * @deprecated Use {@link OrderedLayout#ALIGN_TOPLEFT} instead. This field will
+	 *             be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final int ALIGN_LEFTTOP = ALIGN_TOPLEFT;
 
 	/**
 	 * Constant to specify components to be aligned on the right/bottom
 	 *
-	 * @deprecated Use {@link OrderedLayout#ALIGN_BOTTOMRIGHT} instead.
+	 * @deprecated Use {@link OrderedLayout#ALIGN_BOTTOMRIGHT} instead. This field
+	 *             will be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final int ALIGN_RIGHTBOTTOM = ALIGN_BOTTOMRIGHT;
 
 	protected WorkingData data = null;
@@ -62,36 +64,40 @@ protected class WorkingData {
 	 * row/column should be filled by the last item in that row/column.
 	 *
 	 * @deprecated Use {@link OrderedLayout#setStretchMinorAxis(boolean)} and
-	 *             {@link OrderedLayout#isStretchMinorAxis()} instead.
+	 *             {@link OrderedLayout#isStretchMinorAxis()} instead. This field
+	 *             will be made private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected boolean fill;
 
 	/**
 	 * The alignment along the major axis.
 	 *
 	 * @deprecated Use {@link #getMajorAlignment()} and
-	 *             {@link #setMajorAlignment(int)} instead.
+	 *             {@link #setMajorAlignment(int)} instead. This field will be made
+	 *             private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int majorAlignment = ALIGN_TOPLEFT;
 
 	/**
 	 * The spacing along the major axis.
 	 *
 	 * @deprecated Use {@link #getMajorSpacing()} and {@link #setMajorSpacing(int)}
-	 *             instead.
+	 *             instead. This field will be made private after the 2027-09
+	 *             release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int majorSpacing = 5;
 
 	/**
 	 * The spacing along the minor axis.
 	 *
 	 * @deprecated Use {@link #getMinorSpacing()} and {@link #setMinorSpacing(int)}
-	 *             instead.
+	 *             instead. This field will be made private after the 2027-09
+	 *             release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int minorSpacing = 5;
 
 	/**
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/LayeredPane.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/LayeredPane.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -130,11 +130,12 @@ public void removeLayer(Object key) {
 	/**
 	 * Removes the given layer from this layered pane.
 	 *
-	 * @deprecated call {@link IFigure#remove(IFigure)} instead
+	 * @deprecated call {@link IFigure#remove(IFigure)} instead. This method will be
+	 *             removed after the 2027-09 release.
 	 * @param layer the layer to be removed
 	 * @since 2.0
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public void removeLayer(IFigure layer) {
 		remove(layer);
 	}
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/OrderedLayout.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/OrderedLayout.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2024 IBM Corporation and others.
+ * Copyright (c) 2011, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -34,35 +34,37 @@ public abstract class OrderedLayout extends AbstractHintLayout {
 	 * Constant to specify components should be layed out horizontally
 	 *
 	 * @deprecated Pulled up from derived layout manager and deprecated here because
-	 *             unused.
+	 *             unused. This field will be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final boolean HORIZONTAL = true;
 	/**
 	 * Constant to specify components should be layed out vertically
 	 *
 	 * @deprecated Pulled up from derived layout manager and deprecated here because
-	 *             unused.
+	 *             unused. This field will be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final boolean VERTICAL = false;
 
 	/**
 	 * The horizontal property.
 	 *
 	 * @deprecated Use {@link #setHorizontal(boolean)} and {@link #isHorizontal()}
-	 *             instead.
+	 *             instead. This field will be made private after the 2027-09
+	 *             release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected boolean horizontal;
 
 	/**
 	 * The alignment along the minor axis.
 	 *
 	 * @deprecated Use {@link #getMinorAlignment()} and
-	 *             {@link #setMinorAlignment(int)} instead.
+	 *             {@link #setMinorAlignment(int)} instead. This field will be made
+	 *             private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int minorAlignment;
 
 	/**
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/SWTEventDispatcher.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/SWTEventDispatcher.java
@@ -32,9 +32,10 @@ public class SWTEventDispatcher extends EventDispatcher {
 	/**
 	 * Used to tell if any button is pressed without regard to the specific button.
 	 *
-	 * @deprecated Use {@link SWT#BUTTON_MASK} instead.
+	 * @deprecated Use {@link SWT#BUTTON_MASK} instead. This field will be removed
+	 *             after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected static final int ANY_BUTTON = SWT.BUTTON_MASK;
 
 	private boolean figureTraverse = true;
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/Shape.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/Shape.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2010 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -28,9 +28,10 @@ public abstract class Shape extends Figure {
 	 * The width of this shape's outline.
 	 *
 	 * @deprecated Use {@link #setLineWidth(int)} or
-	 *             {@link #setLineWidthFloat(float)} instead.
+	 *             {@link #setLineWidthFloat(float)} instead. This field will be
+	 *             made private with the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int lineWidth;
 
 	/**
@@ -47,9 +48,10 @@ public abstract class Shape extends Figure {
 	/**
 	 * The line style to be used for this shape's outline.
 	 *
-	 * @deprecated Use {@link #setLineStyle(int)} instead.
+	 * @deprecated Use {@link #setLineStyle(int)} instead. This field will be made
+	 *             private with the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int lineStyle;
 
 	/**
diff --git a/org.eclipse.draw2d/src/org/eclipse/draw2d/ToolbarLayout.java b/org.eclipse.draw2d/src/org/eclipse/draw2d/ToolbarLayout.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2024 IBM Corporation and others.
+ * Copyright (c) 2000, 2025 IBM Corporation and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
@@ -31,34 +31,36 @@ public class ToolbarLayout extends OrderedLayout {
 	/**
 	 * Constant for horizontal alignment
 	 *
-	 * @deprecated Unused.
+	 * @deprecated Unused. This field will be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final boolean HORIZONTAL = true;
 
 	/**
 	 * Constant for vertical alignment
 	 *
-	 * @deprecated Unused.
+	 * @deprecated Unused. This field will be removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public static final boolean VERTICAL = false;
 
 	/**
 	 * Sets whether children should "stretch" with their container
 	 *
 	 * @deprecated Use {@link OrderedLayout#setStretchMinorAxis(boolean)} and
-	 *             {@link OrderedLayout#isStretchMinorAxis()} instead.
+	 *             {@link OrderedLayout#isStretchMinorAxis()} instead. This field
+	 *             will be made private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected boolean matchWidth;
 
 	/**
 	 * Space in pixels between Figures
 	 *
 	 * @deprecated Use {@link #getSpacing()} and {@link #setSpacing(int)} instead.
+	 *             This field will be made private after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	protected int spacing;
 
 	/**
@@ -252,9 +254,10 @@ protected boolean isSensitiveVertically(IFigure parent) {
 	 * value is false.
 	 *
 	 * @return <code>true</code> if stretch minor axis is enabled
-	 * @deprecated Use {@link #isStretchMinorAxis()} instead.
+	 * @deprecated Use {@link #isStretchMinorAxis()} instead. This method will be
+	 *             removed after the 2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public boolean getStretchMinorAxis() {
 		return isStretchMinorAxis();
 	}
@@ -387,11 +390,12 @@ public void layout(IFigure parent) {
 	 * Sets children's width (if vertically oriented) or height (if horizontally
 	 * oriented) to stretch with their container.
 	 *
-	 * @deprecated use {@link #setStretchMinorAxis(boolean)}
+	 * @deprecated use {@link #setStretchMinorAxis(boolean)}. This method will be
+	 *             removed after the 2027-09 release.
 	 * @param match whether to stretch children
 	 * @since 2.0
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public void setMatchWidth(boolean match) {
 		matchWidth = match;
 	}
@@ -423,9 +427,10 @@ public void setStretchMinorAxis(boolean value) {
 	 * @param flag whether the orientation should be vertical
 	 * @since 2.0
 	 * @deprecated Use {@link #setHorizontal(boolean)} with argument
-	 *             <code>false</code> instead.
+	 *             <code>false</code> instead. This method will be removed after the
+	 *             2027-09 release.
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2025-09")
 	public void setVertical(boolean flag) {
 		setHorizontal(!flag);
 	}
