Class AnnotateDataBinderInit

  • All Implemented Interfaces:
    Initiator, InitiatorExt

    public class AnnotateDataBinderInit
    extends java.lang.Object
    implements Initiator, InitiatorExt
    As of release 7.0.0, replace with new ZK binding.

    This initiator class do following things:

    1. New an AnnotateDataBinder instance.
    2. Set the AnnotateDataBinder instance as a custom attribute with the name as specified in arg2 (default to "binder") and store it in the component as specified in arg0 "component-path".(if arg0 is not specified, use Page instead.)
    3. call DataBinder.loadAll() in to doAfterCompose(Page, Component[]) and initiate all UI components from the associated data bean.

    Put the init PI as follows:

     <?init class="org.zkoss.zkplus.databind.AnnotateDataBinderInit" 
      [name="binder's name"]
      [loadOnSave="true|false"] ?>

    Where the root attribute is the component itself (via EL expression) or the component path that specifies the component the AnnotateDataBinder covers. You can use absolute path that starts with "//" (search from Desktop) or "/" (search from Page); or you can use relative path(supported since ZK 3.0.8) that starts with "./" or "../" (relative to the Id Space of the root component). If the root attribute is not specified or set to string "page", the AnnotateDataBinder will default to cover the whole page.

    Where the loadDefault attribute is used to decide whether to load default binding configuration defined in lang-addon.xml. If the loadDefault attribute is not specified it is default to true.

    (since 3.6.2) Where the name attribute is used to specify the created DataBinder's name (default to "binder") which you can access it via EL or component.getAttribute(name) later.

    (since 5.0.5) Where the loadOnSave attribute(default to true) is used to specify whether DataBinder shall automatically "load" associated binding value back into UI component after doing a "save" operation to the binding bean.

    For application design to run ZK prior to 3.6.2, it can use arg0 instead of root, and arg1 instead of loadDefault.

    Note that since 5.0, the created DataBinder is stored in component scope of the root component rather than in the IdSpace scope of the root component. If that is important to you, you can specify compatible library property in WEB-INF/zk.xml to true to make it work as it was prior version 5; i.e. store the created DataBinder in IdSpace scope of the root component.

    Henri Chen
    See Also:
    • Field Summary

      Modifier and Type Field Description
      protected AnnotateDataBinder _binder
      The AnnotateDataBinder created in doAfterCompose()
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void doAfterCompose​(Page page, Component[] comps)
      Called after all components are created (a.k.a., composed), and before any event is processed.
      boolean doCatch​(java.lang.Throwable ex)
      Called when an exception occurs during the evaluation of the page.
      void doFinally()
      Do the cleanup after the page has been evaluated.
      void doInit​(Page page, java.util.Map args)
      Does the initializes before the page is evaluated.
      • Methods inherited from class java.lang.Object

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