org.hkijena.jipipe.api.parameters

Annotation Type JIPipeContextAction

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface JIPipeContextAction

An additional action (usually UI action) that is attached to the ParameterPanel. Annotate a method with this annotation to make it accessible to the UI. Use JIPipeDocumentation to add additional information. The method should take a JIPipeWorkbench instance as parameter

JIPipe 1.74.0: Info - If you intend to create examples for your nodes, create a node template, export it into the plugin resources, and register the resource folder as example directory. We do not recommend anymore to utilize context actions as way to distribute examples.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	iconDarkURL The icon resource URL (optional)
String	iconURL The icon resource URL (optional)
Class<?>	resourceClass The class that loads the resource
boolean	showInContextMenu Determines if the context action is shown in the context menu
boolean	showInParameters Determines if the context action is shown as button in the parameters

Element Detail

iconURL

public abstract String iconURL

The icon resource URL (optional)

Returns:

icon resource URL or empty

Default:

""

iconDarkURL

public abstract String iconDarkURL

The icon resource URL (optional)

Returns:

icon resource URL or empty

Default:

""

resourceClass

public abstract Class<?> resourceClass

The class that loads the resource

Returns:

the resource class

Default:

org.hkijena.jipipe.utils.ResourceUtils.class

showInParameters

public abstract boolean showInParameters

Determines if the context action is shown as button in the parameters

Returns:

if the action is shown in the parameters

Default:

true

showInContextMenu

public abstract boolean showInContextMenu

Determines if the context action is shown in the context menu

Returns:

if the action is shown in the context menu

Default:

true