Package adams.gui.flow

Interface FlowWorkerHandler

All Superinterfaces:

CleanUpHandler, StatusMessageHandler

All Known Implementing Classes:

FlowPanel, FlowRunnerPanel

public interface FlowWorkerHandler
extends StatusMessageHandler, CleanUpHandler

Interface for classes that can make use of the FlowWorker worker class.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
void	clearNotification()	Removes the notification.
void	finishedExecution()	Finishes up the execution, setting the worker to null.
Actor	getLastFlow()	Returns the last executed flow (if any).
boolean	getRunGC()	Returns whether the GC gets called after the flow execution.
BaseSplitPane	getSplitPane()	Returns the split pane.
StoragePanel	getStoragePanel()	Returns the panel with the storage items.
VariableManagementPanel	getVariablesPanel()	Returns the panel with the variables.
boolean	isHeadless()	Returns whether the flow gets executed in headless mode.
boolean	isModified()	Returns whether the flow is flagged as modified.
void	setLastFlow(Actor actor)	Sets the flow that was last executed.
void	showNotification(String msg, FlowPanelNotificationArea.NotificationType type)	Displays the notification text.
void	showNotification(JComponent comp, String icon)	Displays the notification component.
void	update()	updates the enabled state etc.

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.core.StatusMessageHandler

showStatus

Method Detail

update

void update()

updates the enabled state etc. of all the GUI elements.

isModified

boolean isModified()

Returns whether the flow is flagged as modified.

Returns:

true if the flow is modified

isHeadless

boolean isHeadless()

Returns whether the flow gets executed in headless mode.

Returns:

true if the flow gets executed in headless mode

getRunGC

boolean getRunGC()

Returns whether the GC gets called after the flow execution.

Returns:

true if to run GC

setLastFlow

void setLastFlow(Actor actor)

Sets the flow that was last executed.

Parameters:

actor - the flow

getLastFlow

Actor getLastFlow()

Returns the last executed flow (if any).

Returns:

the flow, null if not available

finishedExecution

void finishedExecution()

Finishes up the execution, setting the worker to null.

clearNotification

void clearNotification()

Removes the notification.

showNotification

void showNotification(String msg,
                      FlowPanelNotificationArea.NotificationType type)

Displays the notification text.

Parameters:

msg - the text to display

type - the type of notification (info/warning/error)

showNotification

void showNotification(JComponent comp,
                      String icon)

Displays the notification component.

Parameters:

comp - the component to display

icon - the icon to display, null for none

getSplitPane

BaseSplitPane getSplitPane()

Returns the split pane.

Returns:

the split pane

getVariablesPanel

VariableManagementPanel getVariablesPanel()

Returns the panel with the variables.

Returns:

the panel, null if not available

getStoragePanel

StoragePanel getStoragePanel()

Returns the panel with the storage items.

Returns:

the panel, null if not available