Interface IControlCenter

  • All Known Implementing Classes:
    PlatformControlCenter

    public interface IControlCenter
    Control center interface providing useful methods that may be called from plugins.
    • Method Detail

      • getPlatformAccess

        IExternalAccess getPlatformAccess()
        Get the external access of the administered platform (potentially remote).
        Returns:
        The external access.
      • getJCCAccess

        IExternalAccess getJCCAccess()
        Get the external access of the JCC component (always local).
        Returns:
        The external access.
      • getCMSHandler

        CMSUpdateHandler getCMSHandler()
        Get the cms update handler shared by all tools.
      • getPropertyHandler

        PropertyUpdateHandler getPropertyHandler()
        Get the cms update handler shared by all tools.
      • getIconCache

        ComponentIconCache getIconCache()
        Get the component icon cache shared by all tools.
      • showPlugin

        void showPlugin​(java.lang.String name)
        Switch to a plugin. Shows the plugin, if available.
      • showPlatform

        void showPlatform​(IExternalAccess platformaccess)
        Add a new platform control center or switch to tab if already exists.
      • setStatusText

        void setStatusText​(java.lang.String text)
        Set a text to be displayed in the status bar. The text will be removed automatically after some delay (or replaced by some other text).
      • getStatusComponent

        javax.swing.JComponent getStatusComponent​(java.lang.Object id)
        Get a component from the status bar.
        Parameters:
        id - Id used for adding a component.
        Returns:
        The component to display.
      • addStatusComponent

        void addStatusComponent​(java.lang.Object id,
                                javax.swing.JComponent comp)
        Add a component to the status bar.
        Parameters:
        id - An id for later reference.
        comp - The component to display.
      • removeStatusComponent

        void removeStatusComponent​(java.lang.Object id)
        Remove a previously added component from the status bar.
        Parameters:
        id - The id used for adding the component.
      • displayError

        void displayError​(java.lang.String errortitle,
                          java.lang.String errormessage,
                          java.lang.Exception exception)
        Display an error dialog.
        Parameters:
        errortitle - The title to use for an error dialog (required).
        errormessage - An optional error message displayed before the exception.
        exception - The exception (if any).