Packing as a Jar"

From Documentation
m
 
(34 intermediate revisions by 3 users not shown)
Line 3: Line 3:
  
 
== Jar Files  ==  
 
== Jar Files  ==  
Packing a component as a Jar file will make it easy to deployment, this article is telling you steps and requirements of it.
+
Packing a component as a Jar file will make it easy to deployment. This article demonstrates the steps and requirements of it.
 +
 
 +
 
 +
{| class="wikitable"
 +
! style="width: 70%" |
 +
! style="width: 30%" |
 +
|-
 +
|
 
*Requirements of a component Jar
 
*Requirements of a component Jar
 
*:Configurations
 
*:Configurations
Line 9: Line 16:
 
*:Widget Resources
 
*:Widget Resources
 
*:Static Resources
 
*:Static Resources
 +
|
 +
 +
''what do they look like , example from zul.jar''
 +
[[File:Jar_File_summary.jpg]]
 +
 +
|}
  
 
== Configurations ==
 
== Configurations ==
 +
 +
{| class="wikitable"
 +
! style="width: 70%" |
 +
! style="width: 30%" |
 +
|-
 +
|
 
===File Structure===
 
===File Structure===
 
*/META-INF/
 
*/META-INF/
Line 16: Line 35:
 
*/metainfo/
 
*/metainfo/
 
**mesg/
 
**mesg/
***msgzul.properties'''(optional)'''
+
***msg<jar name>.properties'''(optional)'''
***msgzul_<locale>.properties '''(optional ...)'''
+
***msg<jar name>_<locale>.properties '''(optional ...)'''
 
**xml/
 
**xml/
 
***<component-name>.xsd    '''(optional)'''
 
***<component-name>.xsd    '''(optional)'''
 
**zk/
 
**zk/
 
***lang.xml  '''(optional)'''
 
***lang.xml  '''(optional)'''
**zk/
+
***lang-addon.xml '''(optional)'''
***lang-addon.xml
 
  
 
===File descriptions===
 
===File descriptions===
Line 31: Line 49:
 
* /metainfo/
 
* /metainfo/
 
** mesg/
 
** mesg/
*** msgzul.properties  
+
*** msg<jar name>.properties  
**** ''These files are i18n resource files,you can define with the locale you want , the default file is msgzul.properties. ''
+
**** ''These files are i18n resource files,you can define with the locale you want , the default file is msg<jar name>.properties. '' <br /> [[ZK_Developer%27s_Reference/Internationalization/Warning_and_Error_Messages|ZK Internationalization]]
 
** xml/
 
** xml/
*** <component-name>.xsd   
+
*** <jar-name>.xsd   
 
**** ''The xml schema for component tags in zul''
 
**** ''The xml schema for component tags in zul''
 +
** tld
 +
*** config.xml
 +
**** '' For taglibs definition. (ex. zweb.jar use this for dsp.) ''
 
** zk/
 
** zk/
 +
*** lang-addon.xml
 +
**** ''The language add-on define components , and it defined the component classes, javascript widget/mold/css. <Br /> it should contains At least one lang.xml or lang-addon.xml '''usually you will need a lang-addon.xml''' . ''
 
*** lang.xml  
 
*** lang.xml  
**** ''The language definition file (ex. "xul/html") , and you can define components here , too.''
+
**** ''The language definition file with namespace (ex. http://www.w3.org/1999/xhtml for zhtml)''
*** lang-addon.xml
 
**** ''The language add-on define components with specific language.''
 
 
 
 
 
=====For exmaple=====
 
  
 +
|
 +
'''The example from zul.jar'''
 
[[File:Jar_File_configuration1.jpg]]
 
[[File:Jar_File_configuration1.jpg]]
 +
|}
  
 
== Component classes ==
 
== Component classes ==
 +
 +
{| class="wikitable"
 +
! style="width: 70%" |
 +
! style="width: 30%" |
 +
|-
 +
|
 
===File Structure===
 
===File Structure===
 
*/package-folder
 
*/package-folder
Line 57: Line 84:
 
* ''The java classes of component. just like normal jar file.''
 
* ''The java classes of component. just like normal jar file.''
  
=====Exmaple=====
+
|
 +
'''The example from zul.jar'''
 +
[[File:Jar_File_component1.jpg]]
  
[[File:Jar_File_configuration1.jpg]]
+
|}
  
 
== Widget  Resources ==
 
== Widget  Resources ==
  
 +
 +
{| class="wikitable"
 +
! style="width: 70%" |
 +
! style="width: 30%" |
 +
|-
 +
|
 
===File Structure===
 
===File Structure===
 
*/web/
 
*/web/
 
**js/
 
**js/
 
***component-package/
 
***component-package/
****/mold/
+
****mold/
 
***** <widget-mold-js-file>
 
***** <widget-mold-js-file>
****/css/<widget-css-dsp-file>''' (optional)'''
+
****css/
****/css/<widget-css-file>      '''(optional)'''
+
***** <widget-css-dsp-file>''' (optional)'''
****/<widget-class-js-file>
+
***** <widget-css-file>      '''(optional)'''
 +
****<widget-class-js-file>
 
****/zk.wpd
 
****/zk.wpd
 
 
  
 
===File descriptions===
 
===File descriptions===
Line 81: Line 115:
 
** js/
 
** js/
 
*** <component-package>/
 
*** <component-package>/
**** /mold/
+
****mold/
 
***** <widget-mold-js-file>  (ex. simple-label.js )
 
***** <widget-mold-js-file>  (ex. simple-label.js )
 
****** '' Widget mold file , you can write widget's html with javascript function here. ''
 
****** '' Widget mold file , you can write widget's html with javascript function here. ''
Line 95: Line 129:
  
  
=====Exmaple=====
+
|
  
 +
'''Example for box from zul.jar '''
 
[[File:Jar_File_widget1.jpg]]
 
[[File:Jar_File_widget1.jpg]]
 +
 +
|}
  
 
== Static Resources ==
 
== Static Resources ==
+
 
 +
 
 +
{| class="wikitable"
 +
! style="width: 70%" |
 +
! style="width: 30%" |
 +
|-
 +
|
 +
===File Structure===
 +
 
 
* /web/  
 
* /web/  
** <component-package> /                      
+
** <component-package> / '''(optional)'''     
 
*** css /'''(optional)'''
 
*** css /'''(optional)'''
 
**** <css files>'''(optional)'''                                         
 
**** <css files>'''(optional)'''                                         
 
**** zk.wcs'''(optional)'''
 
**** zk.wcs'''(optional)'''
*****''Let you can config the CSS file for a particular language ''
 
 
*** img /'''(optional)'''
 
*** img /'''(optional)'''
 
**** <img files>'''(optional)'''
 
**** <img files>'''(optional)'''
***** '' This is a folder for some image files  , and you can access them in xxx.css.dsp files through  ${c:encodeURL('~./img/<component-package>/xxx.png')} 
 
 
<pre>
 
/web/<component-package>/css/zk.wcs                              (optional)
 
                                                    /<css-files>                      (optional)
 
                                              /img                                        (optional)
 
</pre>
 
  
 
+
===File descriptions===
'''File descriptions'''
 
  
 
* /web/  
 
* /web/  
** <component-package> /
+
** <component-package>/
*** css /
+
*** css/
 
**** <css files>
 
**** <css files>
 
*****'' For some static css file you might need. ''
 
*****'' For some static css file you might need. ''
 
**** zk.wcs
 
**** zk.wcs
*****''Let you can config the CSS file for a particular language ''
+
*****''Let you can config the CSS file for particular language ''
*** img /
+
*** img/
 
**** <img files>
 
**** <img files>
 
***** '' This is a folder for some image files  , and you can access them in xxx.css.dsp files through  ${c:encodeURL('~./img/<component-package>/xxx.png')}   
 
***** '' This is a folder for some image files  , and you can access them in xxx.css.dsp files through  ${c:encodeURL('~./img/<component-package>/xxx.png')}   
  
 +
|
  
* For exmaple.
+
'''Example from zul.jar'''
 
 
=====Exmaple=====
 
  
 
[[File:Jar_File_static_resources1.jpg]]
 
[[File:Jar_File_static_resources1.jpg]]
<pre>
 
/web/com/foo/css/zk.wcs
 
                            /xxx.css.dsp
 
                    /img/label-background.png 
 
                            /label-background-hover.png   
 
</pre>
 
  
  
{{ZKComponentDevelopmentEssentialsHeadingToc}}
+
|}
  
 
{{ZKComponentDevelopmentEssentialsPageFooter}}
 
{{ZKComponentDevelopmentEssentialsPageFooter}}

Latest revision as of 07:22, 11 August 2011


Packing as a Jar




Jar Files

Packing a component as a Jar file will make it easy to deployment. This article demonstrates the steps and requirements of it.


  • Requirements of a component Jar
    Configurations
    Component classes
    Widget Resources
    Static Resources

what do they look like , example from zul.jar Jar File summary.jpg

Configurations

File Structure

  • /META-INF/
    • MANIFEST.MF
  • /metainfo/
    • mesg/
      • msg<jar name>.properties(optional)
      • msg<jar name>_<locale>.properties (optional ...)
    • xml/
      • <component-name>.xsd (optional)
    • zk/
      • lang.xml (optional)
      • lang-addon.xml (optional)

File descriptions

  • /META-INF/
    • MANIFEST.MF
      • The file for jar defino
  • /metainfo/
    • mesg/
      • msg<jar name>.properties
        • These files are i18n resource files,you can define with the locale you want , the default file is msg<jar name>.properties.
          ZK Internationalization
    • xml/
      • <jar-name>.xsd
        • The xml schema for component tags in zul
    • tld
      • config.xml
        • For taglibs definition. (ex. zweb.jar use this for dsp.)
    • zk/
      • lang-addon.xml
        • The language add-on define components , and it defined the component classes, javascript widget/mold/css.
          it should contains At least one lang.xml or lang-addon.xml usually you will need a lang-addon.xml .
      • lang.xml

The example from zul.jar Jar File configuration1.jpg

Component classes

File Structure

  • /package-folder
    • classes


File descriptions

  • The java classes of component. just like normal jar file.

The example from zul.jar Jar File component1.jpg

Widget Resources

File Structure

  • /web/
    • js/
      • component-package/
        • mold/
          • <widget-mold-js-file>
        • css/
          • <widget-css-dsp-file> (optional)
          • <widget-css-file> (optional)
        • <widget-class-js-file>
        • /zk.wpd

File descriptions

  • /web/
    • js/
      • <component-package>/
        • mold/
          • <widget-mold-js-file> (ex. simple-label.js )
            • Widget mold file , you can write widget's html with javascript function here.
        • css/
          • <widget-css-dsp-file> (ex. simple-label.css.dsp )
            • The css dsp files ,in the dsp you can use some variable with zk enviroment to write it.
          • <widget-css-file> (ex. simple-label.css )
            • the pure css files.
        • <widget-class-file> (ex. Simple-label.js)
          • The widget class you write .
        • zk.wpd
          • Define your component's package and widgets here, and the dependency with other package.


Example for box from zul.jar Jar File widget1.jpg

Static Resources

File Structure

  • /web/
    • <component-package> / (optional)
      • css /(optional)
        • <css files>(optional)
        • zk.wcs(optional)
      • img /(optional)
        • <img files>(optional)

File descriptions

  • /web/
    • <component-package>/
      • css/
        • <css files>
          • For some static css file you might need.
        • zk.wcs
          • Let you can config the CSS file for particular language
      • img/
        • <img files>
          • This is a folder for some image files , and you can access them in xxx.css.dsp files through ${c:encodeURL('~./img/<component-package>/xxx.png')}

Example from zul.jar

Jar File static resources1.jpg




Last Update : 2011/08/11

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.