|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A callback mechanism for some external tool to communicate extra information to actions and action contribution items.
Method Summary | |
void |
addPropertyChangeListener(String identifier,
IPropertyChangeListener listener)
Adds a listener to the object referenced by identifier .
|
Integer |
getAccelerator(String identifier)
An accessor for the accelerator associated with the item indicated by the identifier. |
String |
getAcceleratorText(String identifier)
An accessor for the accelerator text associated with the item indicated by the identifier. |
boolean |
isAcceleratorInUse(int accelerator)
Checks to see whether the given accelerator is being used by some other mechanism (outside of the menus controlled by JFace). |
boolean |
isActive(String identifier)
Checks whether the item matching this identifier is active. |
void |
removePropertyChangeListener(String identifier,
IPropertyChangeListener listener)
Removes a listener from the object referenced by identifier . |
Method Detail |
public void addPropertyChangeListener(String identifier, IPropertyChangeListener listener)
Adds a listener to the object referenced by identifier
.
This listener will be notified if a property of the item is to be
changed. This identifier is specific to mechanism being used. In the
case of the Eclipse workbench, this is the command identifier.
A single instance of the listener may only ever be associated with one identifier. Attempts to add the listener twice (without a removal inbetween) has undefined behaviour.
identifier
- The identifier of the item to which the listener should be
attached; must not be null
.listener
- The listener to be added; must not be null
.public Integer getAccelerator(String identifier)
identifier
- The identifier of the item from which the accelerator
should be obtained ; must not be null
.
public String getAcceleratorText(String identifier)
identifier
- The identifier of the item from which the accelerator text
should be obtained ; must not be null
.
public boolean isAcceleratorInUse(int accelerator)
accelerator
- The accelerator to check -- in SWT's internal accelerator
format.
true
if the accelerator is already being used
and shouldn't be used again; false
otherwise.public boolean isActive(String identifier)
identifier
- The identifier of the item from which the active state
should be retrieved; must not be null
.
true
if the item is active; false
otherwise.public void removePropertyChangeListener(String identifier, IPropertyChangeListener listener)
identifier
. This identifier is specific to mechanism
being used. In the case of the Eclipse workbench, this is the command
identifier.
identifier
- The identifier of the item to from the listener should be
removed; must not be null
.listener
- The listener to be removed; must not be null
.
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.