API DOCUMENTATION

[gpl/argeo-slc.git] / org.argeo.slc.webapp / src / main / webapp / argeo-ria-src / class / org / argeo / ria / event / Command.js

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/event/Command.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/event/Command.js
index 9ad87c5b9a926e5d8505c7c69a17b74b5b659eef..127e20c516c729a11d6a67036b51c5ab0eadcb0b 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/event/Command.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/event/Command.js
@@ -117,12 +117,25 @@
                return button;\r
        },\r
          \r
+       /**\r
+        * Register a given callback to be shared by one or more focusable part.\r
+        * @param callback {Function} A callback function\r
+        * @param focusablePartId {String} A string identifiing a focusable part. At the moment, it can only be "view:viewId"\r
+        */\r
        registerCallback : function(callback, focusablePartId){\r
                this.callbacks[focusablePartId] = callback;\r
        },\r
+       /**\r
+        * Return all the registered callbacks for this command.\r
+        * @return {Map} A map of callback, viewId => callBack.\r
+        */\r
        getCallbacks : function(){\r
                return this.callbacks;\r
        },\r
+       /**\r
+        * Remove a callback for a given focusable part.\r
+        * @param focusablePartId {String} A id like "view:viewId".\r
+        */\r
        removeCallback : function(focusablePartId){\r
                if(this.callbacks[focusablePartId]){\r
                        delete this.callbacks[focusablePartId];\r