Changeset 4918 in josm for trunk/src/org/openstreetmap/josm/command/PseudoCommand.java

Timestamp:

2012-02-11T18:56:53+01:00 (13 years ago)

Author:

simon04

Message:

fix #7370 - Refactor Command.getDescription

File:

• trunk/src/org/openstreetmap/josm/command/PseudoCommand.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/command/PseudoCommand.java

@@ -3 +3 @@
 
 import java.util.Collection;
+import javax.swing.Icon;
+import javax.swing.JLabel;
 
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
@@ -14 +16 @@
     /**
      * Provide a description that can be presented in a list or tree view.
+     * @deprecated This abstract method is deprecated.
+     * On 2012-03-01, this abstract method will be removed.
+     * At the same moment, the methods {@link #getDescrpitionText()} and {@link #getDescrpitionIcon()}
+     * will be made abstract.
+     * For a smooth transition, replace {@link #getDescription()} by implementations of
+     * {@link #getDescrpitionText()} and {@link #getDescrpitionIcon()} as early as possible.
+     * {@link #getDescription()} is no longer abstract and can therefore be removed.
      */
-    abstract public Object getDescription();
+    @Deprecated
+    public Object getDescription() {
+        return null;
+    }
+
+    /**
+     * Provides a description text representing this command.
+     */
+    public String getDescriptionText() {
+        Object o = getDescription();
+        if (o instanceof JLabel) {
+            return ((JLabel) o).getText();
+        } else {
+            return o.toString();
+        }
+    }
+
+    /**
+     * Provides a descriptive icon of this command.
+     */
+    public Icon getDescriptionIcon() {
+        Object o = getDescription();
+        if (o instanceof JLabel) {
+            return ((JLabel) o).getIcon();
+        } else {
+            return null;
+        }
+    }
 
     /**