org.hkijena.jipipe.desktop.app

Class JIPipeDesktopProjectWorkbench

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.desktop.app.JIPipeDesktopProjectWorkbench

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JIPipeWorkbench, JIPipeProject.CompartmentRemovedEventListener, JIPipeDesktopWorkbench, JIPipeService.PluginRegisteredEventListener

public class JIPipeDesktopProjectWorkbench
extends JPanel
implements JIPipeDesktopWorkbench, JIPipeProject.CompartmentRemovedEventListener, JIPipeService.PluginRegisteredEventListener

UI around an JIPipeProject

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
JIPipeDesktopTabPane	documentTabPane
static String	TAB_COMPARTMENT_EDITOR
static String	TAB_INTRODUCTION
static String	TAB_LICENSE
static String	TAB_LOG
static String	TAB_NOTIFICATIONS
static String	TAB_PLUGIN_VALIDITY_CHECK
static String	TAB_PROJECT_OVERVIEW
static String	TAB_VALIDITY_CHECK

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JIPipeDesktopProjectWorkbench(JIPipeDesktopProjectWindow window, org.scijava.Context context, JIPipeProject project, boolean showIntroduction, boolean isNewProject)

Method Summary

Modifier and Type	Method and Description
static boolean	canAddOrDeleteNodes(JIPipeWorkbench workbench)
static boolean	canModifySlots(JIPipeWorkbench workbench)
List<JIPipeDesktopPipelineGraphEditorUI>	findOpenPipelineEditorTabs(JIPipeProjectCompartment compartment) Finds open JIPipeDesktopPipelineGraphEditorUI tabs
List<JIPipeDesktopPipelineGraphEditorUI>	findOpenPipelineEditorTabs(UUID compartmentUUID) Finds open JIPipeDesktopPipelineGraphEditorUI tabs
JIPipeRunnableQueue	getBackupQueue()
org.scijava.Context	getContext()
JIPipeDesktopTabPane	getDocumentTabPane()
JIPipeNodeDatabase	getNodeDatabase()
JIPipeNotificationInbox	getNotificationInbox() Allows to send notifications on a workbench-level
JIPipeDesktopTabPane.DocumentTab	getOrOpenPipelineEditorTab(JIPipeProjectCompartment compartment, boolean switchToTab) Opens the graph editor for specified compartment
JIPipeProject	getProject() Returns the current project if this workbench has an associated project
JIPipeDesktopProjectWindow	getProjectWindow()
Window	getWindow() Returns the window
boolean	isProjectModified() Method that returns whether the underlying project was modified
void	onJIPipePluginRegistered(JIPipeService.ExtensionRegisteredEvent event)
void	onProjectCompartmentRemoved(JIPipeProject.CompartmentRemovedEvent event) Triggered when a compartment is deleted.
void	openApplicationSettings(String navigateToCategory)
void	openCacheBrowser()
void	openProjectReport()
void	openProjectSettings(String navigateToCategory)
void	restoreCacheFromZIPOrDirectory()
void	restoreStandardTabs(boolean showIntroduction, boolean isNewProject)
void	runCacheIntermediateResults(JIPipeGraphNode algorithm)
void	runUpdateCache(JIPipeGraphNode algorithm)
void	runUpdateCacheLater(JIPipeGraphNode algorithm)
void	runWholeProject()
void	saveProjectAndCache(String title, boolean addAsRecentProject)
void	saveProjectAndCacheToDirectory(String title, boolean addAsRecentProject)
void	saveProjectAndCacheToZIP(String title)
void	sendStatusBarText(String text) Sends a text to the status bar
void	setProjectModified(boolean projectModified) Marks/unmarks the project of this workbench as modified
void	showErrorDialog(String message, String title) Shows an error dialog
void	showMessageDialog(String message, String title) Shows a message dialog
static JIPipeDesktopProjectWorkbench	tryFindProjectWorkbench(JIPipeGraph graph, JIPipeWorkbench orElse) Attempts to find a workbench
void	unload()
void	validatePlugins(boolean avoidSwitching) Validates the plugins
void	validateProject(boolean avoidSwitching) Validates the project

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.JIPipeWorkbench

