Each context is defined by the extension point org.eclipse.ui.contexts.

<table border="1">

<table border="1">

Line 262:

Line 264:

<td>SSE.ui/plugin.xml</td>

<td>SSE.ui/plugin.xml</td>

<td>Context</td>

<td>Context</td>

−

<td><Context for when the Structured Text Editor is being used as one of the editors. Commands should use this to determine when they are active, enabled, and/or visible on a menu or toolbar.</td>

+

<td>Context for when the Structured Text Editor is being used as one of the editors. Commands should use this to determine when they are active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.core.runtime.xml</td>

+

<td>Editing XML Source</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>Context for when the XML Source editor is being used. Commands should use this when the XML-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.navigation</td>

+

<td>XML Source Navigation</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when XML-contributed Navigation commands should be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.cleanup</td>

+

<td>XML Source Cleanup</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Cleanup handler should be active or enabled.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.comments</td>

+

<td>XML Source Comments</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Comment commands should be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.selection</td>

+

<td>XML Source Selection</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Selection handlers should be active or enabled.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.dependencies</td>

+

<td>XML Source Dependencies</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Dependency commands should be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.grammar</td>

+

<td>XML Source Grammar</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Grammar Constraints commands should be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.expand</td>

+

<td>XML Source Expand/Collapse</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Expand/Collapse commands should be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.xml.occurrences</td>

+

<td>XML Source Occurrences</td>

+

<td>XML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the XML-contributed Find Occurrences handler should be active or enabled.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.html.core.htmlsource</td>

+

<td>Editing HTML Source</td>

+

<td>HTML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>Context for when the HTML Source editor is being used. Commands should use this when the HTML-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.html.occurrences</td>

+

<td>HTML Source Occurrences</td>

+

<td>HTML.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>This context should be used to determine when the HTML-contributed Find Occurrences handler should be active or enabled.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.jst.jsp.ui.structured.text.editor.jsp.scope</td>

+

<td>Editing JSP Source</td>

+

<td>JSP.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>Context for when the JSP Source editor is being used. Commands should use this when the JSP-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.jst.jsp.core.jspsource</td>

+

<td>Editing JSP Source</td>

+

<td>JSP.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>Context for when the JSP Source editor is being used. Commands should use this when the JSP-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.</td>

+

</tr>

+

<tr>

+

<td>org.eclipse.wst.css.core.csssource</td>

+

<td>Editing CSS Source</td>

+

<td>CSS.ui/plugin.xml</td>

+

<td>Context</td>

+

<td>Context for when the CSS Source editor is being used. Commands should use this when the CSS-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.</td>

</tr>

</tr>

</table>

</table>

Revision as of 15:27, 3 April 2008

Contents

Introduction

There are a vast number of ids that are used within the WTP. Every command, content-type, action, menu, etc has an id that is associated with it. This page will try to keep up to date with the various ids, where they can be found, and what they correspond too.

It is important to document the usage of the ids, especially when they relate to menus, toolbars, commands, and popups as the org.eclipse.ui.menus extension point allows for other plugins to contribute to menus based off the ids that are published. Commands are also referenced by id, and are implemented based on handlers.

Eclipse 3.3 introduced the org.eclipse.ui.menus extension point, this is to eventually replace the 4 contribution points that exist currently for creating menus. A detailed mapping can be found at Menus Extension Mapping. Paul Webster has created a good overview of the new org.eclipse.ui.menus extension point in his blog.

A general source main menu that can be contributed to from other plug-ins.

org.eclipse.core.runtime.xml.source.EditorContext

Source

SSE.ui/plugin.xml

Popup Menu

Source Editors popup menu.

Commands

Commands are implemented and tied to menus using handlers. They can also be tied to actionSets and have actionDelegates. If implemented using handlers, a command may have zero to many handlers, but only zero to one may be active at any given point in time. Handlers can be specified using either the org.eclipse.ui.handlers extension point or programmatically.

Id

Category Id

Menu/Toolbar

Location

Description

org.eclipse.wst.sse.ui.structure.select.enclosing

org.eclipse.ui.category.edit

Edit

SSE.ui/plugin.xml

Select Enclosing

org.eclipse.wst.sse.ui.structure.select.next

org.eclipse.ui.category.edit

Edit

SSE.ui/plugin.xml

Select Next

org.eclipse.wst.sse.ui.structure.select.previous

org.eclipse.ui.category.edit

Edit

SSE.ui/plugin.xml

Select Previous

org.eclipse.wst.sse.ui.structure.select.last

org.eclipse.ui.category.edit

Edit

SSE.ui/plugin.xml

Select Last

org.eclipse.wst.sse.ui.toggle.comment

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Toggle Comment

