Annotation Type WorkbenchPanel


  • @Retention(RUNTIME)
    @Target(FIELD)
    public @interface WorkbenchPanel
    Specifies an UberFire workbench panel within a templated perspective.

    Prerequisites

    This annotation can only be used within a class annotated with WorkbenchPerspective, and it must target a field that implements the GWT HasWidgets interface. Further, the class this annotation is used in must not have a method annotated with Perspective. See WorkbenchPerspective for details.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String[] parts
      Specifies the PlaceRequests that should be used to populate this panel with parts when the containing perspective is first launched.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean isDefault
      Makes this panel the first panel in the generated PerspectiveDefinition object.
      Class<?> panelType
      The Presenter type of the panel.
    • Element Detail

      • parts

        String[] parts
        Specifies the PlaceRequests that should be used to populate this panel with parts when the containing perspective is first launched. For panel types that only support a single part (such as StaticWorkbenchPanelPresenter), only one item should be used here.

        To specify a PlaceRequest with parameters, use standard URL query syntax:

           @WorkbenchPanel(parts = "MyPlaceID?param1=val1&amp;param2=val2")
         

        Special characters can be escaped using URL encoding: for '%' use '%25'; for '&' use '%26'; for '=' use '%3d'; for '?' use '%3f'.

      • panelType

        Class<?> panelType
        The Presenter type of the panel. Must be a Dependent-scoped Errai IOC bean which implements WorkbenchPanelPresenter. The default is SimpleWorkbenchPanelPresenter.
        Default:
        java.lang.Void.class
      • isDefault

        boolean isDefault
        Makes this panel the first panel in the generated PerspectiveDefinition object. Some panel presenters may treat their first child panel specially (for example, by forwarding addPanel requests to it). If no panel within a perspective is explicitly marked as the default, a randomly selected panel will be first. It is an error to define more than one default panel in a perspective.
        Default:
        false