Console Factories

Identifier:

org.eclipse.ui.console.consoleFactories

Since:

3.1

Description:

A console factory creates or activates a console, and appears as an action in the console view.

Configuration Markup:

<!ELEMENT extension (consoleFactory)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT consoleFactory EMPTY>

<!ATTLIST consoleFactory

label CDATA #REQUIRED

icon CDATA #IMPLIED

class CDATA #REQUIRED>

label - action label to appear in menu
icon - optional plug-in relative path to an icon to appear with the action
class - class implementing org.eclipse.ui.console.IConsoleFactory that will be called when the associated action is invoked

Examples:

The following is an example of a console factory extension point:


<extension point="org.eclipse.ui.console.consoleFactories">
  <consoleFactory 
     label="Command Console"
     class="com.example.CommandConsoleFactory"
     icon="icons/cmd_console.png">
  </consoleFactory>
</extension>

This extension will cause an entry to appear in the console view's Open Console drop-down menu labelled Command Console with the specified icon. When the action is invoked by a user, the method openConsole() on the class com.example.CommandConsoleFactory will be called. The factory can the decide to create a new console or activate an existing console.

API Information:

Value of the attribute class must be a fully qualified name of a Java class that implements the interface org.eclipse.ui.console.IConsoleFactory.

Supplied Implementation:

The console plug-in provides a console factory to open a new console view.

Copyright (c) 2004, 2005 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0