Java Doc for IKeyConfiguration.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » commands » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.commands

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui.commands .IKeyConfiguration

All known Subclasses:   org.eclipse.ui.internal.keys .SchemeLegacyWrapper,
IKeyConfiguration
public interface IKeyConfiguration extends Comparable(Code)

An instance of IKeyConfiguration is a handle representing a key configuration as defined by the extension point org.eclipse.ui.commands. The identifier of the handle is identifier of the key configuration being represented.

An instance of IKeyConfiguration can be obtained from an instance of ICommandManager for any identifier, whether or not a key configuration with that identifier defined in the plugin registry.

The handle-based nature of this API allows it to work well with runtime plugin activation and deactivation. If a key configuration is defined, that means that its corresponding plug-in is active. If the plug-in is then deactivated, the configuration will still exist but it will be undefined. An attempt to use an undefined key configuration will result in a NotDefinedException being thrown.

This interface is not intended to be extended or implemented by clients.

since:
   3.0
See Also:   IKeyConfigurationListener
See Also:   ICommandManager
See Also:   org.eclipse.jface.bindings.Scheme

Method Summary
void addKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
     Registers an instance of IKeyConfigurationListener to listen for changes to attributes of this instance.
Parameters:
  keyConfigurationListener - the instance of IKeyConfigurationListener toregister.
String getDescription()

Returns the description of the key configuration represented by this handle, suitable for display to the user.

Notification is sent to all registered listeners if this attribute changes.
the description of the key configuration represented by thishandle.
String getId()
     Returns the identifier of this handle. the identifier of this handle.
String getName()

Returns the name of the key configuration represented by this handle, suitable for display to the user.
String getParentId()

Returns the identifier of the parent of the key configuration represented by this handle.

Notification is sent to all registered listeners if this attribute changes.
the identifier of the parent of the key configurationrepresented by this handle.
boolean isActive()

Returns whether or not this command is active.
boolean isDefined()

Returns whether or not the key configuration represented by this handle is defined.
void removeKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)
     Unregisters an instance of IKeyConfigurationListener listening for changes to attributes of this instance.
Parameters:
  keyConfigurationListener - the instance of IKeyConfigurationListener tounregister.

Method Detail
addKeyConfigurationListener
void addKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)(Code)
Registers an instance of IKeyConfigurationListener to listen for changes to attributes of this instance.
Parameters:
  keyConfigurationListener - the instance of IKeyConfigurationListener toregister. Must not be null. If an attempt ismade to register an instance of IKeyConfigurationListenerwhich is already registered with this instance, no operationis performed.

getDescription
String getDescription() throws NotDefinedException(Code)

Returns the description of the key configuration represented by this handle, suitable for display to the user.

Notification is sent to all registered listeners if this attribute changes.
the description of the key configuration represented by thishandle. Guaranteed not to be null.
throws:
  NotDefinedException - if the key configuration represented by this handle is notdefined.

getId
String getId()(Code)
Returns the identifier of this handle. the identifier of this handle. Guaranteed not to benull.

getName
String getName() throws NotDefinedException(Code)

Returns the name of the key configuration represented by this handle, suitable for display to the user.

Notification is sent to all registered listeners if this attribute changes.
the name of the key configuration represented by this handle.Guaranteed not to be null.
throws:
  NotDefinedException - if the key configuration represented by this handle is notdefined.

getParentId
String getParentId() throws NotDefinedException(Code)

Returns the identifier of the parent of the key configuration represented by this handle.

Notification is sent to all registered listeners if this attribute changes.
the identifier of the parent of the key configurationrepresented by this handle. May be null.
throws:
  NotDefinedException - if the key configuration represented by this handle is notdefined.

isActive
boolean isActive()(Code)

Returns whether or not this command is active. Instances of ICommand are activated and deactivated by the instance of ICommandManager from whence they were brokered.

Notification is sent to all registered listeners if this attribute changes.
true, iff this command is active.

isDefined
boolean isDefined()(Code)

Returns whether or not the key configuration represented by this handle is defined.

Notification is sent to all registered listeners if this attribute changes.
true, iff the key configuration represented bythis handle is defined.

removeKeyConfigurationListener
void removeKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener)(Code)
Unregisters an instance of IKeyConfigurationListener listening for changes to attributes of this instance.
Parameters:
  keyConfigurationListener - the instance of IKeyConfigurationListener tounregister. Must not be null. If an attempt ismade to unregister an instance ofIKeyConfigurationListener which is not alreadyregistered with this instance, no operation is performed.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.