org.hkijena.jipipe.api.parameters

Annotation Type JIPipeParameter

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

Annotates a getter or setter function as parameter. JIPipeParameterAccess will look for this annotation to find parameters.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The unique key of this parameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	collapsed Determines if a sub-parameter is collapsed.
boolean	hidden Allows to hide the parameter by default (Can be overridden within the parameter collection= )
String	iconDarkURL The icon resource URL (optional).
String	iconURL The icon resource URL (optional).
boolean	important Marks the parameter as important, which will add an icon to the parameter UI
JIPipeParameterPersistence	persistence Controls how the parameter is serialized/deserialized
boolean	pinned Marks the parameter as pinned.
double	priority Sets the priority for (de)serializing this parameter.
Class<?>	resourceClass The class that loads the resource for iconURL
String	shortKey A short key used for generating parameter strings.
int	uiOrder Controls how the parameter is ordered within the user interface

Element Detail

value

public abstract String value

The unique key of this parameter

Returns:

Parameter key

priority

public abstract double priority

Sets the priority for (de)serializing this parameter. Please use the priority constants provided by Priority

Returns:

the priority

Default:

0.0

shortKey

public abstract String shortKey

A short key used for generating parameter strings. Defaults to value() in JIPipeParameterAccess implementations if not provided

Returns:

A short key used for generating parameter strings

Default:

""

uiOrder

public abstract int uiOrder

Controls how the parameter is ordered within the user interface

Returns:

a low number indicates that this parameter is put first, while a high number indicates that this parameter is put last

Default:

0

persistence

public abstract JIPipeParameterPersistence persistence

Controls how the parameter is serialized/deserialized

Returns:

the serialization behavior

Default:

org.hkijena.jipipe.api.parameters.JIPipeParameterPersistence.Collection

collapsed

public abstract boolean collapsed

Determines if a sub-parameter is collapsed.

Returns:

if a sub-parameter is collapsed

Default:

false

hidden

public abstract boolean hidden

Allows to hide the parameter by default (Can be overridden within the parameter collection= )

Returns:

if the parameter or sub-parameter is hidden by default

Default:

false

iconURL

public abstract String iconURL

The icon resource URL (optional). Only used if this a is sub-parameter

Returns:

icon resource URL or empty

Default:

""

iconDarkURL

public abstract String iconDarkURL

The icon resource URL (optional). Only used if this a is sub-parameter

Returns:

icon resource URL or empty

Default:

""

resourceClass

public abstract Class<?> resourceClass

The class that loads the resource for iconURL

Returns:

the resource class

Default:

org.hkijena.jipipe.utils.ResourceUtils.class

important

public abstract boolean important

Marks the parameter as important, which will add an icon to the parameter UI

Returns:

if the parameter is important

Default:

false

pinned

public abstract boolean pinned

Marks the parameter as pinned. It will be sorted to the top in the parameter panel and visually separated. Intended mostly for JIPipe-internal node parameters that should be separated from other parameters

Returns:

if the parameter is pinned

Default:

false