Package com.inductiveautomation.ignition.designer.model

Interface ResourceWorkspace

All Known Implementing Classes:
DefaultDesignableWorkspace, EmptyWorkspace, LocalizationWorkspace, NamedQueryWorkspace, PipelineBlockWorkspace, ReportingResourceWorkspace, ScriptWorkspace, SfcWorkspace, TabbedResourceWorkspace, ViewWorkspace, WindowWorkspace
public interface ResourceWorkspace
A main editing area for the designer. The workspace has menus and toolbars associated with it that become visible when the workspace is focused.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    dispose()
    Called when the workspace should be completely disposed.
    EditActionHandler
    getEditActionHandler()
    The handler that responds to common edit actions, like cut, copy, paste, and delete
    Collection<ResourceWorkspaceFrame>
    getFrames()
    Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace.
    String
    getKey()
    Returns a keyname for the workspace.
    MenuBarMerge
    getMenu()
    Returns a menu merge for the menu options that should be present when this workspace is active.
    List<com.jidesoft.action.CommandBar>
    getToolbars()
    Returns the toolbars that will be added when this workspace is active.
    JComponent
    getWorkspace()
    The component that makes up the workspace itself.
    void
    onActivation()
    Called when the resource workspace will become the active workspace and will be displayed.
    void
    onDeactivation()
    Called when the resource workspace will be swapped out for a different workspace.
    void
    resetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager)
    Programmatically set the options on the frames and bars that represent the workspace's "defaults"
    static boolean
    shouldOpen(ResourcePath resourcePath, DesignerContext context)
    Check if resource is protected, user has permission to modify, and ask if user wants to unprotect

  • Method Details

    • getWorkspace

      JComponent getWorkspace()
      The component that makes up the workspace itself. Must not be null

    • getKey

      String getKey()
      Returns a keyname for the workspace. Used by nav tree nodes to specify which workspace to switch to when they are selected.

    • getMenu

      MenuBarMerge getMenu()
      Returns a menu merge for the menu options that should be present when this workspace is active. May be null.

    • getToolbars

      @Nullable List<com.jidesoft.action.CommandBar> getToolbars()
      Returns the toolbars that will be added when this workspace is active. May be null or empty.

    • getFrames

      Collection<ResourceWorkspaceFrame> getFrames()
      Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace. May be null or empty.

    • getEditActionHandler

      EditActionHandler getEditActionHandler()
      The handler that responds to common edit actions, like cut, copy, paste, and delete

    • resetFrames

      void resetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager)
      Programmatically set the options on the frames and bars that represent the workspace's "defaults"

    • onActivation

      void onActivation()
      Called when the resource workspace will become the active workspace and will be displayed.

    • onDeactivation

      void onDeactivation()
      Called when the resource workspace will be swapped out for a different workspace.

    • dispose

      default void dispose()
      Called when the workspace should be completely disposed.

    • shouldOpen

      static boolean shouldOpen(ResourcePath resourcePath, DesignerContext context)
      Check if resource is protected, user has permission to modify, and ask if user wants to unprotect
      Parameters:
      resourcePath - The resource path
      context - The context
      Returns:
      true if resource should be opened, otherwise false