org.eclipse.jdt.ui
Interface ISharedImages

public interface ISharedImages

Standard images provided by the Java UI plug-in. This class offers access to the standard images in two forms:

• Use ISharedImages.getImage(IMG_OBJS_FOO) to access the shared standard Image object (caller must not dispose of image).
• Use ISharedImages.getImageDescriptor(IMG_OBJS_FOO) to access the standard ImageDescriptor object (caller is responsible for disposing of any Image objects it creates using this descriptor).

This interface is not intended to be implemented by clients.

Field Summary

static String	IMG_OBJS_CFILE Key to access the shared image or image descriptor for a Java class file.
static String	IMG_OBJS_CLASS Key to access the shared image or image descriptor for a class.
static String	IMG_OBJS_CUNIT Key to access the shared image or image descriptor for a Java compilation unit.
static String	IMG_OBJS_DEFAULT Key to access the shared image or image descriptor for class members with default visibility.
static String	IMG_OBJS_IMPCONT Key to access the shared image or image descriptor for an import container.
static String	IMG_OBJS_IMPDECL Key to access the shared image or image descriptor for an import statement.
static String	IMG_OBJS_INTERFACE Key to access the shared image or image descriptor for an interface.
static String	IMG_OBJS_JAR Key to access the shared image or image descriptor for a JAR.
static String	IMG_OBJS_PACKAGE Key to access the shared image or image descriptor for a package.
static String	IMG_OBJS_PACKDECL Key to access the shared image or image descriptor for a package declaration.
static String	IMG_OBJS_PRIVATE Key to access the shared image or image descriptor for a private member.
static String	IMG_OBJS_PROTECTED Key to access the shared image or image descriptor for a protected member.
static String	IMG_OBJS_PUBLIC Key to access the shared image or image descriptor for a public member.

Method Summary

Image	getImage(String key) Returns the shared image managed under the given key.
ImageDescriptor	getImageDescriptor(String key) Returns the image descriptor managed under the given key.

Field Detail

IMG_OBJS_CUNIT

public static final String IMG_OBJS_CUNIT

Key to access the shared image or image descriptor for a Java compilation unit.

See Also:

Constant Field Values

IMG_OBJS_CFILE

public static final String IMG_OBJS_CFILE

Key to access the shared image or image descriptor for a Java class file.

See Also:

Constant Field Values

IMG_OBJS_JAR

public static final String IMG_OBJS_JAR

Key to access the shared image or image descriptor for a JAR.

See Also:

Constant Field Values

IMG_OBJS_PACKAGE

public static final String IMG_OBJS_PACKAGE

Key to access the shared image or image descriptor for a package.

See Also:

Constant Field Values

IMG_OBJS_CLASS

public static final String IMG_OBJS_CLASS

Key to access the shared image or image descriptor for a class.

See Also:

Constant Field Values

IMG_OBJS_INTERFACE

public static final String IMG_OBJS_INTERFACE

Key to access the shared image or image descriptor for an interface.

See Also:

Constant Field Values

IMG_OBJS_PACKDECL

public static final String IMG_OBJS_PACKDECL

Key to access the shared image or image descriptor for a package declaration.

See Also:

Constant Field Values

IMG_OBJS_IMPCONT

public static final String IMG_OBJS_IMPCONT

Key to access the shared image or image descriptor for an import container.

See Also:

Constant Field Values

IMG_OBJS_IMPDECL

public static final String IMG_OBJS_IMPDECL

Key to access the shared image or image descriptor for an import statement.

See Also:

Constant Field Values

IMG_OBJS_PUBLIC

public static final String IMG_OBJS_PUBLIC

Key to access the shared image or image descriptor for a public member.

See Also:

Constant Field Values

IMG_OBJS_PROTECTED

public static final String IMG_OBJS_PROTECTED

Key to access the shared image or image descriptor for a protected member.

See Also:

Constant Field Values

IMG_OBJS_PRIVATE

public static final String IMG_OBJS_PRIVATE

Key to access the shared image or image descriptor for a private member.

See Also:

Constant Field Values

IMG_OBJS_DEFAULT

public static final String IMG_OBJS_DEFAULT

Key to access the shared image or image descriptor for class members with default visibility.

See Also:

Constant Field Values

Method Detail

getImage

public Image getImage(String key)

Returns the shared image managed under the given key.

Note that clients must not dispose the image returned by this method.

Parameters:

key - the image key; one of the IMG_OBJS_* constants

Returns:

the shared image managed under the given key, or null if none

getImageDescriptor

public ImageDescriptor getImageDescriptor(String key)

Returns the image descriptor managed under the given key.

Parameters:

key - the image key; one of the IMG_OBJS_* constants

Returns:

the image descriptor managed under the given key, or null if none