Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.contexts
Class EnabledSubmission

java.lang.Object
  extended by 
org.eclipse.ui.contexts.EnabledSubmission
All Implemented Interfaces:
Comparable

Deprecated. Please use IContextService.activateContext instead.

public final class EnabledSubmission
extends Object
implements Comparable

An instance of this class represents a request to enabled a context. An enabled submission specifies a list of conditions under which it would be appropriate for a particular context to be enabled. These conditions include things like the active part or the active shell. So, it is possible to say things like: "when the java editor is active, please consider enabling the 'editing java' context".

The workbench considers all of the submissions it has received and choses the ones it views as the best possible match.

This class is not intended to be extended by clients.

Note: this class has a natural ordering that is inconsistent with equals.

Since:
3.0
See Also:
IWorkbenchContextSupport, IContextService

Constructor Summary
EnabledSubmission ( String activePartId, Shell activeShell, IWorkbenchPartSite activeWorkbenchPartSite, String contextId)
          Deprecated. Creates a new instance of this class.
 
Method Summary
 int compareTo ( Object object)
          Deprecated.  
  String getActivePartId ()
          Deprecated. Returns the identifier of the part that must be active for this request to be considered.
  Shell getActiveShell ()
          Deprecated. Returns the shell that must be active for this request to be considered.
  IWorkbenchPartSite getActiveWorkbenchPartSite ()
          Deprecated. Returns the workbench part site of the part that must be active for this request to be considered.
  String getContextId ()
          Deprecated. Returns the identifier of the context to be enabled.
  String toString ()
          Deprecated.  
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EnabledSubmission

public EnabledSubmission(
String activePartId,
                         
Shell activeShell,
                         
IWorkbenchPartSite activeWorkbenchPartSite,
                         
String contextId)
Deprecated. 
Creates a new instance of this class.

Parameters:
activePartId - the identifier of the part that must be active for this request to be considered. May be null.
activeShell - the shell that must be active for this request to be considered. May be null.
activeWorkbenchPartSite - the workbench part site of the part that must be active for this request to be considered. May be null.
contextId - the identifier of the context to be enabled. Must not be null.
Method Detail

compareTo

public int compareTo(
Object object)
Deprecated. 
Specified by:
compareTo in interface Comparable
See Also:
Comparable.compareTo(java.lang.Object)

getActivePartId

public 
String getActivePartId()
Deprecated. 
Returns the identifier of the part that must be active for this request to be considered.

Returns:
the identifier of the part that must be active for this request to be considered. May be null.

getActiveShell

public 
Shell getActiveShell()
Deprecated. 
Returns the shell that must be active for this request to be considered.

Returns:
the shell that must be active for this request to be considered. May be null.

getActiveWorkbenchPartSite

public 
IWorkbenchPartSite getActiveWorkbenchPartSite()
Deprecated. 
Returns the workbench part site of the part that must be active for this request to be considered.

Returns:
the workbench part site of the part that must be active for this request to be considered. May be null.

getContextId

public 
String getContextId()
Deprecated. 
Returns the identifier of the context to be enabled.

Returns:
the identifier of the context to be enabled. Guaranteed not to be null.

toString

public 
String toString()
Deprecated. 
Overrides:
toString in class Object
See Also:
Object.toString()

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire