Refresh by Interval

Automatically Reload the content and page after a certain interval

Author: joelvdgraaf

src/DataviewLoader/DataviewLoader.xml

@@ -34,6 +34,11 @@
                 <attributeType name="Boolean" />
             </attributeTypes>
         </property>
+        <property key="refreshTime" type="integer" defaultValue="0">
+            <caption>Reload each seconds</caption>
+            <category>Refresh</category>
+            <description>Reload the content each X interval of seconds. 0 = disabled</description>
+        </property>
         <property key="fadeContent" type="boolean" defaultValue="false">
             <caption>Fade in content</caption>
             <category>Behavior</category>

src/DataviewLoader/widget/DataviewLoader.js

@@ -40,7 +40,7 @@ define([
 
         // DOM elements
         divContent: null,
-        divLoader: null,        
+        divLoader: null,
 
         // Internal variables. Non-primitives created in the prototype are shared between all widget instances.
         _handles: null,
@@ -49,7 +49,7 @@ define([
         _pageInitiated: false,
         _form: null,
         active: true,
-        prevForm : null,
+        prevForm: null,
         // dojo.declare.constructor is called to construct the widget instance. Implement to initialize non-primitive properties.
         constructor: function () {
             //logger.debug(this.id + ".constructor");
@@ -59,26 +59,26 @@ define([
         // dijit._WidgetBase.postCreate is called after constructing the widget. Implement to do extra setup work.
         postCreate: function () {
             logger.debug(this.id + ".postCreate");
-            
-            
+
+
             this._updateRendering();
             this._setupEvents();
         },
 
         // mxui.widget._WidgetBase.update is called when context is changed or initialized. Implement to re-render and / or fetch data.
         update: function (obj, callback) {
-            if(this._contextObj !== obj){
+            if (this._contextObj !== obj) {
                 console.log(this.id + ".update on new object");
                 this._loadingStarted = false;
                 this._pageInitiated = false;
-                
+
                 this._contextObj = obj;
                 this._resetSubscriptions();
                 this._updateRendering(callback); // We're passing the callback to updateRendering to be called after DOM-manipulation
             } else {
                 // The callback, coming from update, needs to be executed, to let the page know it finished rendering
                 this._executeCallback(callback, "update");
-            } 
+            }
         },
 
         // mxui.widget._WidgetBase.enable is called when the widget should enable editing. Implement to enable editing if widget is input widget.
@@ -96,13 +96,13 @@ define([
             console.log(this.id + ".resize");
             // TODO: How to handle tabs and conditional visibility
             if (this.domNode.offsetParent !== null && this.visibilityCheck) {
-                if(this.refreshAction == "Attribute" && this.refreshtAttr && this._contextObj) {
+                if (this.refreshAction == "Attribute" && this.refreshtAttr && this._contextObj) {
                     if (this._contextObj.get(this.refreshtAttr))
                         this._loadAndShowcontent();
                     else
                         console.log(this.id + ".resize Skip because " + this.refreshtAttr + " is false");
                 } else {
-                    this._loadAndShowcontent();   
+                    this._loadAndShowcontent();
                 }
             }
         },
@@ -112,8 +112,8 @@ define([
             logger.debug(this.id + ".uninitialize");
             // Clean up listeners, helper objects, etc. There is no need to remove listeners added with this.connect / this.subscribe / this.own.
             this.active = false;
-			
-			if(this._form != null){
+
+            if (this._form != null) {
                 this._form.destroy();
             }
         },
@@ -128,25 +128,39 @@ define([
 
         // Attach events to HTML dom elements
         _setupEvents: function () {
-            //logger.debug(this.id + "._setupEvents");
-            if(this.fadeContent){
+            // Set fading of content
+            if (this.fadeContent) {
                 dojoClass.add(this.divContent, "loaderfade");
             }
+
+            // Set refreshing each time
+            if (this.refreshTime > 0) {
+                setInterval(dojoLang.hitch(this, function () {
+                    if (this._loadingStarted == false) {
+                        if (this.pageMF) {
+                            this._pageInitiated = false;
+                        }
+                        this._updateRendering();
+                    } else {
+                        console.log(this.id + ".Refresh skip because of loading started.");
+                    }
+                }), this.refreshTime * 1000);
+            }
         },
 
         // Rerender the interface.
         _updateRendering: function (callback) {
             logger.debug(this.id + "._updateRendering");
 
             if (this._contextObj) {
-                if(this.loadingText){
-                    var text = "<div class=\"text-center\"><h3 class=\"loaderheader\">"+this.loadingText+"</h3></div>";
+                if (this.loadingText && this.divLoader.innerHTML.indexOf(this.loadingText) === -1) {
+                    var text = "<div class=\"text-center\"><h3 class=\"loaderheader\">" + this.loadingText + "</h3></div>";
                     this.divLoader.innerHTML = text + this.divLoader.innerHTML;
                 }
-                
+
                 dojoStyle.set(this.divContent, "display", "none");
                 dojoStyle.set(this.divLoader, "display", "block");
-                
+
                 if (this.domNode.offsetParent !== null || !this.visibilityCheck) {
                     this._loadAndShowcontent();
                 }
@@ -158,7 +172,7 @@ define([
 
         _loadAndShowcontent: function () {
             logger.debug(this.id + "._loadAndShowcontent");
-            if(this._loadingStarted == false){
+            if (this._loadingStarted == false) {
                 this._loadingStarted = true;
                 if (this._contextObj && this.loadingMF) {
                     this._execMf(this.loadingMF, this._contextObj.getGuid(), this._processMicroflowCallback, this._processMicroflowFailure);
@@ -171,26 +185,26 @@ define([
         _processMicroflowCallback: function (objs) {
             logger.debug(this.id + '._processMicroflowCallback');
             if (this.active) {
-                if(this.asyncCall)
+                if (this.asyncCall)
                     this._setPage(this._contextObj);
                 else
                     this._setPage(objs[0]);
             } else {
-                 console.info(this.id + "._processMicroflowCallback Skip loading because widget is destroyed.");
+                console.info(this.id + "._processMicroflowCallback Skip loading because widget is destroyed.");
             }
         },
-        _processMicroflowFailure: function (){
-            if(this.errorText){
-                if(this._pageInitiated)
+        _processMicroflowFailure: function () {
+            if (this.errorText) {
+                if (this._pageInitiated)
                     this._form.close();
                 this._pageInitiated = false;
-                this.divContent.innerHTML= "<div class=\"text-center\"><h3 class=\"loaderheader\">"+this.errorText+"</h3></div>";
+                this.divContent.innerHTML = "<div class=\"text-center\"><h3 class=\"loaderheader\">" + this.errorText + "</h3></div>";
 
                 this._showPage();
             }
         },
-        
-        _openFormByFormProp : function (pageContext){
+
+        _openFormByFormProp: function (pageContext) {
             var props = {
                 location: "node",
                 domNode: this.divContent,
@@ -199,14 +213,14 @@ define([
                     console.log(error.description);
                 }
             };
-            
-            if(pageContext)
+
+            if (pageContext)
                 props.context = pageContext;
             this._form = mx.ui.openForm(this.pageContent, props);
         },
-        
-        _openFormByMF : function(pageObj, pageContext){
-            this._execMf(this.pageMF, pageObj.getGuid(), function(response){
+
+        _openFormByMF: function (pageObj, pageContext) {
+            this._execMf(this.pageMF, pageObj.getGuid(), function (response) {
                 this._form = mx.ui.openForm(response, {
                     context: pageContext,
                     location: "node",
@@ -216,55 +230,57 @@ define([
                         console.log(error.description);
                     }
                 });
-            }, function(){alert("Error bij aanroepen custom form MF");});
+            }, function () {
+                alert("Error bij aanroepen custom form MF");
+            });
         },
 
         _setPage: function (pageObj) {
             logger.debug(this.id + '._setPage');
 
-            if(this._pageInitiated) {
+            if (this._pageInitiated) {
                 if (this._loadingStarted) {
                     this._showPage();
                 } else {
                     console.log(this.id + "_setPage skip because already set.");
                 }
             } else {
                 this._pageInitiated = true;
-                this.divContent.innerHTML= "";
+                this.divContent.innerHTML = "";
                 console.log(this.id + "_setPage");
                 if (pageObj) {
                     var pageContext = new mendix.lib.MxContext();
                     pageContext.setTrackObject(pageObj);
-                    
-                    if(this.pageMF != null  && this.pageMF != '')
+
+                    if (this.pageMF != null && this.pageMF != '')
                         this._openFormByMF(pageObj, pageContext);
-                    else 
+                    else
                         this._openFormByFormProp(pageContext);
-                    
+
                 } else {
-                    if(this.pageMF != null  && this.pageMF != '')
+                    if (this.pageMF != null && this.pageMF != '')
                         alert("Page microflow is not supported without context");
-                    else 
+                    else
                         this._openFormByFormProp();
-                    
+
                 }
             }
         },
 
         _showPage: function (mxform) {
             logger.debug(this.id + "._showPage on form");
-            
-            if(this.prevForm != null && mxform != null){
+
+            if (this.prevForm != null && mxform != null) {
                 this.prevForm.destroy();
             }
             this.prevForm = mxform;
-            
+
             dojoStyle.set(this.divContent, "display", "block");
             dojoStyle.set(this.divLoader, "display", "none");
-            
+
             this._loadingStarted = false;
         },
-        
+
         // Reset subscriptions.
         _resetSubscriptions: function () {
             logger.debug(this.id + "._resetSubscriptions");
@@ -277,37 +293,39 @@ define([
                 this.subscribe({
                     guid: this._contextObj.getGuid(),
                     callback: dojoLang.hitch(this, function (guid) {
-                        if(this._loadingStarted == false){
-                            if(this.pageMF) {
+                        if (this._loadingStarted == false) {
+                            if (this.pageMF) {
                                 this._pageInitiated = false;
                             }
-                            if(this.refreshAction == "Attribute" && this.refreshtAttr && this._contextObj.get(this.refreshtAttr)){
+                            if (this.refreshAction == "Attribute" && this.refreshtAttr && this._contextObj.get(this.refreshtAttr)) {
                                 console.log(this.id + ".Refresh triggered on attribute change.");
                                 this._updateRendering();
-                            } else if(this.refreshAction == "Object") {
+                            } else if (this.refreshAction == "Object") {
                                 console.log(this.id + ".Refresh triggered on object change.");
                                 this._updateRendering();
-                            }                        
+                            }
                         } else {
                             console.log(this.id + ".Refresh skip because of loading started.");
                         }
                     })
                 });
             }
         },
-                
+
         _execMf: function (mf, guid, cb, cbfailure) {
             logger.debug(this.id + "._execMf" + (mf ? ": " + mf : ""));
             if (mf && guid) {
-                mx.ui.action(mf, {
-                    async : this.asyncCall,
+                mx.data.action({
                     params: {
                         applyto: "selection",
+                        actionname: mf,
                         guids: [guid]
                     },
+                    async: this.asyncCall,
+                    origin: this.mxform,
                     callback: (cb && typeof cb === "function" ? dojoLang.hitch(this, cb) : null),
                     error: (cbfailure && typeof cbfailure === "function" ? dojoLang.hitch(this, cbfailure) : null)
-                }, this);
+                });
             }
         },
 
@@ -320,4 +338,4 @@ define([
     });
 });
 
-require(["DataviewLoader/widget/DataviewLoader"]);
+require(["DataviewLoader/widget/DataviewLoader"]);

src/package.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <package xmlns="http://www.mendix.com/package/1.0/">
-    <clientModule name="DataviewLoader" version="2.1.0" xmlns="http://www.mendix.com/clientModule/1.0/">
+    <clientModule name="DataviewLoader" version="2.2.0" xmlns="http://www.mendix.com/clientModule/1.0/">
         <widgetFiles>
             <widgetFile path="DataviewLoader/DataviewLoader.xml" />
         </widgetFiles>

test/.mendix-cache/base_data

@@ -1 +1 @@
-29
+33

test/.mendix-cache/base_rev

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" path="javasource"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="lib" path="C:/Program Files/Mendix/8.2.2.60770/runtime/bundles/com.mendix.json.jar"/><classpathentry kind="lib" path="C:/Program Files/Mendix/8.2.2.60770/runtime/bundles/com.mendix.logging-api.jar"/><classpathentry kind="lib" path="C:/Program Files/Mendix/8.2.2.60770/runtime/bundles/com.mendix.m2ee-api.jar"/><classpathentry kind="lib" path="C:/Program Files/Mendix/8.2.2.60770/runtime/bundles/com.mendix.public-api.jar"/><classpathentry kind="lib" path="C:/Program Files/Mendix/8.2.2.60770/runtime/bundles/javax.servlet-api.servlet.jar"/>
+	<classpathentry kind="lib" path="userlib/animal-sniffer-annotations-1.17.jar"/><classpathentry kind="lib" path="userlib/antisamy-1.5.3.jar"/><classpathentry kind="lib" path="userlib/axiom-api-1.2.12.jar"/><classpathentry kind="lib" path="userlib/checker-qual-2.5.2.jar"/><classpathentry kind="lib" path="userlib/com.google.guava-14.0.1.jar"/><classpathentry kind="lib" path="userlib/com.springsource.org.apache.batik.css-1.7.0.jar"/><classpathentry kind="lib" path="userlib/commons-codec-1.10.jar"/><classpathentry kind="lib" path="userlib/commons-io-2.6.jar"/><classpathentry kind="lib" path="userlib/commons-lang-2.5.jar"/><classpathentry kind="lib" path="userlib/commons-lang3-3.7.jar"/><classpathentry kind="lib" path="userlib/commons-logging-1.1.jar"/><classpathentry kind="lib" path="userlib/commons-logging-1.2.jar"/><classpathentry kind="lib" path="userlib/error_prone_annotations-2.2.0.jar"/><classpathentry kind="lib" path="userlib/fontbox-2.0.13.jar"/><classpathentry kind="lib" path="userlib/guava-27.0-jre.jar"/><classpathentry kind="lib" path="userlib/guice-2.0.jar"/><classpathentry kind="lib" path="userlib/j2objc-annotations-1.1.jar"/><classpathentry kind="lib" path="userlib/jempbox-1.8.5.jar"/><classpathentry kind="lib" path="userlib/joda-time-2.9.6.jar"/><classpathentry kind="lib" path="userlib/jsr305-3.0.2.jar"/><classpathentry kind="lib" path="userlib/nekohtml.jar"/><classpathentry kind="lib" path="userlib/openid4java-1.0.0.jar"/><classpathentry kind="lib" path="userlib/org.apache.commons.fileupload-1.2.1.jar"/><classpathentry kind="lib" path="userlib/org.apache.commons.io-2.3.0.jar"/><classpathentry kind="lib" path="userlib/org.apache.commons.lang3.jar"/><classpathentry kind="lib" path="userlib/org.apache.httpcomponents.httpclient-osgi.jar"/><classpathentry kind="lib" path="userlib/org.apache.httpcomponents.httpcore-osgi.jar"/><classpathentry kind="lib" path="userlib/owasp-java-html-sanitizer-20181114.1.jar"/><classpathentry kind="lib" path="userlib/pdfbox-2.0.13.jar"/><classpathentry kind="lib" path="userlib/pdfbox-app-2.0.3.jar"/><classpathentry kind="lib" path="userlib/xml-apis-ext.jar"/>
+	<classpathentry kind="output" path="deployment/run/bin"/>
+</classpath>