public interface JIPipeParameterCollection
Modifier and Type | Method and Description |
---|---|
default void |
deserializeFromJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode)
Deserializes the information from given JSON node
|
default void |
emitParameterChangedEvent(String key)
Triggers a
JIPipeParameterCollection.ParameterChangedEvent on this collection |
default void |
emitParameterStructureChangedEvent()
Triggers a
JIPipeParameterCollection.ParameterStructureChangedEvent on this collection |
default void |
emitParameterUIChangedEvent()
Triggers a
JIPipeParameterCollection.ParameterUIChangedEvent on this collection |
default List<JIPipeParameterCollectionContextAction> |
getContextActions()
List of context actions that are added to this collection.
|
default <T> T |
getParameter(String key,
Class<T> klass)
Gets a parameter
|
default JIPipeParameterAccess |
getParameterAccess(String key)
Gets an access instance to a parameter of the defined key
|
JIPipeParameterCollection.ParameterChangedEventEmitter |
getParameterChangedEventEmitter()
Emitter for changes in the parameter
|
JIPipeParameterCollection.ParameterStructureChangedEventEmitter |
getParameterStructureChangedEventEmitter()
Emitter for changes in the structure of parameters
|
JIPipeParameterCollection.ParameterUIChangedEventEmitter |
getParameterUIChangedEventEmitter()
Emitter for changes in the parameter user interface
|
default JComponent |
installUIOverrideParameterEditor(JIPipeDesktopParameterFormPanel parameterPanel,
JIPipeDesktopParameterEditorUI parameterEditorUI)
Allows to replace the UI that is inserted into the parameter panel with a different component
Labels are not affected
Please note that the root parameter collection handles this task for all sub-parameters
|
default void |
installUIParameterOptions(JIPipeDesktopParameterFormPanel parameterPanel,
JIPipeDesktopParameterEditorUI parameterEditorUI,
JPopupMenu menu)
Allows to install additional operations into the context menu of each parameter (triangle menu next to the help)
Please note that the root parameter collection handles this task for all sub-parameters
|
default boolean |
isParameterUIVisible(JIPipeParameterTree tree,
JIPipeParameterAccess access)
Allows to override the visibility of parameters inside the UI
|
default boolean |
isParameterUIVisible(JIPipeParameterTree tree,
JIPipeParameterCollection subParameter)
Allows to override the visibility of sub-parameters inside the UI
|
default void |
serializeToJsonFile(Path jsonFile)
Serializes this parameter collection to a JSON file
|
default void |
serializeToJsonGenerator(com.fasterxml.jackson.core.JsonGenerator generator)
Serializes this parameter collection into a
JsonGenerator |
default String |
serializeToJsonString()
Serializes this parameter collection to a JSON string
|
default boolean |
setParameter(String key,
Object value)
Sets a parameter and triggers the associated events
|
default boolean isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access)
tree
- the parameter tree that is used to access this parameteraccess
- the parameterdefault boolean isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter)
tree
- the parameter tree that is used to access this parametersubParameter
- a sub parameterdefault void emitParameterStructureChangedEvent()
JIPipeParameterCollection.ParameterStructureChangedEvent
on this collectiondefault void emitParameterUIChangedEvent()
JIPipeParameterCollection.ParameterUIChangedEvent
on this collectiondefault void emitParameterChangedEvent(String key)
JIPipeParameterCollection.ParameterChangedEvent
on this collectionkey
- the parameter keydefault boolean setParameter(String key, Object value)
key
- the parameter keyvalue
- the parameter valuedefault JIPipeParameterAccess getParameterAccess(String key)
key
- the parameter keydefault <T> T getParameter(String key, Class<T> klass)
T
- the parameter classkey
- the parameter keyklass
- the parameter classdefault List<JIPipeParameterCollectionContextAction> getContextActions()
JIPipeContextAction
JIPipeParameterCollection.ParameterChangedEventEmitter getParameterChangedEventEmitter()
JIPipeParameterCollection.ParameterStructureChangedEventEmitter getParameterStructureChangedEventEmitter()
JIPipeParameterCollection.ParameterUIChangedEventEmitter getParameterUIChangedEventEmitter()
default void installUIParameterOptions(JIPipeDesktopParameterFormPanel parameterPanel, JIPipeDesktopParameterEditorUI parameterEditorUI, JPopupMenu menu)
parameterPanel
- the parameter panelparameterEditorUI
- the currently handled parameter editormenu
- the menudefault JComponent installUIOverrideParameterEditor(JIPipeDesktopParameterFormPanel parameterPanel, JIPipeDesktopParameterEditorUI parameterEditorUI)
parameterPanel
- the parameter panelparameterEditorUI
- the currently handled parameter editordefault void serializeToJsonGenerator(com.fasterxml.jackson.core.JsonGenerator generator) throws IOException
JsonGenerator
generator
- the generatorIOException
- thrown by the generatordefault void serializeToJsonFile(Path jsonFile) throws IOException
jsonFile
- the fileIOException
default String serializeToJsonString() throws IOException
IOException
default void deserializeFromJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode)
jsonNode
- JSON nodeCopyright © 2020–2025 Leibniz Institute for Natural Product Research and Infection Biology - Hans Knöll Institute (HKI). All rights reserved.