Class SubStatusLineManager

    • Constructor Detail

      • SubStatusLineManager

        public SubStatusLineManager​(IStatusLineManager mgr)
        Constructs a new manager.
        Parameters:
        mgr - the parent manager. All contributions made to the SubStatusLineManager are forwarded and appear in the parent manager.
    • Method Detail

      • getParentStatusLineManager

        protected final IStatusLineManager getParentStatusLineManager()
        Returns:
        the parent status line manager that this sub-manager contributes to
      • getProgressMonitor

        public IProgressMonitor getProgressMonitor()
        Description copied from interface: IStatusLineManager
        Returns a progress monitor which reports progress in the status line. Note that the returned progress monitor may only be accessed from the UI thread.
        Specified by:
        getProgressMonitor in interface IStatusLineManager
        Returns:
        the progress monitor Note: There is a delay after a beginTask message before the monitor is shown. This may not be appropriate for all apps.
      • isCancelEnabled

        public boolean isCancelEnabled()
        Description copied from interface: IStatusLineManager
        Returns whether the cancel button on the status line's progress monitor is enabled.
        Specified by:
        isCancelEnabled in interface IStatusLineManager
        Returns:
        true if the cancel button is enabled, or false if not
      • setCancelEnabled

        public void setCancelEnabled​(boolean enabled)
        Description copied from interface: IStatusLineManager
        Sets whether the cancel button on the status line's progress monitor is enabled.
        Specified by:
        setCancelEnabled in interface IStatusLineManager
        Parameters:
        enabled - true if the cancel button is enabled, or false if not
      • setErrorMessage

        public void setErrorMessage​(String message)
        Description copied from interface: IStatusLineManager
        Sets the error message text to be displayed on the status line. The image on the status line is cleared.

        An error message overrides the current message until the error message is cleared (set to null).

        Specified by:
        setErrorMessage in interface IStatusLineManager
        Parameters:
        message - the error message, or null to clear the current error message.
      • setErrorMessage

        public void setErrorMessage​(Image image,
                                    String message)
        Description copied from interface: IStatusLineManager
        Sets the image and error message to be displayed on the status line.

        An error message overrides the current message until the error message is cleared (set to null).

        Specified by:
        setErrorMessage in interface IStatusLineManager
        Parameters:
        image - the image to use, or null for no image
        message - the error message, or null to clear the current error message.
      • setMessage

        public void setMessage​(String message)
        Description copied from interface: IStatusLineManager
        Sets the message text to be displayed on the status line. The image on the status line is cleared.

        This method replaces the current message but does not affect the error message. That is, the error message, if set, will continue to be displayed until it is cleared (set to null).

        Specified by:
        setMessage in interface IStatusLineManager
        Parameters:
        message - the message, or null for no message
      • setMessage

        public void setMessage​(Image image,
                               String message)
        Description copied from interface: IStatusLineManager
        Sets the image and message to be displayed on the status line.

        This method replaces the current message but does not affect the error message. That is, the error message, if set, will continue to be displayed until it is cleared (set to null).

        Specified by:
        setMessage in interface IStatusLineManager
        Parameters:
        image - the image to use, or null for no image
        message - the message, or null for no message
      • setVisible

        public void setVisible​(boolean visible)
        Description copied from class: SubContributionManager
        Sets the visibility of the manager. If the visibility is true then each item within the manager appears within the parent manager. Otherwise, the items are not visible.
        Overrides:
        setVisible in class SubContributionManager
        Parameters:
        visible - the new visibility
      • update

        public void update​(boolean force)
        Description copied from interface: IContributionManager
        Updates this manager's underlying widget(s) with any changes which have been made to it or its items. Normally changes to a contribution manager merely mark it as dirty, without updating the underlying widgets. This brings the underlying widgets up to date with any changes.
        Specified by:
        update in interface IContributionManager
        Parameters:
        force - true means update even if not dirty, and false for normal incremental updating