net.jangaroo.extxml
Class ExtXml

java.lang.Object
  net.jangaroo.extxml.ExtXml

public final class ExtXml
extends Object

A tool to define Ext JS Component suites in JavaScript, ActionScript, or XML (files with exml ending).

Usage: extxml target-namespace namespace-prefix xsd-output-file src-dir output-dir imported-xsd-file*

Scans the given source directory (src-dir) for Ext JS component class definitions in any of the following three formats:

• as a JavaScript file (*.js), using Ext's class and inheritance helpers,
• as an ActionScript file (*.as), or
• as an XML file (*.exml), which is first transformed to an ActionScript file.

All used or extended components from other component suites must be imported. This is done by enumeration their XML Schema file locations.

All ActionScipt files have to comply with the following structure:

• extend an ExtXml Component, i.e. ext.Panel
• define a public static const xtype, i.e. public static const xtype:String = "myComponent";
• register the compontent in a static code block as Ext component, i.e { ext.ComponentMgr.registerType(xtype, MyComponent); }

All JavaScript files must contain the following documentation annotations in order to be interpreted as an Ext JS component class:

• @class - the fully qualified name of the JavaScript component class.
• @extends - the fully qualified name of the super component class.
• @xtype - the xtype under which to register the component class with Ext.

Furthermore, both JavaScript and ActionScript source files may define an arbitrary number of configuration parameters, using the following documentation annotation syntax:

@cfg {type} name description

The tool generates

• ActionScript files for all XML files,
• an XML Schema (*.xsd, given as xsd-output-file) describing the whole component suite, i.e. an element, type and super type for each component, and an attribute for each configuration parameter.

Method Summary

static void

main(String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException