jaxx:generate

Nom complet :

org.nuiton.jaxx:jaxx-maven-plugin:2.46:generate

Description :

Generates some java code from jaxx files.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : compile.
  • Depuis la version : 1.3.
  • S'associe par défaut dans la phase du cycle de vie : process-sources.

Paramètres requis

Nom Type Depuis Description
<compilerFQN> String 1.3 FQN of compiler to use (by default swing one).
Valeur par défaut : jaxx.compiler.JAXXCompiler.
Propriété utilisateur : jaxx.compilerFQN.
<jaxxContextFQN> String 1.3 The name of implementation of JAXXContextto be used on JAXXObject. Must not be abstract.
Valeur par défaut : jaxx.runtime.context.DefaultJAXXContext.
Propriété utilisateur : jaxx.jaxxContextFQN.

Paramètres optionnels

Nom Type Depuis Description
<addAutoHandlerUI> boolean 2.6 For each jaxx file, try to add a UIHandler on it. The fqn of the handler must be jaxxFileNameHandler.
Valeur par défaut : false.
Propriété utilisateur : jaxx.addAutoHandlerUI.
<addCompileClassPath> boolean 1.6.0 Flag to include in compiler classpath the compile class-path (can only be used in a test phase). By default, false.
Valeur par défaut : false.
Propriété utilisateur : jaxx.addCompileClassPath.
<addLogger> boolean 1.3 Flag to add logger to each generated jaxx file. By default, always add it.
Valeur par défaut : true.
Propriété utilisateur : jaxx.addLogger.
<addProjectClassPath> boolean 1.3 Flag to include in compiler classpath the project compile classpath. By default, false.
Valeur par défaut : false.
Propriété utilisateur : jaxx.addProjectClassPath.
<addResourcesToClassPath> boolean 1.6.0 Flag to include in compiler classpath the java resources directories (src and outJava). By default, false.
Valeur par défaut : false.
Propriété utilisateur : jaxx.addResourcesToClassPath.
<addSourcesToClassPath> boolean 1.3 Flag to include in compiler classpath the java sources directories (src and outJava). By default, false.
Valeur par défaut : false.
Propriété utilisateur : jaxx.addSourcesToClassPath.
<autoRecurseInCss> boolean 2.0.2 To let jaxx recurses in css when a JAXX Object auto import css files for a jaxx file. Warning: This option will be removed in version 3.0 or at least default value will become false.
Valeur par défaut : true.
Propriété utilisateur : jaxx.autoRecurseInCss.
<beanInfoSearchPath> String[] 1.3 Extra path to be added in Introspector.setBeanInfoSearchPath(). add beanInfoSearchPath to be registred by BeanInfoUtil.addJaxxBeanInfoPath() and then will be use by DefaultInitializer.initialize(). This permit to use real beanInfo of imported graphic libraries.
Propriété utilisateur : jaxx.beanInfoSearchPath.
<commonCss> File 2.13 A optional common css to inject in all jaxx files.
Propriété utilisateur : jaxx.commonCss.
<cssExtension> String 2.28 The extension of css files.
Valeur par défaut : css.
Propriété utilisateur : jaxx.cssExtension.
<defaultDecoratorFQN> String 1.3 The FQN of the ui to use for error notification. If not given, will use the one defined in validator
Valeur par défaut : jaxx.compiler.decorators.DefaultCompiledObjectDecorator.
Propriété utilisateur : jaxx.defaultDecoratorFQN.
<defaultErrorUIFQN> String 1.3 The FQN of the ui to use for error notification. If not given, will use the one defined in validator
Propriété utilisateur : jaxx.defaultErrorUIFQN.
<encoding> String 2.0.0 Encoding used for file generation. Note: If nothing is filled here, we will use the system property file.encoding.
Valeur par défaut : ${project.build.sourceEncoding}.
Propriété utilisateur : jaxx.encoding.
<excludes> String[] 1.3 To filter files to NOt treat.
Propriété utilisateur : jaxx.excludes.
<extraImportList> String 1.3 List of fqn of class toimport for all generated jaxx files.
Propriété utilisateur : jaxx.extraImportList.
<force> boolean 1.3 To force generation of java source for any jaxx files with no timestamp checking. By default, never force generation.
Valeur par défaut : false.
Propriété utilisateur : jaxx.force.
<generateHelp> boolean 1.3 Flag to activate help id detection while parsing jaxx files. By default, not active.
Valeur par défaut : false.
Propriété utilisateur : jaxx.generateHelp.
<generateMissingIdsAndStyleClassesInCss> boolean 2.29 For each jaxx file, generate the rules in the css files for the ids and style classes which have not been defined.
Valeur par défaut : false.
Propriété utilisateur : jaxx.generateMissingIdsInCss.
<helpBrokerFQN> String 1.3 the FQN of help broker By default, use the JAXX implementation JAXXHelpBroker.
Valeur par défaut : jaxx.runtime.swing.help.JAXXHelpBroker.
Propriété utilisateur : jaxx.helpBrokerFQN.
<i18nable> boolean 1.3 To make compiler i18nable, says add the I18n.t() method invocation on I18nHelper.I18N_ATTRIBUTES attributes.
Valeur par défaut : true.
Propriété utilisateur : jaxx.i18nable.
<includes> String[] 1.3 To filter file to treat.
Propriété utilisateur : jaxx.includes.
<optimize> boolean 1.3 To optimize generated code.
Valeur par défaut : false.
Propriété utilisateur : jaxx.optimize.
<outJava> File 1.3 Where to generate java files.
Valeur par défaut : ${basedir}/target/generated-sources/java.
Propriété utilisateur : jaxx.outJava.
<profile> boolean 1.3 flag to activate profile mode. By default, not active.
Valeur par défaut : false.
Propriété utilisateur : jaxx.profile.
<resetAfterCompile> boolean 1.3 Flag to keep compilers after the generate operation (usefull for tests. By default, always reset.
Valeur par défaut : true.
Propriété utilisateur : jaxx.resetAfterCompile.
<showBinding> boolean 2.0.0 To show detected bindings. By default, do not show them.
Valeur par défaut : false.
Propriété utilisateur : jaxx.showBinding.
<showClassDescriptorLoading> boolean 2.4 To trace class descriptor loading. By default, do not trace it.
Valeur par défaut : false.
Propriété utilisateur : jaxx.showClassDescriptorLoading.
<src> File 1.3 Directory where jaxx files are located.
Valeur par défaut : ${basedir}/src/main/java.
Propriété utilisateur : jaxx.src.
<testPhase> boolean 1.6.0 A flag to mark the mojo to be used in a test phase. This will permits to add generated sources in test compile roots.
Valeur par défaut : false.
Propriété utilisateur : jaxx.testPhase.
<useUIManagerForIcon> boolean 1.3 A flag to use UIManager to retreave icons.
Valeur par défaut : false.
Propriété utilisateur : jaxx.useUIManagerForIcon.
<validatorFactoryFQN> String 2.6 the FQN of validator factory. By default, use the JAXX implementation SwingValidator.
Valeur par défaut : jaxx.runtime.validator.swing.SwingValidator.
Propriété utilisateur : jaxx.validatorFactoryFQN.
<verbose> boolean 1.3 Verbose flag.
Valeur par défaut : false.
Propriété utilisateur : jaxx.verbose.

Détails des paramètres

<addAutoHandlerUI>

For each jaxx file, try to add a UIHandler on it. The fqn of the handler must be jaxxFileNameHandler.
  • Type : boolean
  • Depuis : 2.6
  • Exigé : Non
  • Propriété utilisateur : jaxx.addAutoHandlerUI
  • Défaut : false

<addCompileClassPath>

Flag to include in compiler classpath the compile class-path (can only be used in a test phase). By default, false.
  • Type : boolean
  • Depuis : 1.6.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.addCompileClassPath
  • Défaut : false

<addLogger>

Flag to add logger to each generated jaxx file. By default, always add it.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.addLogger
  • Défaut : true

<addProjectClassPath>

Flag to include in compiler classpath the project compile classpath. By default, false.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.addProjectClassPath
  • Défaut : false

<addResourcesToClassPath>

Flag to include in compiler classpath the java resources directories (src and outJava). By default, false.
  • Type : boolean
  • Depuis : 1.6.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.addResourcesToClassPath
  • Défaut : false

<addSourcesToClassPath>

Flag to include in compiler classpath the java sources directories (src and outJava). By default, false.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.addSourcesToClassPath
  • Défaut : false

<autoRecurseInCss>

To let jaxx recurses in css when a JAXX Object auto import css files for a jaxx file. Warning: This option will be removed in version 3.0 or at least default value will become false.
  • Type : boolean
  • Depuis : 2.0.2
  • Exigé : Non
  • Propriété utilisateur : jaxx.autoRecurseInCss
  • Défaut : true

<beanInfoSearchPath>

Extra path to be added in Introspector.setBeanInfoSearchPath(). add beanInfoSearchPath to be registred by BeanInfoUtil.addJaxxBeanInfoPath() and then will be use by DefaultInitializer.initialize(). This permit to use real beanInfo of imported graphic libraries.
  • Type : java.lang.String[]
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.beanInfoSearchPath

<commonCss>

A optional common css to inject in all jaxx files.
  • Type : java.io.File
  • Depuis : 2.13
  • Exigé : Non
  • Propriété utilisateur : jaxx.commonCss

<compilerFQN>

FQN of compiler to use (by default swing one).
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.compilerFQN
  • Défaut : jaxx.compiler.JAXXCompiler

<cssExtension>

The extension of css files.
  • Type : java.lang.String
  • Depuis : 2.28
  • Exigé : Non
  • Propriété utilisateur : jaxx.cssExtension
  • Défaut : css

<defaultDecoratorFQN>

The FQN of the ui to use for error notification. If not given, will use the one defined in validator
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.defaultDecoratorFQN
  • Défaut : jaxx.compiler.decorators.DefaultCompiledObjectDecorator

<defaultErrorUIFQN>

The FQN of the ui to use for error notification. If not given, will use the one defined in validator
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.defaultErrorUIFQN

<encoding>

Encoding used for file generation. Note: If nothing is filled here, we will use the system property file.encoding.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.encoding
  • Défaut : ${project.build.sourceEncoding}

<excludes>

To filter files to NOt treat.
  • Type : java.lang.String[]
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.excludes

<extraImportList>

List of fqn of class toimport for all generated jaxx files.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.extraImportList

<force>

To force generation of java source for any jaxx files with no timestamp checking. By default, never force generation.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.force
  • Défaut : false

<generateHelp>

Flag to activate help id detection while parsing jaxx files. By default, not active.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.generateHelp
  • Défaut : false

<generateMissingIdsAndStyleClassesInCss>

For each jaxx file, generate the rules in the css files for the ids and style classes which have not been defined.
  • Type : boolean
  • Depuis : 2.29
  • Exigé : Non
  • Propriété utilisateur : jaxx.generateMissingIdsInCss
  • Défaut : false

<helpBrokerFQN>

the FQN of help broker By default, use the JAXX implementation JAXXHelpBroker.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.helpBrokerFQN
  • Défaut : jaxx.runtime.swing.help.JAXXHelpBroker

<i18nable>

To make compiler i18nable, says add the I18n.t() method invocation on I18nHelper.I18N_ATTRIBUTES attributes.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.i18nable
  • Défaut : true

<includes>

To filter file to treat.
  • Type : java.lang.String[]
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.includes

<jaxxContextFQN>

The name of implementation of JAXXContextto be used on JAXXObject. Must not be abstract.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.jaxxContextFQN
  • Défaut : jaxx.runtime.context.DefaultJAXXContext

<optimize>

To optimize generated code.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.optimize
  • Défaut : false

<outJava>

Where to generate java files.
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.outJava
  • Défaut : ${basedir}/target/generated-sources/java

<profile>

flag to activate profile mode. By default, not active.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.profile
  • Défaut : false

<resetAfterCompile>

Flag to keep compilers after the generate operation (usefull for tests. By default, always reset.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.resetAfterCompile
  • Défaut : true

<showBinding>

To show detected bindings. By default, do not show them.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.showBinding
  • Défaut : false

<showClassDescriptorLoading>

To trace class descriptor loading. By default, do not trace it.
  • Type : boolean
  • Depuis : 2.4
  • Exigé : Non
  • Propriété utilisateur : jaxx.showClassDescriptorLoading
  • Défaut : false

<src>

Directory where jaxx files are located.
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.src
  • Défaut : ${basedir}/src/main/java

<testPhase>

A flag to mark the mojo to be used in a test phase. This will permits to add generated sources in test compile roots.
  • Type : boolean
  • Depuis : 1.6.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.testPhase
  • Défaut : false

<useUIManagerForIcon>

A flag to use UIManager to retreave icons.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.useUIManagerForIcon
  • Défaut : false

<validatorFactoryFQN>

the FQN of validator factory. By default, use the JAXX implementation SwingValidator.
  • Type : java.lang.String
  • Depuis : 2.6
  • Exigé : Non
  • Propriété utilisateur : jaxx.validatorFactoryFQN
  • Défaut : jaxx.runtime.validator.swing.SwingValidator

<verbose>

Verbose flag.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.verbose
  • Défaut : false