diff app/view/window/ProbeCreate.js @ 890:def27cdd0dfa

Added Documentation to Windows
author Dustin Demuth <dustin@intevation.de>
date Thu, 23 Jul 2015 16:40:50 +0200
parents 392be36fe3ac
children 8054232535ba
line wrap: on
line diff
--- a/app/view/window/ProbeCreate.js	Thu Jul 23 16:40:28 2015 +0200
+++ b/app/view/window/ProbeCreate.js	Thu Jul 23 16:40:50 2015 +0200
@@ -26,6 +26,9 @@
 
     record: null,
 
+    /**
+     * This function initialises the Window
+     */
     initComponent: function() {
         this.title = 'ยง3-Probe';
         this.buttons = [{
@@ -59,24 +62,41 @@
         this.callParent(arguments);
     },
 
+     /**
+      * Initialise the Data of this Window
+      */
     initData: function() {
         var record = Ext.create('Lada.model.Probe');
         this.down('probeform').setRecord(record);
     },
 
+    /**
+     * Instructs the fields / forms listed in this method to set a message.
+     * @param errors These Errors shall be shown
+     * @param warnings These Warning shall be shown
+     */
     setMessages: function(errors, warnings) {
         this.down('probeform').setMessages(errors, warnings);
     },
 
+    /**
+     * Instructs the fields / forms listed in this method to clear their messages.
+     */
     clearMessages: function() {
         this.down('probeform').clearMessages();
     },
 
+    /**
+     * Disable the Childelements of this window
+     */
     disableChildren: function(){
         //intentionally!
         return true;
     },
 
+    /**
+     * Enable the Childelements of this window
+     */
     enableChildren: function(){
         //intentionally!
         return true;

http://lada.wald.intevation.org