org.hkijena.jipipe.plugins.parameters.api.enums

Class EnumParameterGenerator

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.parameters.DefaultJIPipeParameterGenerator

org.hkijena.jipipe.plugins.parameters.api.enums.EnumParameterGenerator

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeParameterGenerator, JIPipeValidatable

public class EnumParameterGenerator
extends DefaultJIPipeParameterGenerator

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
EnumParameterGenerator()

Method Summary

Modifier and Type	Method and Description
<T> List<T>	generate(JIPipeDesktopWorkbench workbench, Component parent, Class<T> klass) Generates the values
<T> List<T>	generateAfterDialog(JIPipeWorkbench workbench, Component parent, Class<T> klass) This function generates the values after the dialog was confirmed
String	getDescription()
DynamicStringSetParameter	getGeneratedValues()
String	getName()
void	setGeneratedValues(DynamicStringSetParameter generatedValues)

Methods inherited from class org.hkijena.jipipe.api.parameters.DefaultJIPipeParameterGenerator

reportValidity

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

EnumParameterGenerator

public EnumParameterGenerator()

Method Detail

generate

public <T> List<T> generate(JIPipeDesktopWorkbench workbench,
                            Component parent,
                            Class<T> klass)

Description copied from interface: JIPipeParameterGenerator

Generates the values

Specified by:

generate in interface JIPipeParameterGenerator

Overrides:

generate in class DefaultJIPipeParameterGenerator

Type Parameters:

T - the generated field type

Parameters:

workbench - the workbench

parent - the parent component for any dialogs

klass - the generated field class

Returns:

the generated values

generateAfterDialog

public <T> List<T> generateAfterDialog(JIPipeWorkbench workbench,
                                       Component parent,
                                       Class<T> klass)

Description copied from class: DefaultJIPipeParameterGenerator

This function generates the values after the dialog was confirmed

Specified by:

generateAfterDialog in class DefaultJIPipeParameterGenerator

Type Parameters:

T - the generated class

parent - the parent

Returns:

the list of generated objects

getGeneratedValues

public DynamicStringSetParameter getGeneratedValues()

setGeneratedValues

public void setGeneratedValues(DynamicStringSetParameter generatedValues)

getName

public String getName()

Returns:

name displayed in the menu

getDescription

public String getDescription()

Returns:

description displayed in the menu