org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/IView.js

   1 /**
   2  * Interface for a standard 'view' of an argeo RIA. A view is an independant applet that
   3  * will be integrated inside a ViewPane.
   4  *
   5  * The typical lifecycle of an IView will be the following :
   6  * <br>+ init(viewPane) : initialize basic GUI in the viewPane
   7  * <br>+ getCommands() : wire the commands and add them to the toolbars/menubars
   8  * <br>+ load(data) : loads the data itself.
   9  *
  10  * @author Charles du Jeu
  11  */
  12 qx.Interface.define("org.argeo.ria.components.IView", {
  13
  14         properties : {
  15                 commands : {}
  16         },
  17
  18         members : {
  19                 /**
  20                  * The implementation should contain the GUI initialisation.
  21                  * @param viewPane {org.argeo.ria.components.ViewPane} The pane manager
  22                  * @return {Boolean}
  23                  */
  24                 init : function(viewPane){return true;},
  25                 /**
  26                  * The implementation should contain the real data loading (i.o. query...)
  27                  * @param data {mixed} Any data in any format
  28                  * @return {Boolean}
  29                  */
  30                 load : function(data){return true;},
  31                 /**
  32                  * Whether this component is already contained in a scroller
  33                  * (return false) or not (return true).
  34                  * @return {Boolean}
  35                  */
  36                 addScroll : function(){return true;}
  37         }
  38 });