5.18 compatible

added onclick microflow functionality

Author: RoelandSalij

.gitignore

@@ -0,0 +1,15 @@
+test/javasource/
+test/deployment/
+test/.classpath
+test/.project
+*.launch
+*.tmp
+*.lock
+.idea/
+
+dist/
+
+node_modules/
+.editorconfig
+*DS_Store*
+.vscode/

.jshintrc

@@ -0,0 +1,22 @@
+{
+    // Enforcing
+    "curly"    : false,
+    "forin"    : false,
+    "latedef"  : "nofunc",
+    "newcap"   : true,
+    "quotmark" : "double",
+    "eqeqeq"   : true,
+    "undef"    : true,
+    "globals"  : {
+        "mendix" : false,
+        "mx"     : false
+    },
+
+    // Relaxing
+    "laxbreak" : true,
+
+    // Environments
+    "browser"  : true,
+    "devel"    : true,
+    "dojo"     : true
+}

Gruntfile.js

@@ -0,0 +1,145 @@
+// Generated on 2015-12-03 using generator-mendix 1.0.0 :: http://github.com/[object Object]
+'use strict';
+
+var path = require('path'),
+    mendixApp = require('node-mendix-modeler-path'),
+    base64 = require('node-base64-image'),
+    fs = require('fs'),
+    xml2js = require('xml2js'),
+    parser = new xml2js.Parser(),
+    builder = new xml2js.Builder(),
+    shelljs = require('shelljs');
+
+// In case you seem to have trouble starting Mendix through `grunt start-mendix`, you might have to set the path to the Mendix application.
+// If it works, leave MODELER_PATH at null
+var MODELER_PATH = null;
+var MODELER_ARGS = '/file:{path}';
+
+// In case you have a different path to the test project (currently in ./test/Test.mpr) point TEST_PATH to the Test-project (full path). Otherwise, leave at null
+var TEST_PATH = null;
+// Use this example if you want to point it to a different subfolder and specific Test project Name:
+// var TEST_PATH = path.join(shelljs.pwd(), './<custom folder>/<Custom Test Project Name>.mpr');
+
+module.exports = function (grunt) {
+  var pkg = grunt.file.readJSON("package.json");
+  grunt.verbose;
+  grunt.initConfig({
+    watch: {
+      autoDeployUpdate: {
+        "files": [ "./src/**/*" ],
+        "tasks": [ "newer:copy", "compress" ],
+        options: {
+          debounceDelay: 250,
+          livereload: true
+        }
+      }
+    },
+    compress: {
+      makezip: {
+        options: {
+          archive: "./dist/" + pkg.name + ".mpk",
+          mode: "zip"
+        },
+        files: [{
+            expand: true,
+            date: new Date(),
+            store: false,
+            cwd: "./src",
+            src: ["**/*"]
+          }]
+      }
+    },
+    copy: {
+      deployment: {
+        files: [
+          { dest: "./test/deployment/web/widgets", cwd: "./src/", src: ["**/*"], expand: true }
+        ]
+      },
+      mpks: {
+        files: [
+          { dest: "./test/widgets", cwd: "./dist/", src: [ pkg.name + ".mpk"], expand: true }
+        ]
+      }
+    },
+    clean: {
+      build: [
+          "./dist/" + pkg.name + "/*",
+          "./test/deployment/web/widgets/" + pkg.name + "/*",
+          "./test/widgets/" + pkg.name + ".mpk"
+        ]
+    }
+  });
+
+  grunt.loadNpmTasks("grunt-contrib-compress");
+  grunt.loadNpmTasks("grunt-contrib-clean");
+  grunt.loadNpmTasks("grunt-contrib-watch");
+  grunt.loadNpmTasks("grunt-contrib-copy");
+  grunt.loadNpmTasks("grunt-newer");
+
+  grunt.registerTask("start-mendix", function () {
+    var done = this.async(),
+        testProjectPath = TEST_PATH !== null ? TEST_PATH : path.join(shelljs.pwd(), '/test/Test.mpr');
+
+    if (MODELER_PATH !== null || (mendixApp.err === null && mendixApp.output !== null && mendixApp.output.cmd && mendixApp.output.arg)) {
+      grunt.util.spawn({
+        cmd: MODELER_PATH || mendixApp.output.cmd,
+        args: [
+          (MODELER_PATH !== null ? MODELER_ARGS : mendixApp.output.arg).replace('{path}', testProjectPath)
+        ]
+      }, function () {
+        done();
+      });
+    } else {
+      console.error('Cannot start Modeler, see error:');
+      console.log(mendixApp.err);
+      done();
+    }
+  });
+
+  grunt.registerTask("generate-icon", function () {
+    var iconPath = path.join(shelljs.pwd(), '/icon.png'),
+        widgetXml = path.join(shelljs.pwd(), '/src/', pkg.name, '/', pkg.name + '.xml'),
+        options = {localFile: true, string: true},
+        done = this.async();
+
+    grunt.log.writeln('Processing icon');
+
+    if (!grunt.file.exists(iconPath) || !grunt.file.exists(widgetXml)) {
+      grunt.log.error("can't generate icon");
+      return done();
+    }
+
+    base64.base64encoder(iconPath, options, function (err, image) {
+      if (!err) {
+        var xmlOld = grunt.file.read(widgetXml);
+        parser.parseString(xmlOld, function (err, result) {
+          if (!err) {
+            if (result && result.widget && result.widget.icon) {
+              result.widget.icon[0] = image;
+            }
+            var xmlString = builder.buildObject(result);
+            grunt.file.write(widgetXml, xmlString);
+            done();
+          }
+        });
+      }
+    });
+  });
+
+  grunt.registerTask(
+    "default",
+    "Watches for changes and automatically creates an MPK file, as well as copying the changes to your deployment folder",
+    [ "watch" ]
+  );
+
+  grunt.registerTask(
+    "clean build",
+    "Compiles all the assets and copies the files to the build directory.",
+    [ "clean", "compress", "copy" ]
+  );
+
+  grunt.registerTask(
+    "build",
+    [ "clean build" ]
+  );
+};

assets/app_store_banner.png

@@ -0,0 +1,30 @@
+{
+  "name": "CustomString",
+  "version": "1.1.0",
+  "description": "Create a string with a microflow",
+  "private": true,
+  "dependencies": {
+  },
+  "devDependencies": {
+    "grunt": "0.4.5",
+    "grunt-contrib-clean": "^0.6.0",
+    "grunt-contrib-compress": "^0.14.0",
+    "grunt-contrib-copy": "^0.8.2",
+    "grunt-contrib-watch": "^0.6.1",
+    "grunt-newer": "^1.1.1",
+    "node-base64-image": "^0.1.0",
+    "shelljs": "^0.5.3",
+    "xml2js": "^0.4.15",
+    "node-mendix-modeler-path": "https://github.com/JelteMX/node-mendix-modeler-path/archive/v1.0.0.tar.gz"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/roelandsalij/CustomString"
+  },
+  "engines": {
+    "node": ">=0.12.0"
+  },
+  "scripts": {
+    "test": "grunt test"
+  }
+}

assets/app_store_icon.png

@@ -16,7 +16,13 @@
           <caption>Render value as HTML</caption>
           <category>Data source</category>
           <description>Escapes HTML elements when set to false</description>
-        </property>
+    </property>
+    <property key="mfToExecute" type="microflow" required="false" defaultValue="">
+          <caption>On click</caption>
+          <category>Behavior</category>
+          <description>The microflow to execute on click.</description>
+          <returnType type="Boolean" />
+    </property>
 	</properties>
 </widget>