|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Field Summary | |
static String |
IMAGE_STYLE_DEFAULT
The default image style. |
static String |
IMAGE_STYLE_TOOLBAR
The image style used for commands in a toolbar. |
static int |
TYPE_DEFAULT
The type of image to display in the default case. |
static int |
TYPE_DISABLED
The type of image to display if the corresponding command is disabled. |
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 | |
ImageDescriptor |
getImageDescriptor(String commandId)
Retrieves the default image associated with the given command in the default style. |
ImageDescriptor |
getImageDescriptor(String commandId,
int type)
Retrieves the image of the given type associated with the given command in the default style. |
ImageDescriptor |
getImageDescriptor(String commandId,
int type,
String style)
Retrieves the image of the given type associated with the given command in the given style. |
ImageDescriptor |
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 Detail |
public static final int TYPE_DEFAULT
public static final int TYPE_DISABLED
public static final int TYPE_HOVER
public static final String IMAGE_STYLE_DEFAULT
public static final String IMAGE_STYLE_TOOLBAR
Method Detail |
public ImageDescriptor getImageDescriptor(String commandId)
commandId
- The identifier to find; must not be null
.
null
.public ImageDescriptor getImageDescriptor(String commandId, int type)
commandId
- The identifier to find; must not be null
.type
- The type of image to retrieve. This value must be one of the
TYPE
constants defined in this interface.
null
if the given image type cannot be found.public ImageDescriptor getImageDescriptor(String commandId, int type, String style)
commandId
- The identifier to find; must not be null
.type
- The type of image to retrieve. This value must be one of the
TYPE
constants defined in this interface.style
- The style of the image to retrieve; may be null
.
null
if the given image style and type cannot be found.public ImageDescriptor getImageDescriptor(String commandId, String style)
commandId
- The identifier to find; must not be null
.style
- The style of the image to retrieve; may be null
.
null
if the given image style cannot be found.
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.