schema.editors.exsd Maven / Gradle / Ivy
The newest version!
This extension point is used to add new editors to the
workbench. A editor is a visual component within a
workbench page. It is typically used to edit or browse
a document or input object. To open an editor, the user
will typically invoke "Open" on an <samp>IFile</samp>.
When this action is performed the workbench registry
is consulted to determine an appropriate editor for
the file type and then a new instance of the editor
type is created. The actual result depends on the
type of the editor. The workbench provides support
for the creation of internal editors, which are tightly
integrated into the workbench, and external editors,
which are launched in a separate frame window.
There are also various level of integration between
these extremes.
<p>
In the case of an internal editor tight integration can
be achieved between the workbench window and the editor
part. The workbench menu and toolbar are pre-loaded
with a number of common actions, such as cut, copy, and
paste. The active part, view or editor, is expected to
provide the implementation for these actions. An internal
editor may also define new actions which appear in the
workbench window. These actions only appear when the
editor is active.
<p>
The integration between the workbench and external
editors is more tenuous. In this case the workbench
may launch an editor but after has no way of determining
the state of the external editor or collaborating
with it by any means except through the file system.
a fully qualified identifier of the target extension point
an optional identifier of the extension instance
an optional name of the extension instance
a unique name that will be used to identify this editor
a translatable name that will be used in the UI for this editor
A relative name of the icon that will be used for all resources that match the specified extensions. Editors should provide an icon to make it easy for users to distinguish between different editor types. If you specify a command rather than a class, an icon is not needed. In that case, the workbench
will use the icon provided by the operating system.
an optional field containing the list of file types understood by the editor. This is a string containing comma separate file extensions. For instance, an editor which understands hypertext documents may register for "htm, html".
the name of a class that implements <samp>org.eclipse.ui.IEditorPart</samp>. The attributes <samp>class</samp>, <samp>command</samp>, and <samp>launcher</samp> are mutually exclusive. If this attribute is defined then <samp>contributorClass</samp> should also be defined.
a command to run in order to launch an external editor. The executable command must be located on the system path or in the plug-in's directory. The attributes <samp>class</samp>, <samp>command</samp>, and <samp>launcher</samp> are mutually exclusive.
the name of a class which that implements <samp>org.eclipse.ui.IEditorLauncher</samp>.
A launcher will open an external editor. The attributes <samp>class</samp>, <samp>command</samp>, and <samp>launcher</samp> are mutually exclusive.
the name of a class that implements <samp>org.eclipse.ui.IEditorActionBarContributor</samp>. This attribute should only be defined if the <samp>class</samp> attribute is defined. This class is used to add new actions to the workbench menu and tool bar which reflect the features of the editor type.
if true, this editor will be used as the default editor for the
type. This is only relevant in a case where more than one editor
is registered for the same type. If an editor is not the default
for the type, it can still be launched using "Open with..."
submenu for the selected resource.
<p>
Please note that this attribute is only honored for filename and extension associations at this time. It will not be honored for content type bindings. Content type-based resolution will occur on a first come, first serve basis and is not explicitly specified.</p>
an optional field containing the list of file names
understood by the editor. This is a string
containing comma separate file names. For instance,
an editor which understands specific hypertext
documents may register for "ejb.htm, ejb.html".
the symbolic name of a font. The symbolic font name must be the id of a defined font (see org.eclipse.ui.fontDefinitions). If this attribute is missing or invalid then the font name is the value of "org.eclipse.jface.textfont" in the editor's preferences store. If there is no preference store or the key is not defined then the JFace text font will be used. The editor implementation decides if it uses this symbolic font name to set the font.
the name of a class that implements <samp>org.eclipse.ui.IEditorMatchingStrategy</samp>. This attribute should only be defined if the <samp>class</samp> attribute is defined. This allows the editor extension to provide its own algorithm for matching the input of one of its editors to a given editor input.
Advertises that the containing editor understands the given content type and is suitable for editing files of that type.
The content type identifier. This is an ID defined by the 'org.eclipse.core.contenttype.contentTypes' extension point.
The following is an example
of an internal editor extension definition:
<p>
<pre>
<extension point="org.eclipse.ui.editors">
<editor
id="com.xyz.XMLEditor"
name="Fancy XYZ XML editor"
icon="./icons/XMLEditor.gif"
extensions="xml"
class="com.xyz.XMLEditor"
contributorClass="com.xyz.XMLEditorContributor"
symbolicFontName="org.eclipse.jface.textfont"
default="false">
</editor>
</extension>
</pre>
</p>
If the command attribute is used, it will be treated
as an external program command line that will be executed
in a platform-dependent manner.
<p>
If the launcher attribute is used the editor will also
be treated as an external program. In this case the
specified class must implement
<samp>org.eclipse.ui.IEditorLauncher</samp>.
The launcher will be instantiated and then
<samp>open(IPath path)</samp> will be invoked to
launch the editor on the provided local file system path.
<p>
If the class attribute is used, the workbench will
assume that it is an internal editor and the specified
class must implement <samp>org.eclipse.ui.IEditorPart</samp>.
It is common practice to
<samp>subclass org.eclipse.ui.EditorPart</samp> when
defining a new editor type. It is also necessary to
define a <samp>contributorClass</samp> attribute.
The specified class must implement
<samp>org.eclipse.ui.IEditorActionBarContributor</samp>,
and is used to add new actions to the workbench
menu and tool bar which reflect the features of the
editor type.
<p>
Within the workbench there may be more than one open
editor of a particular type. For instance, there may
be one or more open Java Editors. To avoid the creation
of duplicate actions and action images the editor
concept has been split into two. An
<samp>IEditorActionBarContributor</samp> is responsible
for the creation of actions. The editor is responsible
for action implementation. Furthermore, the contributor
is shared by each open editor. As a result of this
design there is only one set of actions for one or
more open editors.
<p>
The contributor will add new actions to the workbench
menu and toolbar which reflect the editor type. These
actions are shared and, when invoked, act upon the
active editor. The active editor is passed to the
contributor by invoking
<samp>IEditorActionBarContributor.setActiveEditor</samp>.
The identifiers for actions and major groups within
the workbench window are defined in
<samp>org.eclipse.ui.IWorkbenchActionConstants</samp>.
These should be used as a reference point for the
addition of new actions. Top level menus are created
by using the following values for the path attribute:
<ul>
<li>
additions - represents a group to the left of the Window menu.
</li>
</ul>
Actions and menus added into these paths will only be
shown while the associated editor is active. When the
editor is closed, menus and actions will be removed.
The workbench provides a "Default Text Editor". The end user product may contain other editors as part of the shipping bundle. In that case, editors will be registered as extensions using the syntax described above.
Copyright (c) 2002, 2007 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at <a
href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
© 2015 - 2025 Weber Informatics LLC | Privacy Policy