newTempDirectory, newTempDirectory, newTemporaryFilePath

Field Detail

TAB_INTRODUCTION

public static final String TAB_INTRODUCTION

See Also:

Constant Field Values

TAB_LICENSE

public static final String TAB_LICENSE

See Also:

Constant Field Values

TAB_COMPARTMENT_EDITOR

public static final String TAB_COMPARTMENT_EDITOR

See Also:

Constant Field Values

TAB_VALIDITY_CHECK

public static final String TAB_VALIDITY_CHECK

See Also:

Constant Field Values

TAB_PLUGIN_VALIDITY_CHECK

public static final String TAB_PLUGIN_VALIDITY_CHECK

See Also:

Constant Field Values

TAB_NOTIFICATIONS

public static final String TAB_NOTIFICATIONS

See Also:

Constant Field Values

TAB_PROJECT_OVERVIEW

public static final String TAB_PROJECT_OVERVIEW

See Also:

Constant Field Values

TAB_LOG

public static final String TAB_LOG

See Also:

Constant Field Values

documentTabPane

public JIPipeDesktopTabPane documentTabPane

Constructor Detail

JIPipeDesktopProjectWorkbench

public JIPipeDesktopProjectWorkbench(JIPipeDesktopProjectWindow window,
                                     org.scijava.Context context,
                                     JIPipeProject project,
                                     boolean showIntroduction,
                                     boolean isNewProject)

Parameters:

window - Parent window

context - SciJava context

project - The project

showIntroduction - whether to show the introduction

isNewProject - if the project is an empty project

Method Detail

tryFindProjectWorkbench

public static JIPipeDesktopProjectWorkbench tryFindProjectWorkbench(JIPipeGraph graph,
                                                                    JIPipeWorkbench orElse)

Attempts to find a workbench

Parameters:

graph - the graph

orElse - if no workbench could be found

Returns:

the workbench

canAddOrDeleteNodes

public static boolean canAddOrDeleteNodes(JIPipeWorkbench workbench)

canModifySlots

public static boolean canModifySlots(JIPipeWorkbench workbench)

getNodeDatabase

public JIPipeNodeDatabase getNodeDatabase()

restoreStandardTabs

public void restoreStandardTabs(boolean showIntroduction,
                                boolean isNewProject)

runUpdateCacheLater

public void runUpdateCacheLater(JIPipeGraphNode algorithm)

runCacheIntermediateResults

public void runCacheIntermediateResults(JIPipeGraphNode algorithm)

runUpdateCache

public void runUpdateCache(JIPipeGraphNode algorithm)

findOpenPipelineEditorTabs

public List<JIPipeDesktopPipelineGraphEditorUI> findOpenPipelineEditorTabs(JIPipeProjectCompartment compartment)

Finds open JIPipeDesktopPipelineGraphEditorUI tabs

Parameters:

compartment - Targeted compartment

Returns:

List of UIs

findOpenPipelineEditorTabs

public List<JIPipeDesktopPipelineGraphEditorUI> findOpenPipelineEditorTabs(UUID compartmentUUID)

Finds open JIPipeDesktopPipelineGraphEditorUI tabs

Parameters:

compartmentUUID - Targeted compartment

Returns:

List of UIs

getOrOpenPipelineEditorTab

public JIPipeDesktopTabPane.DocumentTab getOrOpenPipelineEditorTab(JIPipeProjectCompartment compartment,
                                                                   boolean switchToTab)

Opens the graph editor for specified compartment

Parameters:

compartment - The compartment

switchToTab - If true, switch to the tab

Returns:

the tab. its content is a JIPipeDesktopPipelineGraphEditorUI

sendStatusBarText

public void sendStatusBarText(String text)

Sends a text to the status bar

Specified by:

