Class ImageRegistryHelper


  • public class ImageRegistryHelper
    extends Object
    Helper class to load and cache images from the plugin to present them in the UI. The class is used for the administration of the images stored in the Plug-Ins using the workflow engine. This helper class manages an image registry in the background. To use this utility class a plugin should provide the image file and call the static method getTabImage() with it's plugin id and it's relative path to the image (e.g., /icons/filenames_tab.gif).
    • Constructor Detail

      • ImageRegistryHelper

        public ImageRegistryHelper()
    • Method Detail

      • getTabImage

        public static Image getTabImage​(String pluginID,
                                        String imageFilePath)
        Request an image object for a plugin and image file. This method looks up the requested file in the image registry. If it is already available, it will be returned directly. If not, it will be registered first and returned afterwards.
        Parameters:
        pluginID - The id of the plugin containing the image file.
        imageFilePath - The relative path of the image within the plugin.
        Returns:
        The Image file if available.