| org.eclipse.ui.internal.commands.CommandImageManager
| CommandImageManager | | final public class CommandImageManager extends EventManager (Code) | |
A central lookup facility for images for commands. Images can be associated
with commands using this manager.
Clients may instantiate, but must not extend.
PROVISIONAL. This class or interface has been added as
part of a work in progress. There is a guarantee neither that this API will
work nor that it will remain the same. Please do not use this API without
consulting with the Platform/UI team.
This class is eventually intended to exist in
org.eclipse.jface.commands.
since:
3.2 |
| Field Summary | |
| final public static int | TYPE_DEFAULT
The type of image to display in the default case. | | final public static int | TYPE_DISABLED
The type of image to display if the corresponding command is disabled. | | final public static int | TYPE_HOVER
The type of image to display if the mouse is hovering over the command
and the command is enabled. |
| Method Summary | |
| final public void | addCommandImageManagerListener(ICommandImageManagerListener listener)
Adds a listener to this command image manager. | | final public void | bind(String commandId, int type, String style, URL url)
Binds a particular image path to a command id, type and style triple
Parameters:
commandId - The identifier of the command to which the image should bebound; must not be null.
Parameters:
type - The type of image to retrieve. | | final public void | bind(String commandId, int type, String style, ImageDescriptor descriptor)
Binds a particular image path to a command id, type and style triple
Parameters:
commandId - The identifier of the command to which the image should bebound; must not be null.
Parameters:
type - The type of image to retrieve. | | final public void | clear()
Removes all of the images from this manager. | | final public String | generateUnusedStyle(String commandId)
Generates a style tag that is not currently used for the given command.
This can be used by applications trying to create a unique style for a
new set of images.
Parameters:
commandId - The identifier of the command for which a unique style isrequired; must not be null. | | final public ImageDescriptor | getImageDescriptor(String commandId)
Retrieves the default image associated with the given command in the
default style.
Parameters:
commandId - The identifier to find; must not be null. | | final public ImageDescriptor | getImageDescriptor(String commandId, int type)
Retrieves the image of the given type associated with the given command
in the default style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
type - The type of image to retrieve. | | final public ImageDescriptor | getImageDescriptor(String commandId, int type, String style)
Retrieves the image of the given type associated with the given command
in the given style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
type - The type of image to retrieve. | | final public ImageDescriptor | getImageDescriptor(String commandId, String style)
Retrieves the default image associated with the given command in the
given style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
style - The style of the image to retrieve; may be null. | | final public void | removeCommandImageManagerListener(ICommandImageManagerListener listener)
Removes a listener from this command image manager. |
| TYPE_DEFAULT | | final public static int TYPE_DEFAULT(Code) | | The type of image to display in the default case.
|
| TYPE_DISABLED | | final public static int TYPE_DISABLED(Code) | | The type of image to display if the corresponding command is disabled.
|
| TYPE_HOVER | | final public static int TYPE_HOVER(Code) | | The type of image to display if the mouse is hovering over the command
and the command is enabled.
|
| addCommandImageManagerListener | | final public void addCommandImageManagerListener(ICommandImageManagerListener listener)(Code) | | Adds a listener to this command image manager. The listener will be
notified when the set of image bindings changes. This can be used to
track the global appearance and disappearance of image bindings.
Parameters:
listener - The listener to attach; must not be null. |
| bind | | final public void bind(String commandId, int type, String style, URL url)(Code) | | Binds a particular image path to a command id, type and style triple
Parameters:
commandId - The identifier of the command to which the image should bebound; must not be null.
Parameters:
type - The type of image to retrieve. This value must be one of theTYPE constants defined in this class.
Parameters:
style - The style of the image; may be null.
Parameters:
url - The URL to the image. Should not be null. |
| bind | | final public void bind(String commandId, int type, String style, ImageDescriptor descriptor)(Code) | | Binds a particular image path to a command id, type and style triple
Parameters:
commandId - The identifier of the command to which the image should bebound; must not be null.
Parameters:
type - The type of image to retrieve. This value must be one of theTYPE constants defined in this class.
Parameters:
style - The style of the image; may be null.
Parameters:
descriptor - The image descriptor. Should not be null. |
| clear | | final public void clear()(Code) | | Removes all of the images from this manager.
|
| generateUnusedStyle | | final public String generateUnusedStyle(String commandId)(Code) | | Generates a style tag that is not currently used for the given command.
This can be used by applications trying to create a unique style for a
new set of images.
Parameters:
commandId - The identifier of the command for which a unique style isrequired; must not be null. A style tag that is not currently used; may be null. |
| getImageDescriptor | | final public ImageDescriptor getImageDescriptor(String commandId)(Code) | | Retrieves the default image associated with the given command in the
default style.
Parameters:
commandId - The identifier to find; must not be null. An image appropriate for the given command; nevernull. |
| getImageDescriptor | | final public ImageDescriptor getImageDescriptor(String commandId, int type)(Code) | | Retrieves the image of the given type associated with the given command
in the default style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
type - The type of image to retrieve. This value must be one of theTYPE constants defined in this class. An image appropriate for the given command; nullif the given image type cannot be found. |
| getImageDescriptor | | final public ImageDescriptor getImageDescriptor(String commandId, int type, String style)(Code) | | Retrieves the image of the given type associated with the given command
in the given style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
type - The type of image to retrieve. This value must be one of theTYPE constants defined in this class.
Parameters:
style - The style of the image to retrieve; may be null. An image appropriate for the given command; nullif the given image style and type cannot be found. |
| getImageDescriptor | | final public ImageDescriptor getImageDescriptor(String commandId, String style)(Code) | | Retrieves the default image associated with the given command in the
given style.
Parameters:
commandId - The identifier to find; must not be null.
Parameters:
style - The style of the image to retrieve; may be null. An image appropriate for the given command; nullif the given image style cannot be found. |
| removeCommandImageManagerListener | | final public void removeCommandImageManagerListener(ICommandImageManagerListener listener)(Code) | | Removes a listener from this command image manager.
Parameters:
listener - The listener to be removed; must not be null. |
|
|