org.hkijena.jipipe.utils

Class JIPipeResourceManager

java.lang.Object

org.hkijena.jipipe.utils.JIPipeResourceManager

public class JIPipeResourceManager
extends Object

Simplifies the access to resources for extensions

Constructor Summary

Constructors

Constructor and Description
JIPipeResourceManager(Class<?> resourceClass, String basePath) Creates a new resource manager with the following settings: icons 16x16 path: [basePath]/icons icons 32x32 path: [basePath]/icons-32 dark icons 16x16 path: [basePath]/dark/icons dark icons 32x32 path: [basePath]/dark/icons-32 templates path: [basePath]/templates schemas path: [basePath]/schemas
JIPipeResourceManager(Class<?> resourceClass, String basePath, String icons16BasePath, String icons32BasePath, String darkIcons16BasePath, String darkIcons32BasePath, String templateBasePath, String schemaBasePath) Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	exportResourceToFile(String internalResourcePath, Path outputFile) Saves a resource as file
static String	formatBasePath(String path) Applies the appropriate formatting for a base path
String	getBasePath()
String	getDarkIcons16BasePath()
String	getDarkIcons32BasePath()
URL	getIcon16URLFromResources(String iconName) Returns the URL of a 16x16 icon.
ImageIcon	getIcon32FromResources(String iconName) Returns an icon from JIPipe resources
URL	getIcon32URLFromResources(String iconName) Returns the URL of a 32x32 icon.
ImageIcon	getIconFromResources(String iconName) Returns an icon from JIPipe resources
String	getIcons16BasePath()
String	getIcons32BasePath()
URL	getIconURLFromResources(String iconName) Returns the URL of a 16x16 icon.
InputStream	getResourceAsStream(String internalResourcePath) Gets a plugin-internal resource as stream
Class<?>	getResourceClass()
URL	getResourceURL(String internalResourcePath) Gets a plugin-internal resource as URL
String	getSchemaBasePath()
String	getTemplateBasePath()
String	relativeToAbsoluteResourcePath(String internalResourcePath) Converts a relative resource path to an absolute resource path

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JIPipeResourceManager

public JIPipeResourceManager(Class<?> resourceClass,
                             String basePath,
                             String icons16BasePath,
                             String icons32BasePath,
                             String darkIcons16BasePath,
                             String darkIcons32BasePath,
                             String templateBasePath,
                             String schemaBasePath)

Creates a new instance

Parameters:

resourceClass - the class that acts as the base for accessing the resources. Should be in the same package as the extension

basePath - absolute resource path to the resource root e.g. /org/hkijena/jipipe/extensions/myextension (must be consistent with the resource directory)

icons16BasePath - resource path to the 16x16 icons

icons32BasePath - resource path to the 32x32 icons

darkIcons16BasePath - resource path to the dark 16x16 icons (icons themselves are optional; the non-dark versions are automatically utilized if no dark version is available)

darkIcons32BasePath - resource path to the dark 32x32 icons (icons themselves are optional; the non-dark versions are automatically utilized if no dark version is available)

templateBasePath - resource path to the template directory

schemaBasePath - resource path to the schema directory

JIPipeResourceManager

public JIPipeResourceManager(Class<?> resourceClass,
                             String basePath)

Creates a new resource manager with the following settings:

• icons 16x16 path: [basePath]/icons
• icons 32x32 path: [basePath]/icons-32
• dark icons 16x16 path: [basePath]/dark/icons
• dark icons 32x32 path: [basePath]/dark/icons-32
• templates path: [basePath]/templates
• schemas path: [basePath]/schemas

Parameters:

resourceClass - the class that acts as the base for accessing the resources. Should be in the same package as the extension

basePath - absolute resource path to the resource root e.g. /org/hkijena/jipipe/extensions/myextension (must be consistent with the resource directory)

Method Detail

formatBasePath

public static String formatBasePath(String path)

Applies the appropriate formatting for a base path

Parameters:

path - the base path

Returns:

the fixed base path

getResourceClass

public Class<?> getResourceClass()

getIconURLFromResources

public URL getIconURLFromResources(String iconName)

Returns the URL of a 16x16 icon. Adapts to dark theme.

Parameters:

iconName - the icon name

Returns:

the URL or null if the icon does not exists

getIcon16URLFromResources

public URL getIcon16URLFromResources(String iconName)

Returns the URL of a 16x16 icon. Adapts to dark theme.

Parameters:

iconName - the icon name

Returns:

the URL or null if the icon does not exists

getIcon32URLFromResources

public URL getIcon32URLFromResources(String iconName)

Returns the URL of a 32x32 icon. Adapts to dark theme.

Parameters:

iconName - the icon name

Returns:

the URL or null if the icon does not exists

getIconFromResources

public ImageIcon getIconFromResources(String iconName)

Returns an icon from JIPipe resources

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getIcon32FromResources

public ImageIcon getIcon32FromResources(String iconName)

Returns an icon from JIPipe resources

Parameters:

iconName - relative to the icons/ plugin resource

Returns:

the icon instance

getBasePath

public String getBasePath()

getIcons16BasePath

public String getIcons16BasePath()

getIcons32BasePath

public String getIcons32BasePath()

getDarkIcons16BasePath

public String getDarkIcons16BasePath()

getDarkIcons32BasePath

public String getDarkIcons32BasePath()

getTemplateBasePath

public String getTemplateBasePath()

getSchemaBasePath

public String getSchemaBasePath()

relativeToAbsoluteResourcePath

public String relativeToAbsoluteResourcePath(String internalResourcePath)

Converts a relative resource path to an absolute resource path

Parameters:

internalResourcePath - the internal path

Returns:

the absolute resource path

getResourceURL

public URL getResourceURL(String internalResourcePath)

Gets a plugin-internal resource as URL

Parameters:

internalResourcePath - internal path relative to the resource base path

Returns:

resource URL or null if the resource does not exist

getResourceAsStream

public InputStream getResourceAsStream(String internalResourcePath)

Gets a plugin-internal resource as stream

Parameters:

internalResourcePath - internal path relative to the resource base path

Returns:

resource stream or null

exportResourceToFile

public void exportResourceToFile(String internalResourcePath,
                                 Path outputFile)

Saves a resource as file

Parameters:

internalResourcePath - internal path relative to the resource base path

outputFile - the output file