Changeset 12384 in josm for trunk/src/org/openstreetmap/josm/gui/tagging

Timestamp:

2017-06-10T00:55:46+02:00 (7 years ago)

Author:

michael2402

Message:

Doument the gui.tagging package

Location:

trunk/src/org/openstreetmap/josm/gui/tagging

Files:

• TagCellEditor.java (modified) (2 diffs)
• TagEditorModel.java (modified) (2 diffs)
• TagTable.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/gui/tagging/TagCellEditor.java

@@ -142 +142 @@
     }
 
+    /**
+     * Sets the manager that helps with auto completion
+     * @param autocomplete The {@link AutoCompletionManager}
+     */
     public void setAutoCompletionManager(AutoCompletionManager autocomplete) {
         this.autocomplete = autocomplete;
     }
 
+    /**
+     * Selects an item from the auto completion list and fills this cell with the value
+     * @param item The text that was selected
+     */
     public void autoCompletionItemSelected(String item) {
         editor.setText(item);
@@ -152 +160 @@
     }
 
+    /**
+     * Gets the editor for this cell
+     * @return The editor text field
+     */
     public AutoCompletingTextField getEditor() {
         return editor;

trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java

@@ -35 +35 @@
  */
 public class TagEditorModel extends AbstractTableModel {
+    /**
+     * The dirty property. It is set whenever this table was changed
+     */
     public static final String PROP_DIRTY = TagEditorModel.class.getName() + ".dirty";
 
@@ -257 +260 @@
     }
 
+    /**
+     * Gets a tag row
+     * @param idx The index of the row
+     * @return The tag model for that row
+     */
     public TagModel get(int idx) {
         return idx >= tags.size() ? null : tags.get(idx);

trunk/src/org/openstreetmap/josm/gui/tagging/TagTable.java

@@ -415 +415 @@
     }
 
+    /**
+     * Sets the autocompletion manager that should be used for editing the cells
+     * @param autocomplete The {@link AutoCompletionManager}
+     */
     public void setAutoCompletionManager(AutoCompletionManager autocomplete) {
         if (autocomplete == null) {
@@ -426 +430 @@
     }
 
+    /**
+     * Gets the {@link AutoCompletionList} the cell editor is synchronized with
+     * @return The list
+     */
     public AutoCompletionList getAutoCompletionList() {
         if (editor != null)
@@ -441 +449 @@
     }
 
+    /**
+     * Gets the editor that is used for the table cells
+     * @return The editor that is used when the user wants to enter text into a cell
+     */
     public TagCellEditor getTableCellEditor() {
         return editor;
@@ -457 +469 @@
     }
 
+    /**
+     * Request the focus in a specific cell
+     * @param row The row index
+     * @param col The column index
+     */
     public void requestFocusInCell(final int row, final int col) {
         changeSelection(row, col, false, false);
@@ -472 +489 @@
     }
 
+    /**
+     * Marks a component that may be focused without stopping the cell editing
+     * @param component The component
+     */
     public void addComponentNotStoppingCellEditing(Component component) {
         if (component == null) return;
@@ -477 +498 @@
     }
 
+    /**
+     * Removes a component added with {@link #addComponentNotStoppingCellEditing(Component)}
+     * @param component The component
+     */
     public void removeComponentNotStoppingCellEditing(Component component) {
         if (component == null) return;