org.hkijena.jipipe.api

Interface JIPipeWorkbench

All Known Subinterfaces:

JIPipeDesktopWorkbench

All Known Implementing Classes:

JIPipeDesktopDummyWorkbench, JIPipeDesktopProjectWorkbench, JIPipeDesktopRunSingleAlgorithmWindow, JIPipeDummyWorkbench

public interface JIPipeWorkbench

Interface shared by all workbench UIs

Method Summary

Modifier and Type	Method and Description
org.scijava.Context	getContext()
JIPipeNotificationInbox	getNotificationInbox() Allows to send notifications on a workbench-level
JIPipeProject	getProject() Returns the current project if this workbench has an associated project
default Path	newTempDirectory() Creates a new temporary directory.
default Path	newTempDirectory(String baseName) Creates a new temporary directory.
default Path	newTemporaryFilePath(String baseName, String suffix) Creates a new temporary file path.
void	sendStatusBarText(String text) Sends a text to the status bar
void	showErrorDialog(String message, String title) Shows an error dialog
void	showMessageDialog(String message, String title) Shows a message dialog

Method Detail

sendStatusBarText

void sendStatusBarText(String text)

Sends a text to the status bar

Parameters:

text - The text

getContext

org.scijava.Context getContext()

Returns:

SciJava context

getNotificationInbox

JIPipeNotificationInbox getNotificationInbox()

Allows to send notifications on a workbench-level

Returns:

the notification inbox

showMessageDialog

void showMessageDialog(String message,
                       String title)

Shows a message dialog

Parameters:

message - the message

title - title of the message

showErrorDialog

void showErrorDialog(String message,
                     String title)

Shows an error dialog

Parameters:

message - the message

title - title of the message

getProject

JIPipeProject getProject()

Returns the current project if this workbench has an associated project

Returns:

the project or null

newTempDirectory

default Path newTempDirectory()

Creates a new temporary directory. Uses the project temporary directory as root if available.

Returns:

the temporary directory

newTempDirectory

default Path newTempDirectory(String baseName)

Creates a new temporary directory. Uses the project temporary directory as root if available.

Parameters:

baseName - the base name

Returns:

the temporary directory

newTemporaryFilePath

default Path newTemporaryFilePath(String baseName,
                                  String suffix)

Creates a new temporary file path. Uses the project temporary directory as root if available.

Parameters:

baseName - the base name

suffix - the suffix (extensions must include the dot)

Returns:

path to a non-existing temporary file