org.hkijena.jipipe.desktop.api.data

Interface JIPipeDesktopDataDisplayOperation

All Superinterfaces:

JIPipeLegacyDataOperation

All Known Implementing Classes:

AddROI3DToManagerDataDisplayOperation, AddToROIManagerDataDisplayOperation, CacheAwareOpenResultsTableInJIPipeDataDisplayOperation, CopyPathDataDisplayOperation, DefaultDataDisplayOperation, ImportImageJPathDataDisplayOperation, ImportJIPipeProjectDataDisplayOperation, OpenInImageJ3DViewerDataDisplayOperation, OpenInImageJDataDisplayOperation, OpenInNapariDataDisplayOperation, OpenPathDataDisplayOperation, OpenPlotInJIPipeDataDisplayOperation, OpenResultsTableInImageJDataDisplayOperation, OpenResultsTableInJIPipeTabDataDisplayOperation, ShowTrackSchemeDataDisplayOperation

public interface JIPipeDesktopDataDisplayOperation
extends JIPipeLegacyDataOperation

An operation that is executed on showing existing data located in memory/cache. This acts as additional entry in the cache browser display menu. Must be registered.

Method Summary

Modifier and Type	Method and Description
void	display(JIPipeData data, String displayName, JIPipeDesktopWorkbench desktopWorkbench, JIPipeDataSource source) Shows the data in the UI
default void	display(JIPipeDataTable dataTable, int row, JIPipeDesktopWorkbench desktopWorkbench, boolean saveAsDefault) Applies the operation on a data table
default void	displayDataAnnotation(JIPipeDataTable dataTable, int row, JIPipeDataAnnotation dataAnnotation, JIPipeDesktopWorkbench desktopWorkbench) Applies the operation on a data table
default boolean	isIncludeRowInDisplayName() If true, the information about the row and data annotation is included in the display name

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeLegacyDataOperation

getDescription, getIcon, getId, getName, getOrder

Method Detail

display

void display(JIPipeData data,
             String displayName,
             JIPipeDesktopWorkbench desktopWorkbench,
             JIPipeDataSource source)

Shows the data in the UI

Parameters:

data - the data

displayName - the display name

desktopWorkbench - the workbench that issued the command

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

isIncludeRowInDisplayName

default boolean isIncludeRowInDisplayName()

If true, the information about the row and data annotation is included in the display name

Returns:

if the display name should include the row and data annotation name

display

default void display(JIPipeDataTable dataTable,
                     int row,
                     JIPipeDesktopWorkbench desktopWorkbench,
                     boolean saveAsDefault)

Applies the operation on a data table

Parameters:

dataTable - the data table

row - the model row

desktopWorkbench - the workbench

saveAsDefault - saves the operation as new default

displayDataAnnotation

default void displayDataAnnotation(JIPipeDataTable dataTable,
                                   int row,
                                   JIPipeDataAnnotation dataAnnotation,
                                   JIPipeDesktopWorkbench desktopWorkbench)

Applies the operation on a data table

Parameters:

dataTable - the data table

row - the model row

dataAnnotation - the data annotation to show

desktopWorkbench - the workbench