Annotation Type UiChild


  • @Documented
    @Retention(RUNTIME)
    @Target(METHOD)
    public @interface UiChild
    Mark a method as the appropriate way to add a child widget to the parent class.

    The limit attribute specifies the number of times the function can be safely called. If no limit is specified, it is assumed to be unlimited. Only one child is permitted under each custom tag specified so the limit represents the number of times the tag can be present in any object.

    The tagname attribute indicates the name of the tag this method will handle in the UiBinder template. If none is specified, the method name must begin with "add", and the tag is assumed to be the remaining characters (after the "add" prefix") entirely in lowercase.

    For example, @UiChild MyWidget#addCustomChild(Widget w) and

       <p:MyWidget>
         <p:customchild>
           <g:SomeWidget />
         </p:customchild>
       </p:MyWidget>
     
    would invoke the addCustomChild function to add an instance of SomeWidget.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int limit  
      java.lang.String tagname  
    • Element Detail

      • limit

        int limit
        Default:
        -1
      • tagname

        java.lang.String tagname
        Default:
        ""