Interface ICommandImageService
- All Superinterfaces:
IDisposable
Provides a look-up facility for images associated with commands.
The type of an image indicates the state of the associated command
within the user interface. The supported types are: TYPE_DEFAULT
(to be used for an enabled command), TYPE_DISABLED
(to be used
for a disabled command) and TYPE_HOVER
(to be used for an
enabled command over which the mouse is hovering).
The style of an image is an arbitrary string used to distinguish between sets of images associated with a command. For example, a command may appear in the menus as the default style. However, in the toolbar, the command is simply the default action for a toolbar drop down item. As such, perhaps a different image style is appropriate. The classic case is the "Run Last Launched" command, which appears in the menu and the toolbar, but with different icons in each location.
We currently support a default image style (none) and an image style of IMAGE_STYLE_TOOLBAR.
- Since:
- 3.4
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The default image style.static final String
The image style used for commands in a toolbar.static final int
The type of image to display in the default case.static final int
The type of image to display if the corresponding command is disabled.static final int
The type of image to display if the mouse is hovering over the command and the command is enabled. -
Method Summary
Modifier and TypeMethodDescriptiongetImageDescriptor
(String commandId) Retrieves the default image associated with the given command in the default style.getImageDescriptor
(String commandId, int type) Retrieves the image of the given type associated with the given command in the default style.getImageDescriptor
(String commandId, int type, String style) Retrieves the image of the given type associated with the given command in the given style.getImageDescriptor
(String commandId, String style) Retrieves the default image associated with the given command in the given style.Methods inherited from interface org.eclipse.ui.services.IDisposable
dispose
-
Field Details
-
TYPE_DEFAULT
static final int TYPE_DEFAULTThe type of image to display in the default case.- See Also:
-
TYPE_DISABLED
static final int TYPE_DISABLEDThe type of image to display if the corresponding command is disabled.- See Also:
-
TYPE_HOVER
static final int TYPE_HOVERThe type of image to display if the mouse is hovering over the command and the command is enabled.- See Also:
-
IMAGE_STYLE_DEFAULT
The default image style. This is provided when no style is requested or when the requested style is unavailable. (Value is null) -
IMAGE_STYLE_TOOLBAR
The image style used for commands in a toolbar. This is useful if you want the icon for the command in the toolbar to be different than the one that is displayed with menu items. (Value is toolbar)- See Also:
-
-
Method Details
-
getImageDescriptor
Retrieves the default image associated with the given command in the default style.- Parameters:
commandId
- The identifier to find; must not benull
.- Returns:
- An image appropriate for the given command; may be
null
.
-
getImageDescriptor
Retrieves the image of the given type associated with the given command in the default style.- Parameters:
commandId
- The identifier to find; must not benull
.type
- The type of image to retrieve. This value must be one of theTYPE
constants defined in this interface.- Returns:
- An image appropriate for the given command;
null
if the given image type cannot be found.
-
getImageDescriptor
Retrieves the image of the given type associated with the given command in the given style.- Parameters:
commandId
- The identifier to find; must not benull
.type
- The type of image to retrieve. This value must be one of theTYPE
constants defined in this interface.style
- The style of the image to retrieve; may benull
.- Returns:
- An image appropriate for the given command;
null
if the given image style and type cannot be found.
-
getImageDescriptor
Retrieves the default image associated with the given command in the given style.- Parameters:
commandId
- The identifier to find; must not benull
.style
- The style of the image to retrieve; may benull
.- Returns:
- An image appropriate for the given command;
null
if the given image style cannot be found.
-