classpathhelper.eclipse.ui
Interface ISharedImages

All Known Implementing Classes:
UIPlugin.SharedImages

public interface ISharedImages

Shared images owned by this plugin.

Usage

Use the getImage(java.lang.String) or getImageDescriptor(java.lang.String) methods with one of the image constants.

Since:
1.0
Author:
bharris

Field Summary
static java.lang.String BLOCKED_ICON
           
static java.lang.String BLOCKED16X16_ICON
           
static java.lang.String BLOCKEDDIFF_ICON
           
static java.lang.String BLOCKEDDIFF16X16_ICON
           
static java.lang.String DEPENDSON_ICON
           
static java.lang.String IGNORED_ICON
           
static java.lang.String REFEDBY16x16_ICON
           
static java.lang.String UNREFERENCED_ICON
           
static java.lang.String UNRES16X16_ICON
           
static java.lang.String UNRESOLVED_ICON
           
static java.lang.String WONTLOAD_ICON
           
 
Method Summary
 Image getImage(java.lang.String symbolicName)
          Retrieves the specified image from the class path helpers plugin's image registry.
 ImageDescriptor getImageDescriptor(java.lang.String symbolicName)
          Retrieves the image descriptor for specified image from ui plugin's image registry.
 

Field Detail

UNRESOLVED_ICON

public static final java.lang.String UNRESOLVED_ICON
See Also:
Constant Field Values

BLOCKEDDIFF_ICON

public static final java.lang.String BLOCKEDDIFF_ICON
See Also:
Constant Field Values

BLOCKEDDIFF16X16_ICON

public static final java.lang.String BLOCKEDDIFF16X16_ICON
See Also:
Constant Field Values

BLOCKED_ICON

public static final java.lang.String BLOCKED_ICON
See Also:
Constant Field Values

BLOCKED16X16_ICON

public static final java.lang.String BLOCKED16X16_ICON
See Also:
Constant Field Values

UNRES16X16_ICON

public static final java.lang.String UNRES16X16_ICON
See Also:
Constant Field Values

REFEDBY16x16_ICON

public static final java.lang.String REFEDBY16x16_ICON
See Also:
Constant Field Values

DEPENDSON_ICON

public static final java.lang.String DEPENDSON_ICON
See Also:
Constant Field Values

IGNORED_ICON

public static final java.lang.String IGNORED_ICON
See Also:
Constant Field Values

UNREFERENCED_ICON

public static final java.lang.String UNREFERENCED_ICON
See Also:
Constant Field Values

WONTLOAD_ICON

public static final java.lang.String WONTLOAD_ICON
See Also:
Constant Field Values
Method Detail

getImage

public Image getImage(java.lang.String symbolicName)
Retrieves the specified image from the class path helpers plugin's image registry. Note: The returned Image is managed by the plugin; clients must not dispose of the returned image.

Parameters:
symbolicName - the symbolic name of the image; there are constants declared in this interface for build-in images that come with the ui plugin
Returns:
the image, or null if not found
Since:
1.0

getImageDescriptor

public ImageDescriptor getImageDescriptor(java.lang.String symbolicName)
Retrieves the image descriptor for specified image from ui plugin's image registry. Unlike Images, image descriptors themselves do not need to be disposed.

Parameters:
symbolicName - the symbolic name of the image; there are constants declared in this interface for build-in images that come with the ui plugin
Returns:
the image descriptor, or null if not found
Since:
1.0