org.eclipse.wst.sse.ui.add.block.comment

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Add Block Comment

org.eclipse.wst.sse.ui.remove.block.comment

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Remove Block Comment

org.eclipse.wst.sse.ui.cleanup.document

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Cleanup Document

org.eclipse.wst.sse.ui.format.document

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Format Document

org.eclipse.wst.sse.ui.format.active.elements

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Format Active Elements

org.eclipse.wst.sse.ui.open.file.from.source

org.eclipse.ui.category.edit

Navigate

SSE.ui/plugin.xml

Open File From Source

org.eclipse.wst.sse.ui.search.find.occurrences

org.eclipse.ui.category.edit

Source

SSE.ui/plugin.xml

Find Occurrences

org.eclipse.wst.sse.ui.goto.matching.bracket

org.eclipse.ui.category.edit

Navigate

SSE.ui/plugin.xml

Go To Matching Bracket

org.eclipse.wst.xml.ui.nextSibling

org.eclipse.ui.category.edit

Navigate

XML.ui/plugin.xml

Go To Next Sibling

org.eclipse.wst.xml.ui.previousSibling

org.eclipse.ui.category.edit

Navigate

XML.ui/plugin.xml

Go To Previous Sibling

org.eclipse.wst.xml.ui.gotoMatchingTag

org.eclipse.ui.category.edit

Navigate

XML.ui/plugin.xml

Go To Matching Tag

org.eclipse.jst.jsp.ui.refactor.rename

org.eclipse.ui.category.edit

Refactor

JSP.ui/plugin.xml

Rename a Java Element

org.eclipse.jst.jsp.ui.refactor.move

org.eclipse.ui.category.edit

Refactor

JSP.ui/plugin.xml

Move a Java Element to another package

Context IDs

Used to indicate when particular contexts are active.

Each context is defined by the extension point org.eclipse.ui.contexts.

Id

Name

Location

Type

Description

org.eclipse.wst.sse.ui.structuredTextEditorScope

Editing in Structured Text Editors

SSE.ui/plugin.xml

Context

Context for when the Structured Text Editor is being used as one of the editors. Commands should use this to determine when they are active, enabled, and/or visible on a menu or toolbar.

org.eclipse.core.runtime.xml

Editing XML Source

XML.ui/plugin.xml

Context

Context for when the XML Source editor is being used. Commands should use this when the XML-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.navigation

XML Source Navigation

XML.ui/plugin.xml

Context

This context should be used to determine when XML-contributed Navigation commands should be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.cleanup

XML Source Cleanup

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Cleanup handler should be active or enabled.

org.eclipse.wst.xml.comments

XML Source Comments

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Comment commands should be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.selection

XML Source Selection

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Selection handlers should be active or enabled.

org.eclipse.wst.xml.dependencies

XML Source Dependencies

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Dependency commands should be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.grammar

XML Source Grammar

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Grammar Constraints commands should be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.expand

XML Source Expand/Collapse

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Expand/Collapse commands should be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.xml.occurrences

XML Source Occurrences

XML.ui/plugin.xml

Context

This context should be used to determine when the XML-contributed Find Occurrences handler should be active or enabled.

org.eclipse.wst.html.core.htmlsource

Editing HTML Source

HTML.ui/plugin.xml

Context

Context for when the HTML Source editor is being used. Commands should use this when the HTML-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.html.occurrences

HTML Source Occurrences

HTML.ui/plugin.xml

Context

This context should be used to determine when the HTML-contributed Find Occurrences handler should be active or enabled.

org.eclipse.jst.jsp.ui.structured.text.editor.jsp.scope

Editing JSP Source

JSP.ui/plugin.xml

Context

Context for when the JSP Source editor is being used. Commands should use this when the JSP-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.jst.jsp.core.jspsource

Editing JSP Source

JSP.ui/plugin.xml

Context

Context for when the JSP Source editor is being used. Commands should use this when the JSP-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.

org.eclipse.wst.css.core.csssource

Editing CSS Source

CSS.ui/plugin.xml

Context

Context for when the CSS Source editor is being used. Commands should use this when the CSS-contributed handler will always be used, and to determine when they will be active, enabled, and/or visible on a menu or toolbar.

Bugs

The following outstanding issues need to be addressed to allow complete conversion to the new org.eclipse.ui.menus extension point:

bug 213385 - The search menu in the platform uses actionSets which aren't extensible by the org.eclipse.ui.menus extension.

Core Command Expressions

Commands, Handlers, and Menu contributions are all driven by Core Command Expressions. These allow for control of when a particular command is available in a menu, when it is active, and when it is enabled. The following are some brief examples for controlling when commands are made available based on the type of variable involved.

activeContexts

The activeContexts variable returns a list of all the activeContextsIDs