Package org.eclipse.ui.console

Interface IConsolePageParticipant

All Superinterfaces:
IAdaptable
public interface IConsolePageParticipant extends IAdaptable
A console page participant is notified of page lifecycle events such as creation, activation, deactivation and disposal. A page participant can also provide adapters for a page. Participants are contributed via the org.eclispe.ui.console.consolePageParticipants extension point.

Participant behavior is implementation dependent. For example, a page participant could add actions to a console's toolbar by accessing a its page's action bars.

Following is an example extension definition. 

 <extension point="org.eclipse.ui.console.consolePageParticipants">
   <consolePageParticipant
      id="com.example.ExamplePageParticipant"
      class="com.example.ExamplePageParticipant">
   </consolePageParticipant>
 </extension>
The example page participant is contributed to all console pages. An optional enablement attribute may be specified to control which consoles a page participant is applicable to.

Clients contributing console page participant extensions are intended to implement this interface.

Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activated()
    Notification this participant's page has been activated.
    void
    deactivated()
    Notification this participant's page has been deactivated.
    void
    dispose()
    Disposes this page participant.
    void
    init(IPageBookViewPage page, IConsole console)
    Called during page initialization.

    Methods inherited from interface org.eclipse.core.runtime.IAdaptable

    getAdapter

  • Method Details

    • init

      void init(IPageBookViewPage page, IConsole console)
      Called during page initialization. Marks the start of this page participant's lifecycle.
      Parameters:
      page - the page corresponding to the given console
      console - the console for which a page has been created

    • dispose

      void dispose()
      Disposes this page participant. Marks the end of this page participant's lifecycle.

    • activated

      void activated()
      Notification this participant's page has been activated.

    • deactivated

      void deactivated()
      Notification this participant's page has been deactivated.