org.hkijena.jipipe.plugins.expressions

Annotation Type JIPipeExpressionParameterSettings

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
public @interface JIPipeExpressionParameterSettings

Controls the behavior of an AbstractExpressionParameter. Attach it to the getter or setter within a JIPipeParameterCollection

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	hint Hint displayed in the UI.
Class<? extends org.fife.ui.rsyntaxtextarea.AbstractTokenMaker>	tokenMaker Allows to set a custom token maker
Class<? extends JIPipeExpressionVariablesInfo>	variableSource Deprecated.
boolean	withoutEditorButton If true, hide the editor button

Element Detail

variableSource

@Deprecated
public abstract Class<? extends JIPipeExpressionVariablesInfo> variableSource

Deprecated.

Allows to give hints to the editor UI which variables are available. The variable source instance has access to the JIPipeParameterAccess.

New: You can use as alternative multiple AddJIPipeExpressionParameterVariable annotations that also support inheritance from the field class and merging of multiple JIPipeExpressionVariablesInfo instances.

Returns:

the variable source class

Default:

org.hkijena.jipipe.plugins.expressions.variables.UndefinedExpressionParameterVariablesInfo.class

hint

public abstract String hint

Hint displayed in the UI. Should explain what the expression does or when it is applied

Returns:

the hint

Default:

""

withoutEditorButton

public abstract boolean withoutEditorButton

If true, hide the editor button

Returns:

if the editor button should be hidden

Default:

false

tokenMaker

public abstract Class<? extends org.fife.ui.rsyntaxtextarea.AbstractTokenMaker> tokenMaker

Allows to set a custom token maker

Returns:

the token maker

Default:

org.hkijena.jipipe.plugins.expressions.JIPipeExpressionEvaluatorSyntaxTokenMaker.class