org.hkijena.jipipe.plugins.core.data

Class DefaultDataDisplayOperation

java.lang.Object

org.hkijena.jipipe.plugins.core.data.DefaultDataDisplayOperation

All Implemented Interfaces:

JIPipeLegacyDataOperation, JIPipeDesktopDataDisplayOperation

public class DefaultDataDisplayOperation
extends Object
implements JIPipeDesktopDataDisplayOperation

Constructor Summary

Constructors

Constructor and Description
DefaultDataDisplayOperation()

Method Summary

Modifier and Type	Method and Description
void	display(JIPipeData data, String displayName, JIPipeDesktopWorkbench desktopWorkbench, JIPipeDataSource source) Shows the data in the UI
String	getDescription()
Icon	getIcon()
String	getId()
String	getName()
int	getOrder()
boolean	isIncludeRowInDisplayName() If true, the information about the row and data annotation is included in the display name

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.desktop.api.data.JIPipeDesktopDataDisplayOperation

display, displayDataAnnotation

Constructor Detail

DefaultDataDisplayOperation

public DefaultDataDisplayOperation()

Method Detail

display

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

Description copied from interface: JIPipeDesktopDataDisplayOperation

Shows the data in the UI

Specified by:

display in interface JIPipeDesktopDataDisplayOperation

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

public boolean isIncludeRowInDisplayName()

Description copied from interface: JIPipeDesktopDataDisplayOperation

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

Specified by:

isIncludeRowInDisplayName in interface JIPipeDesktopDataDisplayOperation

Returns:

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

getId

public String getId()

Specified by:

getId in interface JIPipeLegacyDataOperation

Returns:

Unique ID of this operation

getName

public String getName()

Specified by:

getName in interface JIPipeLegacyDataOperation

Returns:

The name of this operation

getDescription

public String getDescription()

Specified by:

getDescription in interface JIPipeLegacyDataOperation

Returns:

a description of the operation

getOrder

public int getOrder()

Specified by:

getOrder in interface JIPipeLegacyDataOperation

Returns:

the order in menu. lower values are sorted to the top. The first one is used as default if the user did not select one.

getIcon

public Icon getIcon()

Specified by:

getIcon in interface JIPipeLegacyDataOperation

Returns:

optional icon for the operation. can be null