Interface PerspectiveDefinition

  • All Known Implementing Classes:
    PerspectiveDefinitionImpl

    @JsType
    public interface PerspectiveDefinition
    Meta-data defining a Perspective. A Perspective is a set of Panels and Parts arranged within the Workbench. The Workbench has exactly one active Perspective at a time. The Perspective contains multiple Panels. Each Panel contains multiple Parts, one of which can be visible at a time. Panels can also contain child panels which are all visible at the same time are are physically located within the bounds of the parent panel. Each Part is associated with one PlaceRequest.

    Implementations of this interface must be marked with Errai's @Portable annotation.

    • Method Detail

      • getName

        String getName()
        Get the name of the Perspective.
        Returns:
        The name of the Perspective.
      • setName

        void setName​(String name)
        Set the name of the Perspective.
        Parameters:
        name - The name of the Perspective.
      • getRoot

        PanelDefinition getRoot()
        Get the root Panel for this Perspective. The root Panel contains all child Panels. A Perspective is based on a single root Panel.
        Returns:
        The root Panel.
      • setContextDefinition

        void setContextDefinition​(ContextDefinition contextDefinition)
      • setContextDisplayMode

        void setContextDisplayMode​(ContextDisplayMode contextDisplayMode)