Changeset 6912 in josm for trunk/src/org/openstreetmap/josm/gui/util/CellEditorSupport.java

Timestamp:

2014-03-19T01:01:04+01:00 (10 years ago)

Author:

Don-vip

Message:

Refactor duplicated code

File:

• trunk/src/org/openstreetmap/josm/gui/util/CellEditorSupport.java (moved) (moved from trunk/src/org/openstreetmap/josm/gui/util/TableCellEditorSupport.java ) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/util/CellEditorSupport.java

@@ -6 +6 @@
 import java.util.List;
 
+import javax.swing.CellEditor;
 import javax.swing.event.CellEditorListener;
 import javax.swing.event.ChangeEvent;
 
-public class TableCellEditorSupport {
-    private Object editor;
-    private List<CellEditorListener> listeners;
+/**
+ * Utility class used to ease implementation of {@link CellEditor} interface,
+ * or one of its sub-interfaces, for classes that cannot extend {@link javax.swing.AbstractCellEditor}.
+ * @since 6912
+ */
+public class CellEditorSupport {
+    private final CellEditor editor;
+    private final List<CellEditorListener> listeners;
 
-    public TableCellEditorSupport(Object editor) {
+    /**
+     * Constructs a new {@code CellEditorSupport}.
+     * @param editor The cell editor backed by this
+     */
+    public CellEditorSupport(CellEditor editor) {
         this.editor = editor;
-        listeners = new LinkedList<CellEditorListener>();
+        this.listeners = new LinkedList<CellEditorListener>();
     }
 
@@ -24 +34 @@
     }
 
-    public void addCellEditorListener(CellEditorListener l) {
+    /**
+     * Worker for {@link CellEditor#addCellEditorListener(CellEditorListener)} method.
+     * @param l the CellEditorListener
+     */
+    public final void addCellEditorListener(CellEditorListener l) {
         synchronized (this) {
             if (l != null && ! listeners.contains(l)) {
@@ -31 +45 @@
         }
     }
-    public void removeCellEditorListener(CellEditorListener l) {
+
+    /**
+     * Worker for {@link CellEditor#removeCellEditorListener(CellEditorListener)} method.
+     * @param l the CellEditorListener
+     */
+    public final void removeCellEditorListener(CellEditorListener l) {
         synchronized (this) {
             if (l != null &&listeners.contains(l)) {
@@ -39 +58 @@
     }
 
-    public void fireEditingCanceled() {
+    /**
+     * Fires "editing canceled" event to listeners.
+     */
+    public final void fireEditingCanceled() {
         for (CellEditorListener listener: getListeners()) {
             listener.editingCanceled(new ChangeEvent(editor));
@@ -45 +67 @@
     }
 
-    public void fireEditingStopped() {
+    /**
+     * Fires "editing stopped" event to listeners.
+     */
+    public final void fireEditingStopped() {
         for (CellEditorListener listener: getListeners()) {
             listener.editingStopped(new ChangeEvent(editor));