Package io.jmix.flowui.view.template.impl

Class ViewTemplateDefinition

java.lang.Object
io.jmix.flowui.view.template.impl.ViewTemplateDefinition
public class ViewTemplateDefinition extends Object
Describes a view generated from an entity template annotation.

  • Field Details

    • id

      protected String id

    • type

      protected ViewTemplateType type

    • entityMetaClass

      protected MetaClass entityMetaClass

    • descriptorPath

      protected String descriptorPath

    • routePath

      protected String routePath

    • controllerClass

      protected Class<? extends View<?>> controllerClass

    • title

      protected String title

    • parentMenu

      protected String parentMenu

  • Constructor Details

    • ViewTemplateDefinition

      public ViewTemplateDefinition(String id, ViewTemplateType type, MetaClass entityMetaClass, String descriptorPath, String routePath, Class<? extends View<?>> controllerClass, String title, String parentMenu)
      Creates a template view definition.
      Parameters:
      id - view id
      type - template view type
      entityMetaClass - entity meta-class
      descriptorPath - descriptor path registered in the descriptor registry
      routePath - route path registered for the generated controller
      controllerClass - generated controller class
      title - resolved view title
      parentMenu - parent menu item id or an empty string

  • Method Details

    • getId

      public String getId()
      Returns:
      registered view id

    • getType

      public ViewTemplateType getType()
      Returns:
      template view type

    • getEntityMetaClass

      public MetaClass getEntityMetaClass()
      Returns:
      entity meta-class for which the view was generated

    • getDescriptorPath

      public String getDescriptorPath()
      Returns:
      descriptor path registered for the generated view

    • getRoutePath

      public String getRoutePath()
      Returns:
      route path registered for the generated view

    • getControllerClass

      public Class<? extends View<?>> getControllerClass()
      Returns:
      generated controller class

    • getTitle

      public String getTitle()
      Returns:
      resolved view title

    • getParentMenu

      public String getParentMenu()
      Returns:
      parent menu item id or an empty string if no menu item should be created