Changeset 6733 in josm for trunk/src/org/openstreetmap/josm/gui/preferences/imagery/WMSLayerTree.java

Timestamp:

2014-01-19T15:33:15+01:00 (12 years ago)

Author:

Don-vip

Message:

update javadoc

File:

• trunk/src/org/openstreetmap/josm/gui/preferences/imagery/WMSLayerTree.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/imagery/WMSLayerTree.java

@@ -20 +20 @@
 import org.openstreetmap.josm.io.imagery.WMSImagery;
 
+/**
+ * The layer tree of a WMS server.
+ */
 public class WMSLayerTree {
     private final MutableTreeNode treeRootNode = new DefaultMutableTreeNode();
@@ -27 +30 @@
     private boolean previouslyShownUnsupportedCrsError = false;
 
+    /**
+     * Returns the root node.
+     * @return The root node
+     */
     public MutableTreeNode getTreeRootNode() {
         return treeRootNode;
     }
 
+    /**
+     * Returns the {@code JTree}.
+     * @return The {@code JTree}
+     */
     public JTree getLayerTree() {
         return layerTree;
     }
 
+    /**
+     * Returns the list of selected layers.
+     * @return the list of selected layers
+     */
     public List<WMSImagery.LayerDetails> getSelectedLayers() {
         return selectedLayers;
@@ -55 +70 @@
     }
 
+    /**
+     * Updates the whole tree with the given WMS imagery info.
+     * @param wms The imagery info for a given WMS server
+     */
     public void updateTree(WMSImagery wms) {
         treeRootNode.setUserObject(wms.getServiceUrl().getHost());
@@ -60 +79 @@
     }
 
+    /**
+     * Updates the list of WMS layers.
+     * @param layers The list of layers to add to the root node
+     */
     public void updateTreeList(List<WMSImagery.LayerDetails> layers) {
         addLayersToTreeData(getTreeRootNode(), layers);