Eclipse Platform
Release 3.1

org.eclipse.ui.console
Interface IConsoleFactory


public interface IConsoleFactory

A console factory extension is responsible for opening a console in the console view. Extensions appear on a menu in the console view, and their openConsole method is called when the action is invoked. Implementations may choose to open a new console or activate an existing console. The extension point used to contribute a console factory is org.eclipse.ui.console.consoleFactories.

Following is an example console factory extension.

 <extension point="org.eclipse.ui.console.consoleFactories">
   <consoleFactory
      label="Command Console"
      icon="icons\cmd_console.gif"
      class="com.example.CommandConsoleFactory">
   </consoleFactory>
 </extension>
 
An action appears in the console view's 'Open Console' drop-down menu with the corresponding label and optional icon. When the action is invoked, the specified class is instantiated and called to open a console, via the method openConsole().

Clients providing console factory extensions are intended to implement this interface.

Since:
3.1

Method Summary
 void openConsole()
          Opens a console in the console view.
 

Method Detail

openConsole

public void openConsole()
Opens a console in the console view. Implementations may create a new console or activate an existing console.


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.