org.hkijena.jipipe.extensions.imagejalgorithms.nodes.forms

Class ROIDrawerFormData

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.extensions.forms.datatypes.FormData

org.hkijena.jipipe.extensions.imagejalgorithms.nodes.forms.ROIDrawerFormData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, JIPipeParameterCollection, JIPipeValidatable

public class ROIDrawerFormData
extends FormData

Structural FormData for drawing ROIs

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.extensions.forms.datatypes.FormData

FormData.Serializer, FormData.TabSettings

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
ROIDrawerFormData(List<JIPipeMergingDataBatch> dataBatches, DrawROIAlgorithm drawROIAlgorithm)

Method Summary

Modifier and Type	Method and Description
void	customCopy(FormData source, CustomValidationReportContext context, JIPipeValidationReport report) A custom copy function that copies the contents from source into this form.
void	customReset() A custom reset method
void	display(String displayName, JIPipeWorkbench workbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
Component	getEditor(JIPipeWorkbench workbench) Gets a component that acts as the editor for the form data.
JIPipeImageViewer	getImageViewerPanel()
boolean	isUsingCustomCopy() Determines whether this form data uses a custom copy method for the "Apply to ..." function If false, duplicate() is used If true, customCopy(src) is used
boolean	isUsingCustomReset() Determines whether this form data uses a custom reset method If false, a new copy of the original data is created If true, customReset() is called
void	loadData(JIPipeMergingDataBatch dataBatch) This method is called by the form processor nodes on loading data into this form.
void	reportValidity(JIPipeValidationReportContext context, JIPipeValidationReport report) Generates a validity report
void	writeData(JIPipeMergingDataBatch dataBatch) This method should write any changes into the data batch

Methods inherited from class org.hkijena.jipipe.extensions.forms.datatypes.FormData

exportData, fromJson, getTabSettings, importData, isImmutable, preview

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

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter

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.data.JIPipeData

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, toDetailedString

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

generateValidityReport

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

emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, setParameter

Constructor Detail

ROIDrawerFormData

public ROIDrawerFormData(List<JIPipeMergingDataBatch> dataBatches,
                         DrawROIAlgorithm drawROIAlgorithm)

Method Detail

getImageViewerPanel

public JIPipeImageViewer getImageViewerPanel()

isUsingCustomCopy

public boolean isUsingCustomCopy()

Description copied from class: FormData

Determines whether this form data uses a custom copy method for the "Apply to ..." function If false, duplicate() is used If true, customCopy(src) is used

Overrides:

isUsingCustomCopy in class FormData

Returns:

if custom copy is enabled

customCopy

public void customCopy(FormData source,
                       CustomValidationReportContext context,
                       JIPipeValidationReport report)

Description copied from class: FormData

A custom copy function that copies the contents from source into this form. Should never raise exceptions. Use JIPipeValidationReport to report issues.

Overrides:

customCopy in class FormData

Parameters:

source - the source data

context - the context

report - the error report

isUsingCustomReset

public boolean isUsingCustomReset()

Description copied from class: FormData

Determines whether this form data uses a custom reset method If false, a new copy of the original data is created If true, customReset() is called

Overrides:

isUsingCustomReset in class FormData

Returns:

if custom reset is enabled

customReset

public void customReset()

Description copied from class: FormData

A custom reset method

Overrides:

customReset in class FormData

reportValidity

public void reportValidity(JIPipeValidationReportContext context,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

report - the report to be added to

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

display

public void display(String displayName,
                    JIPipeWorkbench workbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Parameters:

displayName - a name that can be used

workbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

getEditor

public Component getEditor(JIPipeWorkbench workbench)

Description copied from class: FormData

Gets a component that acts as the editor for the form data. This is presented to the user

Specified by:

getEditor in class FormData

Parameters:

workbench - the workbench

Returns:

the editor

loadData

public void loadData(JIPipeMergingDataBatch dataBatch)

Description copied from class: FormData

This method is called by the form processor nodes on loading data into this form.

Specified by:

loadData in class FormData

Parameters:

dataBatch - the data batch

writeData

public void writeData(JIPipeMergingDataBatch dataBatch)

Description copied from class: FormData

This method should write any changes into the data batch

Specified by:

writeData in class FormData

Parameters:

dataBatch - the data batch