Package io.jmix.flowui.view.template

Annotation Interface ListViewTemplate

@Target(TYPE) @Retention(RUNTIME) public @interface ListViewTemplate
Declares that the framework should generate a list view for the annotated entity at runtime.

  • Element Details

    • path

      String path
      Resource path to the Freemarker XML descriptor template.
      Default:
      "io/jmix/flowui/view/template/list-view.ftl"

    • templateParams

      String templateParams
      JSON object with additional template parameters.
      Default:
      ""

    • parentMenu

      String parentMenu
      Parent menu item id. If empty, the framework does not create a menu item.
      Default:
      ""

    • viewId

      String viewId
      View id. If empty, the framework uses <entityName>.list.
      Default:
      ""

    • viewRoute

      String viewRoute
      View route. If empty, the framework derives it from viewId.
      Default:
      ""

    • viewTitle

      String viewTitle
      View title. If empty, the framework uses <entityName> list.

      If the value starts with msg://, it is treated as a message reference and resolved through the Messages bean. Both the full format msg://group/message_id and the brief format msg://message_id (resolved against the entity package) are supported.

      Default:
      ""

    • lookupComponentId

      String lookupComponentId
      Lookup component id used by the template and the generated controller.
      Default:
      "dataGrid"