API Documentation

[gpl/argeo-slc.git] / org.argeo.slc.webapp / src / main / webapp / source / class / org / argeo / ria / components / IView.js

diff --git a/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/IView.js b/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/IView.js
index 619aecad44dc28ed10ad2d4666b3f117b100e756..3d3cd1aa3797aa7b3514a98e4b99369af1ecdfc5 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/IView.js
+++ b/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/IView.js
@@ -1,6 +1,13 @@
 /**\r
- * @author Charles du Jeu\r
+ * Interface for a standard 'view' of an argeo RIA. A view is an independant applet that \r
+ * will be integrated inside a ViewPane. \r
+ * \r
+ * The typical lifecycle of an IView will be the following :\r
+ * <br>+ init(viewPane) : initialize basic GUI in the viewPane\r
+ * <br>+ getCommands() : wire the commands and add them to the toolbars/menubars\r
+ * <br>+ load(data) : loads the data itself.\r
  * \r
+ * @author Charles du Jeu\r
  */\r
 qx.Interface.define("org.argeo.ria.components.IView", {\r
        \r
@@ -9,14 +16,23 @@ qx.Interface.define("org.argeo.ria.components.IView", {
        },\r
        \r
        members : {\r
-               init : function(viewPane){\r
-                       return true;\r
-               },\r
-               load : function(data){\r
-                       return true;\r
-               },\r
-               addScroll : function(){\r
-                       return true;\r
-               }\r
+               /**\r
+                * The implementation should contain the GUI initialisation.\r
+                * @param viewPane {org.argeo.ria.components.ViewPane} The pane manager\r
+                * @return {Boolean}\r
+                */\r
+               init : function(viewPane){return true;},\r
+               /**\r
+                * The implementation should contain the real data loading (i.o. query...)\r
+                * @param data {mixed} Any data in any format\r
+                * @return {Boolean}\r
+                */\r
+               load : function(data){return true;},\r
+               /**\r
+                * Whether this component is already contained in a scroller \r
+                * (return false) or not (return true).\r
+                * @return {Boolean}\r
+                */\r
+               addScroll : function(){return true;}\r
        }\r
 });
\ No newline at end of file