sendStatusBarText in interface JIPipeWorkbench

Parameters:

text - The text

openApplicationSettings

public void openApplicationSettings(String navigateToCategory)

openProjectReport

public void openProjectReport()

saveProjectAndCache

public void saveProjectAndCache(String title,
                                boolean addAsRecentProject)

saveProjectAndCacheToDirectory

public void saveProjectAndCacheToDirectory(String title,
                                           boolean addAsRecentProject)

saveProjectAndCacheToZIP

public void saveProjectAndCacheToZIP(String title)

restoreCacheFromZIPOrDirectory

public void restoreCacheFromZIPOrDirectory()

openCacheBrowser

public void openCacheBrowser()

validateProject

public void validateProject(boolean avoidSwitching)

Validates the project

Parameters:

avoidSwitching - Do not switch to the validity checker tab if the project is OK

validatePlugins

public void validatePlugins(boolean avoidSwitching)

Validates the plugins

Parameters:

avoidSwitching - Do not switch to the validity checker tab if the plugins are OK

runWholeProject

public void runWholeProject()

getDocumentTabPane

public JIPipeDesktopTabPane getDocumentTabPane()

Specified by:

getDocumentTabPane in interface JIPipeDesktopWorkbench

Returns:

The tab pane

getProject

public JIPipeProject getProject()

Description copied from interface: JIPipeWorkbench

Returns the current project if this workbench has an associated project

Specified by:

getProject in interface JIPipeWorkbench

Returns:

The project

getWindow

public Window getWindow()

Description copied from interface: JIPipeDesktopWorkbench

Returns the window

Specified by:

getWindow in interface JIPipeDesktopWorkbench

Returns:

The parent window

getProjectWindow

public JIPipeDesktopProjectWindow getProjectWindow()

getContext

public org.scijava.Context getContext()

Specified by:

getContext in interface JIPipeWorkbench

Returns:

SciJava context

isProjectModified

public boolean isProjectModified()

Description copied from interface: JIPipeDesktopWorkbench

Method that returns whether the underlying project was modified

Specified by:

isProjectModified in interface JIPipeDesktopWorkbench

Returns:

if the project was modified

setProjectModified

public void setProjectModified(boolean projectModified)

Description copied from interface: JIPipeDesktopWorkbench

Marks/unmarks the project of this workbench as modified

Specified by:

setProjectModified in interface JIPipeDesktopWorkbench

Parameters:

projectModified - the status

getNotificationInbox

public JIPipeNotificationInbox getNotificationInbox()

Description copied from interface: JIPipeWorkbench

Allows to send notifications on a workbench-level

Specified by:

getNotificationInbox in interface JIPipeWorkbench

Returns:

the notification inbox

showMessageDialog

public void showMessageDialog(String message,
                              String title)

Description copied from interface: JIPipeWorkbench

Shows a message dialog

Specified by:

showMessageDialog in interface JIPipeWorkbench

Parameters:

message - the message

title - title of the message

showErrorDialog

public void showErrorDialog(String message,
                            String title)

Description copied from interface: JIPipeWorkbench

Shows an error dialog

Specified by:

showErrorDialog in interface JIPipeWorkbench

Parameters:

message - the message

title - title of the message

unload

public void unload()

onProjectCompartmentRemoved

public void onProjectCompartmentRemoved(JIPipeProject.CompartmentRemovedEvent event)

Triggered when a compartment is deleted. Closes corresponding tabs.

Specified by:

onProjectCompartmentRemoved in interface JIPipeProject.CompartmentRemovedEventListener

Parameters:

event - Generated event

onJIPipePluginRegistered

public void onJIPipePluginRegistered(JIPipeService.ExtensionRegisteredEvent event)

Specified by:

onJIPipePluginRegistered in interface JIPipeService.PluginRegisteredEventListener

getBackupQueue

public JIPipeRunnableQueue getBackupQueue()

openProjectSettings

public void openProjectSettings(String navigateToCategory)