changeset 87:dd6308fbfe62

Document some custom methods
author Omair Majid <omajid@redhat.com>
date Mon, 20 Jan 2014 17:49:33 -0500
parents cedb20f38dc5
children c9a209ff2ee3
files com.redhat.thermostat.tools.eclipse.plugin/src/com/redhat/thermostat/tools/eclipse/plugin/editor/BaseMasterDetailsBlock.java
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/com.redhat.thermostat.tools.eclipse.plugin/src/com/redhat/thermostat/tools/eclipse/plugin/editor/BaseMasterDetailsBlock.java	Mon Jan 20 16:34:16 2014 -0500
+++ b/com.redhat.thermostat.tools.eclipse.plugin/src/com/redhat/thermostat/tools/eclipse/plugin/editor/BaseMasterDetailsBlock.java	Mon Jan 20 17:49:33 2014 -0500
@@ -106,11 +106,21 @@
         });
     }
 
+    /** Return the name of the section */
     abstract String getSectionTitle();
 
+    /** Return the model object to use in the master list */
     abstract Object[] getListViewModel();
 
+    /** Invoked when the 'add' button is selected */
     abstract void addButtonSelected(Shell shell);
 
+    /**
+     * Invoked when the remove button is selected. The {@code selectedItem}
+     * should be removed from the model.
+     *
+     * @param selectedItem
+     *            the item currently selected.
+     */
     abstract void removeButtonSelected(Object selectedItem);
 }