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.
Note in 3.3:
Currently, source variables are not extensible by user plugins, and
the number of bits available for resolving conflicts is limited. When
the variable sources become user extensible a new conflict resolution
mechanism will be implemented.
This interface is not intended to be implemented or extended by clients.
The priority given when the source includes the active workbench site. In
the case of nesting components, one should be careful to only activate
the most nested component.
The variable name for the active workbench site. This is for use with the
ISourceProvider and IEvaluationContext.
ACTIVE_WORKBENCH_WINDOW
final public static int ACTIVE_WORKBENCH_WINDOW(Code)
The priority given when the source includes the currently active
workbench window.
ACTIVE_WORKBENCH_WINDOW_IS_COOLBAR_VISIBLE_NAME
final public static String ACTIVE_WORKBENCH_WINDOW_IS_COOLBAR_VISIBLE_NAME(Code)
The variable name for the coolbar visibility state of the active
workbench window. This is for use with the ISourceProvider
and IEvaluationContext.
since: 3.3
final public static String ACTIVE_WORKBENCH_WINDOW_IS_PERSPECTIVEBAR_VISIBLE_NAME(Code)
The variable name for the perspective bar visibility state of the active
workbench window. This is for use with the ISourceProvider
and IEvaluationContext.
since: 3.3
ACTIVE_WORKBENCH_WINDOW_NAME
final public static String ACTIVE_WORKBENCH_WINDOW_NAME(Code)
The variable name for the active workbench window. This is for use with
the ISourceProvider and IEvaluationContext.
ACTIVE_WORKBENCH_WINDOW_SHELL
final public static int ACTIVE_WORKBENCH_WINDOW_SHELL(Code)
The priority given when the source includes the currently active
workbench window shell.
since: 3.2
ACTIVE_WORKBENCH_WINDOW_SHELL_NAME
final public static String ACTIVE_WORKBENCH_WINDOW_SHELL_NAME(Code)
The variable name for the active workbench window shell. This is for use
with the ISourceProvider and
IEvaluationContext.
since: 3.2
ACTIVE_WORKBENCH_WINDOW_SUBORDINATE
final public static int ACTIVE_WORKBENCH_WINDOW_SUBORDINATE(Code)
The priority given when the source includes subordinate properties of the currently active
workbench window.
since: 3.3