net.jangaroo.exml.templates.exml_config_class.ftl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of exml-compiler Show documentation

parses an EXML and generates an AS config class

There is a newer version: 4.1.0-alpha-8

<#-- @ftlvariable name="" type="net.jangaroo.exml.model.ConfigClass" -->
package ${packageName} {

<#list imports as import>
import ${import};


/**
 * ${escapedDescriptionWithoutAts!}
 *
 * This class serves as a typed config object for the constructor of the class ${componentClassName}.
 * It defines the EXML element <${ns}:${name}> with xmlns:${ns}="exml:${packageName}".
<#if type.extTypeAttribute??>
 * Using this config class also takes care of registering the target class under the ${type.extTypeAttribute}
 * "${packageName}.${name}" with Ext JS.

 *
 * @see ${componentClassName}
<#if escapedDescriptionAts??>
 * ${escapedDescriptionAts}

 */
[ExtConfig(target="${componentClassName}"<#if type.type??>, ${type.type})]
<#list annotations as annotation>
[${annotation}]

public class ${name} extends ${superClassName} {
<#list constants as constant>
  /**
   * ${constant.escapedDescription!}
   */
  public static const ${constant.name}:${constant.type} = ${constant.value};


<#if type.type??>
  public static native function get ${type.type}():String;


  /**
   * Use this constructor to create a typed config object for the constructor of the class
   * ${componentClassName}.
<#if type.extTypeAttribute??>
   * Using this config class also takes care of registering the target class under the ${type.extTypeAttribute}
   * "${packageName}.${name}" with Ext JS.

   * 
   *
   * @see ${componentClassName}
   */
  public function ${name}(config:Object = null) {
    super(config || {});
  }

  <#list directCfgs as cfg>
  /**
   * ${cfg.escapedDescription!}
   */
  public native function get ${cfg.name}():${cfg.type};
  /**
   * @private
   */
  public native function set ${cfg.name}(value:${cfg.type}):void;
  <#if cfg.name=="id">
  [ExtConfig("id")]
  /**
   * Alias for id property to make it accessible from MXML.
   * @copy #id
   * @see #id
   */
  public native function set id_(value:${cfg.type}):void;
  
  
}
}