Changeset 12372 in josm for trunk/src/org/openstreetmap/josm

Timestamp:

2017-06-09T21:06:35+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: Document package gui.dialogs.changeset

Location:

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset

Files:

• ChangesetListCellRenderer.java (modified) (1 diff)
• ChangesetListModel.java (modified) (7 diffs)
• ChangesetsInActiveDataLayerListModel.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetListCellRenderer.java

@@ -14 +14 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 
+/**
+ * This class renders the cells in a {@link ChangesetListModel}.
+ */
 public class ChangesetListCellRenderer extends JLabel implements ListCellRenderer<Changeset> {
 

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetListModel.java

@@ -20 +20 @@
 import org.openstreetmap.josm.data.osm.Storage;
 
+/**
+ * This is the model that backs a list of changesets
+ */
 public class ChangesetListModel extends DefaultListModel<Changeset> implements ChangesetCacheListener {
     private final transient List<Changeset> data = new ArrayList<>();
@@ -25 +28 @@
     private final DefaultListSelectionModel selectionModel;
 
+    /**
+     * Creates a new {@link ChangesetListModel}
+     * @param selectionModel The selection model to use for this list
+     */
     public ChangesetListModel(DefaultListSelectionModel selectionModel) {
         this.selectionModel = selectionModel;
     }
 
+    /**
+     * Gets the list of changesets that are currently selected
+     * @return The selected changesets
+     */
     public Set<Changeset> getSelectedChangesets() {
         Set<Changeset> ret = new HashSet<>();
@@ -39 +50 @@
     }
 
+    /**
+     * Gets the IDs of the changesets that are selected
+     * @return The selected ids
+     */
     public Set<Integer> getSelectedChangesetIds() {
         Set<Integer> ret = new HashSet<>();
@@ -49 +64 @@
     }
 
+    /**
+     * Sets the changesets to select
+     * @param changesets The changesets
+     */
     public void setSelectedChangesets(Collection<Changeset> changesets) {
         selectionModel.setValueIsAdjusting(true);
@@ -86 +105 @@
     }
 
+    /**
+     * Loads this list with the given changesets
+     * @param ids The ids of the changesets to display
+     */
     public void initFromChangesetIds(Collection<Integer> ids) {
         if (ids == null || ids.isEmpty()) {
@@ -101 +124 @@
     }
 
+    /**
+     * Loads this list with the given changesets
+     * @param primitives The primitives of which the changesets should be displayed
+     */
     public void initFromPrimitives(Collection<? extends OsmPrimitive> primitives) {
         if (primitives == null) {
@@ -116 +143 @@
     }
 
+    /**
+     * Loads this list with the given changesets
+     * @param ds The data set to get all changesets from
+     */
     public void initFromDataSet(DataSet ds) {
         if (ds == null) {

trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/ChangesetsInActiveDataLayerListModel.java

@@ -23 +23 @@
 public class ChangesetsInActiveDataLayerListModel extends ChangesetListModel implements DataSetListener, ActiveLayerChangeListener {
 
+    /**
+     * Creates a new {@link ChangesetsInActiveDataLayerListModel}
+     * @param selectionModel The selection model for the list
+     */
     public ChangesetsInActiveDataLayerListModel(DefaultListSelectionModel selectionModel) {
         super(selectionModel);