org.eclipse.ui
Interface ISharedImages

public interface ISharedImages

A registry for common images used by the workbench which may be useful to other plug-ins.

This class provides Image and ImageDescriptors for each named image in the interface. All Image objects provided by this class are managed by this class and must never be disposed by other clients.

This interface is not intended to be implemented by clients.

Field Summary

static String	IMG_DEF_VIEW Identifies the default image used for views.
static String	IMG_OBJ_ELEMENT Identifies an element image.
static String	IMG_OBJ_FILE Identifies a file image.
static String	IMG_OBJ_FOLDER Identifies a folder image.
static String	IMG_OBJ_PROJECT Identifies a project image.
static String	IMG_OBJ_PROJECT_CLOSED Identifies a closed project image.
static String	IMG_OBJS_BKMRK_TSK Identifies the default image used to indicate a bookmark.
static String	IMG_OBJS_ERROR_TSK Identifies the default image used to indicate errors.
static String	IMG_OBJS_INFO_TSK Identifies the default image used to indicate information only.
static String	IMG_OBJS_TASK_TSK Identifies the default image used to indicate a task.
static String	IMG_OBJS_WARN_TSK Identifies the default image used to indicate warnings.
static String	IMG_OPEN_MARKER Identifies the image used for "open marker".

Method Summary

Image	getImage(String symbolicName) Retrieves the specified image from the workbench plugin's image registry.
ImageDescriptor	getImageDescriptor(String symbolicName) Retrieves the image descriptor for specified image from the workbench's image registry.

Field Detail

IMG_OBJ_FILE

public static final String IMG_OBJ_FILE

Identifies a file image.

See Also:

Constant Field Values

IMG_OBJ_FOLDER

public static final String IMG_OBJ_FOLDER

Identifies a folder image.

See Also:

Constant Field Values

IMG_OBJ_PROJECT

public static final String IMG_OBJ_PROJECT

Identifies a project image.

See Also:

Constant Field Values

IMG_OBJ_PROJECT_CLOSED

public static final String IMG_OBJ_PROJECT_CLOSED

Identifies a closed project image.

See Also:

Constant Field Values

IMG_OBJ_ELEMENT

public static final String IMG_OBJ_ELEMENT

Identifies an element image.

See Also:

Constant Field Values

IMG_OPEN_MARKER

public static final String IMG_OPEN_MARKER

Identifies the image used for "open marker".

See Also:

Constant Field Values

IMG_DEF_VIEW

public static final String IMG_DEF_VIEW

Identifies the default image used for views.

See Also:

Constant Field Values

IMG_OBJS_ERROR_TSK

public static final String IMG_OBJS_ERROR_TSK

Identifies the default image used to indicate errors.

See Also:

Constant Field Values

IMG_OBJS_WARN_TSK

public static final String IMG_OBJS_WARN_TSK

Identifies the default image used to indicate warnings.

See Also:

Constant Field Values

IMG_OBJS_INFO_TSK

public static final String IMG_OBJS_INFO_TSK

Identifies the default image used to indicate information only.

See Also:

Constant Field Values

IMG_OBJS_TASK_TSK

public static final String IMG_OBJS_TASK_TSK

Identifies the default image used to indicate a task.

See Also:

Constant Field Values

IMG_OBJS_BKMRK_TSK

public static final String IMG_OBJS_BKMRK_TSK

Identifies the default image used to indicate a bookmark.

See Also:

Constant Field Values

Method Detail

getImage

public Image getImage(String symbolicName)

Retrieves the specified image from the workbench plugin's image registry. Note: The returned Image is managed by the workbench; clients must not dispose of the returned image.

Parameters:

symbolicName - the symbolic name of the image (constants found in this interface)

Returns:

the image, or null if not found

getImageDescriptor

public ImageDescriptor getImageDescriptor(String symbolicName)

Retrieves the image descriptor for specified image from the workbench's image registry. Unlike Images, image descriptors themselves do not need to be disposed.

Parameters:

symbolicName - the symbolic name of the image (constants found in this interface)

Returns:

the image descriptor, or null if not found