|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISources
A source is type of event change that can occur within the workbench. For example, the active workbench window can change, so it is considered a source. Workbench services can track changes to these sources, and thereby try to resolve conflicts between a variety of possible options. This is most commonly used for things like handlers and contexts.
This interface defines the source that are known to the workbench at
compile-time. These sources can be combined in a bit-wise fashion. So, for
example, a ACTIVE_PART | ACTIVE_CONTEXT
source includes change
to both the active context and the active part.
The values assigned to each source indicates its relative priority. The
higher the value, the more priority the source is given in resolving
conflicts. Another way to look at this is that the higher the value, the more
"local" the source is to what the user is currently doing. This is similar
to, but distinct from the concept of components. The nesting support provided
by components represent only one source (ACTIVE_SITE
) that
the workbench understands.
Note that for backward compatibility, we must reserve the lowest three bits
for Priority
instances using the old
HandlerSubmission
mechanism. This mechanism was used in
Eclipse 3.0.
There are unused bits. This is intentional, and is intended to allow clients
space to define their own priorities. The workbench will not add further
priorities in the future without declaring it as a breaking change. If you
want to define your own sources, then you must create a
ISourceProvider
and register it with a workbench service.
This interface is not intended to be implemented or extended by clients.
ISourceProvider
Field Summary | |
---|---|
static int |
ACTIVE_ACTION_SETS
The priority given when the source includes a particular action set. |
static java.lang.String |
ACTIVE_ACTION_SETS_NAME
The variable name for the active action sets. |
static int |
ACTIVE_CONTEXT
The priority given when the source includes a particular context. |
static java.lang.String |
ACTIVE_CONTEXT_NAME
The variable name for the active contexts. |
static int |
ACTIVE_CURRENT_SELECTION
The priority given when the source includes the current selection. |
static java.lang.String |
ACTIVE_CURRENT_SELECTION_NAME
The variable name for the active selection. |
static int |
ACTIVE_EDITOR
The priority given when the source includes the active editor part. |
static int |
ACTIVE_EDITOR_ID
The priority given when the source includes the active editor identifier. |
static java.lang.String |
ACTIVE_EDITOR_ID_NAME
The variable name for the active editor identifier. |
static java.lang.String |
ACTIVE_EDITOR_NAME
The variable name for the active editor part. |
static int |
ACTIVE_MENU
The priority given when the source includes the current menu. |
static java.lang.String |
ACTIVE_MENU_NAME
The variable name for the active menu. |
static int |
ACTIVE_PART
The priority given when the source includes the active part. |
static int |
ACTIVE_PART_ID
The priority given when the source includes the active part id. |
static java.lang.String |
ACTIVE_PART_ID_NAME
The variable name for the active part id. |
static java.lang.String |
ACTIVE_PART_NAME
The variable name for the active part. |
static int |
ACTIVE_SHELL
The priority given when the source includes the currently active shell. |
static java.lang.String |
ACTIVE_SHELL_NAME
The variable name for the active shell. |
static int |
ACTIVE_SITE
The priority given when the source includes the active workbench site. |
static java.lang.String |
ACTIVE_SITE_NAME
The variable name for the active workbench site. |
static int |
ACTIVE_WORKBENCH_WINDOW
The priority given when the source includes the currently active workbench window. |
static java.lang.String |
ACTIVE_WORKBENCH_WINDOW_NAME
The variable name for the active workbench window. |
static int |
ACTIVE_WORKBENCH_WINDOW_SHELL
The priority given when the source includes the currently active workbench window shell. |
static java.lang.String |
ACTIVE_WORKBENCH_WINDOW_SHELL_NAME
The variable name for the active workbench window shell. |
static int |
LEGACY_LEGACY
The priority given when the activation is defined by a handler submission with a legacy priority. |
static int |
LEGACY_LOW
The priority given when the activation is defined by a handler submission with a low priority. |
static int |
LEGACY_MEDIUM
The priority given when the activation is defined by a handler submission with a medium priority. |
static int |
WORKBENCH
The priority given to default handlers and handlers that are active across the entire workbench. |
Field Detail |
---|
static final int WORKBENCH
static final int LEGACY_LEGACY
static final int LEGACY_LOW
static final int LEGACY_MEDIUM
static final int ACTIVE_CONTEXT
static final java.lang.String ACTIVE_CONTEXT_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_ACTION_SETS
static final java.lang.String ACTIVE_ACTION_SETS_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_SHELL
static final java.lang.String ACTIVE_SHELL_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_WORKBENCH_WINDOW_SHELL
static final java.lang.String ACTIVE_WORKBENCH_WINDOW_SHELL_NAME
ISourceProvider
and
IEvaluationContext
.
static final int ACTIVE_WORKBENCH_WINDOW
static final java.lang.String ACTIVE_WORKBENCH_WINDOW_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_EDITOR
static final java.lang.String ACTIVE_EDITOR_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_EDITOR_ID
static final java.lang.String ACTIVE_EDITOR_ID_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_PART
static final java.lang.String ACTIVE_PART_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_PART_ID
static final java.lang.String ACTIVE_PART_ID_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_SITE
static final java.lang.String ACTIVE_SITE_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_CURRENT_SELECTION
static final java.lang.String ACTIVE_CURRENT_SELECTION_NAME
ISourceProvider
and IEvaluationContext
.
static final int ACTIVE_MENU
static final java.lang.String ACTIVE_MENU_NAME
ISourceProvider
and IEvaluationContext
.
|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.