Wicket Preview With One Javascript

Third times the charm, right? There's still a few improvements I would like to make to the wicket:preview feature, but here's how I got it to work with a single javascript include.

Here's an example of the new page with only one javascript include.

<html>
<head>
  <title>Offline Preview With One Javascript</title>

<wicket:remove>
  <script type="text/javascript" src="wicket-preview.js"></script>
</wicket:remove>

</head>
<body>
  <div wicket:id="loginForm" wicket:preview="Login.html">Text should be replaced</div>
</body>
</html>

The wicket-preview.js file has changed quite a bit. It is now essentially just a "bootstrapping" script, to load all the other javascript files. It is heavilyinfluenced by the scriptaculous bootstrapping code, but I had to change a few things here and there to make it more understandable for me. I'm not a big fan of the excessive method chaining that they were using, and I'm not too familiar with some of the prototype syntax either. All of the other work has been pushed to wicket-preview-behaviour.js

One veryimportant thing to remember, is that the bootstrapping javascript cannot reference any of the included functions. I got stuck on this for a couple hours by trying to bootstrap and reference the Behaviour objects in the same place. Oh well, I guess you live and learn...

var WicketPreview = {
  require: function(libraryName) {
    // inserting via DOM fails in Safari 2.0, so brute force approach
    document.write('<script type="text/javascript" src="' + libraryName + '"></script>');
  },
  findJavascriptPath: function() {
    var scripts = document.getElementsByTagName("script");
    for (var x = 0; x < scripts.length; x++) {
      var s = scripts[x];
      if (s.src && s.src.match(/wicket-preview\.js(\?.*)?$/)) {
        return s.src.replace(/wicket-preview\.js(\?.*)?$/,'');
      }
    }
  },
  load: function() {
    var path = WicketPreview.findJavascriptPath();
    var includes = 'behaviour,dojo,wicket-preview-behaviour'.split(',');
    for (var x = 0; x < includes.length; x++) {
      var include = includes[x];
      WicketPreview.require(path + include + '.js');
    }
  }
}

WicketPreview.load();

The wicket-preview-behaviour.js file is the same as my previous blog. I just had to move the code into a new file to avoid conflicting with the bootstrapping code.

var myrules = {
  'div': function(element) {
    var url = element.getAttribute('wicket:preview');
    if (url) {
      dojo.require("dojo.io.*");
      dojo.io.bind({
        url: url,
        load: function(type, data, evt) {
        element.innerHTML = data;
      },
      mimetype: "text/plain"
      });
    }
  }
};

Behaviour.register(myrules);

I'm becoming more convinced that this is a killer feature. I have opened a request for this feature to be integrated directly into Wicket, but there's been no movement on it yet. If anyone out there thinks this would be useful, please show your support on the Wicket mailing list or directly in the sourceforge issue I opened.

I think this pretty much sums out the outstanding work in order for this feature to be moved into the Wicket core.

  1. Documentation. Maybe add to the wicket examples or some other visible demo?

  2. Add wicket:previewto the official Wicket DTD. The wicket:idattribute is already there, and adding wicket:previewto the DTD will allow designers to create valid XHTML.

  3. Optionally remove the wicket:previewattributes at runtime. Wicket has a setting to automatically remove the wicket:idattribute at runtime, and it should be able to support this as well. It might already handle wicket:*, I don't really know about this one.

My next feat will be to improve this feature to try and handle multiple levels of component inheritance. That should be quite a trick!