Package org.eclipse.ui.console

Interface IConsole

All Known Implementing Classes:
AbstractConsole, IOConsole, MessageConsole, TextConsole
public interface IConsole
A console. A console is commonly used to display messages such as the output streams of a system process. A console can be displayed in one or more console views.

The console implementations provided by this plug-in are textual (TextConsole, MessageConsole and IOConsole). However a client can provide alternate presentations since a console implementation is responsible for providing is page for the page book views in which consoles are displayed.

Subclass AbstractConsole when implementing this interface.

Since:
3.0

  • Method Details

    • getName

      String getName()
      Returns the name of this console.
      Returns:
      the name of this console

    • getImageDescriptor

      ImageDescriptor getImageDescriptor()
      Returns an image descriptor for this console, or null if none.
      Returns:
      an image descriptor for this console, or null if none

    • createPage

      IPageBookViewPage createPage(IConsoleView view)
      Creates and returns a new page for this console. The page is displayed for this console in the console given view.
      Parameters:
      view - the view in which the page is to be created
      Returns:
      a page book view page representation of this console

    • addPropertyChangeListener

      void addPropertyChangeListener(IPropertyChangeListener listener)
      Adds a listener for changes to properties of this console. Has no effect if an identical listener is already registered.

      The changes supported by the console view are as follows:

      • IBasicPropertyConstants.P_TEXT - indicates the name of a console has changed
      • IBasicPropertyConstants.P_IMAGE - indicates the image of a console has changed

      Consoles may define additional properties as required.

      Parameters:
      listener - a property change listener

    • removePropertyChangeListener

      void removePropertyChangeListener(IPropertyChangeListener listener)
      Removes the given property listener from this console page. Has no effect if an identical listener is not already registered.
      Parameters:
      listener - a property listener

    • getType

      String getType()
      Returns a unique identifier for this console's type, or null if unspecified.
      Returns:
      a unique identifier for this console's type, or null
      Since:
      3.1

    • pageShown

      default void pageShown()
      Notifies this console that its page has been shown in the UI. This method is called when this console page is shown on top of other console pages in at least one visible console view.

      Default implementation does nothing.

      Subclasses may override this method to be notified when the console page for this console is visible to user.

      Since:
      3.17

    • pageHidden

      default void pageHidden()
      Notifies this console that its page has been hidden in the UI. This method is called when this console page is not shown on top of other console pages in any of visible console views.

      Default implementation does nothing.

      Subclasses may override this method to be notified when the console page for this console is not longer visible to user.

      Since:
      3.17