org.knime.core.node

Class ExternalApplicationNodeView<T extends NodeModel>

java.lang.Object

org.knime.core.node.AbstractNodeView<T>

org.knime.core.node.ExternalApplicationNodeView<T>

Type Parameters:

T - The node model class.

public abstract class ExternalApplicationNodeView<T extends NodeModel>
extends AbstractNodeView<T>

Node view which opens an external application. Opening, closing and updating the application is task of derived view classes.

Author:

Bernd Wiswedel, University of Konstanz

Field Summary

Fields inherited from class org.knime.core.node.AbstractNodeView

m_nodeContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExternalApplicationNodeView(T model) Creates the view instance but does not open the external application yet.

Method Summary

Modifier and Type	Method and Description
protected void	callCloseView() Called from AbstractNodeView.closeView() to close the view and release all allocated resources.
protected void	callOpenView(String title) Direct(!) subclasses override this method and open the view or frame.
protected void	callOpenView(String title, Rectangle knimeWindowBounds) Direct(!) subclasses override this method and open the view or frame.
void	closeView() To be called by client code when the external view is closed.
protected abstract void	onClose() Close the view.
protected abstract void	onOpen(String title) Open the external application.
protected void	onOpen(String title, Rectangle knimeWindowBounds) Open the external application.

Methods inherited from class org.knime.core.node.AbstractNodeView

callModelChanged, getLogger, getNodeModel, getViewName, modelChanged, openView, updateModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalApplicationNodeView

protected ExternalApplicationNodeView(T model)

Creates the view instance but does not open the external application yet.

Parameters:

model - The node model assigned to the view, must not be null.

Method Detail

callCloseView

protected void callCloseView()

Called from AbstractNodeView.closeView() to close the view and release all allocated resources. The view will not be opened again.

Specified by:

callCloseView in class AbstractNodeView<T extends NodeModel>

Since:

2.8

callOpenView

protected void callOpenView(String title)

Direct(!) subclasses override this method and open the view or frame. This method is called at most once.

Specified by:

callOpenView in class AbstractNodeView<T extends NodeModel>

Parameters:

title - the default title of the view. It should be shown in the view title bar (if at all possible).

callOpenView

protected void callOpenView(String title,
                            Rectangle knimeWindowBounds)

Direct(!) subclasses override this method and open the view or frame. This method is called at most once.

Overrides:

callOpenView in class AbstractNodeView<T extends NodeModel>

Parameters:

title - the default title of the view. It should be shown in the view title bar (if at all possible).

knimeWindowBounds - the window bounds

Since:

2.12

closeView

public final void closeView()

To be called by client code when the external view is closed. This will initiate the usual closing procedure, i.e. unregistering this view from its model and also calling onClose(). Closes the view and disposes all allocated resources. The view is not meant to be opened again. This method is the counterpart to AbstractNodeView.openView(String, Rectangle). (Core) Sub-classes may widen the scope of this method.

Overrides:

closeView in class AbstractNodeView<T extends NodeModel>

onOpen

protected abstract void onOpen(String title)

Open the external application.

Parameters:

title - The desired title of the application, possibly ignored.

onOpen

protected void onOpen(String title,
                      Rectangle knimeWindowBounds)

Open the external application.

Parameters:

title - The desired title of the application, possibly ignored.

knimeWindowBounds - Bounds of the KNIME window, of interest for window alignment.

Since:

2.12

onClose

protected abstract void onClose()

Close the view. This method is called when the node is deleted or closeView() is called. This method should not be used if the external application initiates the close operation. Clients should call closeView() instead.