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.

    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Field Detail

      • IMG_OBJS_CUNIT

        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

        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

        static final String IMG_OBJS_JAR
        Key to access the shared image or image descriptor for a JAR archive.
        See Also:
        Constant Field Values
      • IMG_OBJS_JAR_WITH_SOURCE

        static final String IMG_OBJS_JAR_WITH_SOURCE
        Key to access the shared image or image descriptor for a JAR with source.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_EXTERNAL_ARCHIVE

        static final String IMG_OBJS_EXTERNAL_ARCHIVE
        Key to access the shared image or image descriptor for external archives.
        Since:
        2.1
        See Also:
        Constant Field Values
      • IMG_OBJS_EXTERNAL_ARCHIVE_WITH_SOURCE

        static final String IMG_OBJS_EXTERNAL_ARCHIVE_WITH_SOURCE
        Key to access the shared image or image descriptor for external archives with source.
        Since:
        2.1
        See Also:
        Constant Field Values
      • IMG_OBJS_CLASSPATH_VAR_ENTRY

        static final String IMG_OBJS_CLASSPATH_VAR_ENTRY
        Key to access the shared image or image descriptor for a classpath variable entry.
        Since:
        3.2
        See Also:
        Constant Field Values
      • IMG_OBJS_LIBRARY

        static final String IMG_OBJS_LIBRARY
        Key to access the shared image or image descriptor for a library (class path container).
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_PACKFRAG_ROOT

        static final String IMG_OBJS_PACKFRAG_ROOT
        Key to access the shared image or image descriptor for a package fragment root.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_PACKAGE

        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_EMPTY_PACKAGE

        static final String IMG_OBJS_EMPTY_PACKAGE
        Key to access the shared image or image descriptor for an empty package.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_LOGICAL_PACKAGE

        static final String IMG_OBJS_LOGICAL_PACKAGE
        Key to access the shared image or image descriptor for a logical package.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_EMPTY_LOGICAL_PACKAGE

        static final String IMG_OBJS_EMPTY_LOGICAL_PACKAGE
        Key to access the shared image or image descriptor for an empty logical package.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_CLASS

        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_CLASS_DEFAULT

        static final String IMG_OBJS_CLASS_DEFAULT
        Key to access the shared image or image descriptor for a class with default visibility.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_CLASS_PUBLIC

        static final String IMG_OBJS_INNER_CLASS_PUBLIC
        Key to access the shared image or image descriptor for a public inner class.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_CLASS_DEFAULT

        static final String IMG_OBJS_INNER_CLASS_DEFAULT
        Key to access the shared image or image descriptor for a inner class with default visibility.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_CLASS_PROTECTED

        static final String IMG_OBJS_INNER_CLASS_PROTECTED
        Key to access the shared image or image descriptor for a protected inner class.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_CLASS_PRIVATE

        static final String IMG_OBJS_INNER_CLASS_PRIVATE
        Key to access the shared image or image descriptor for a private inner class.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INTERFACE

        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_INTERFACE_DEFAULT

        static final String IMG_OBJS_INTERFACE_DEFAULT
        Key to access the shared image or image descriptor for an interface with default visibility.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_INTERFACE_PUBLIC

        static final String IMG_OBJS_INNER_INTERFACE_PUBLIC
        Key to access the shared image or image descriptor for a public inner interface.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_INTERFACE_DEFAULT

        static final String IMG_OBJS_INNER_INTERFACE_DEFAULT
        Key to access the shared image or image descriptor for an inner interface with default visibility.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_INTERFACE_PROTECTED

        static final String IMG_OBJS_INNER_INTERFACE_PROTECTED
        Key to access the shared image or image descriptor for a protected inner interface.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_INNER_INTERFACE_PRIVATE

        static final String IMG_OBJS_INNER_INTERFACE_PRIVATE
        Key to access the shared image or image descriptor for a private inner interface.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_PACKDECL

        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

        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

        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

        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

        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

        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

        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
      • IMG_FIELD_PUBLIC

        static final String IMG_FIELD_PUBLIC
        Key to access the shared image or image descriptor for a public field.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_FIELD_PROTECTED

        static final String IMG_FIELD_PROTECTED
        Key to access the shared image or image descriptor for a protected field.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_FIELD_PRIVATE

        static final String IMG_FIELD_PRIVATE
        Key to access the shared image or image descriptor for a private field.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_FIELD_DEFAULT

        static final String IMG_FIELD_DEFAULT
        Key to access the shared image or image descriptor for a field with default visibility.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_LOCAL_VARIABLE

        static final String IMG_OBJS_LOCAL_VARIABLE
        Key to access the shared image or image descriptor for a local variable.
        Since:
        3.0
        See Also:
        Constant Field Values
      • IMG_OBJS_ENUM

        static final String IMG_OBJS_ENUM
        Key to access the shared image or image descriptor for a enum type.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ENUM_DEFAULT

        static final String IMG_OBJS_ENUM_DEFAULT
        Key to access the shared image or image descriptor for a enum type with default visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ENUM_PROTECTED

        static final String IMG_OBJS_ENUM_PROTECTED
        Key to access the shared image or image descriptor for a enum type with protected visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ENUM_PRIVATE

        static final String IMG_OBJS_ENUM_PRIVATE
        Key to access the shared image or image descriptor for a enum type with private visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ANNOTATION

        static final String IMG_OBJS_ANNOTATION
        Key to access the shared image or image descriptor for a annotation type.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ANNOTATION_DEFAULT

        static final String IMG_OBJS_ANNOTATION_DEFAULT
        Key to access the shared image or image descriptor for a annotation type with default visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ANNOTATION_PROTECTED

        static final String IMG_OBJS_ANNOTATION_PROTECTED
        Key to access the shared image or image descriptor for a annotation type with protected visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_ANNOTATION_PRIVATE

        static final String IMG_OBJS_ANNOTATION_PRIVATE
        Key to access the shared image or image descriptor for a annotation type with private visibility.
        Since:
        3.1
        See Also:
        Constant Field Values
      • IMG_OBJS_JAVADOCTAG

        static final String IMG_OBJS_JAVADOCTAG
        Key to access the shared image or image descriptor for javadoc tags.
        Since:
        3.2
        See Also:
        Constant Field Values
      • IMG_OBJS_EXTERNAL_ANNOTATIONS

        static final String IMG_OBJS_EXTERNAL_ANNOTATIONS
        Key to access the shared image or image descriptor for external annotations.
        Since:
        3.11
        See Also:
        Constant Field Values
    • Method Detail

      • getImage

        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

        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