org.knime.base.node.io.tablecreator
Class TableCreator2NodeDialog

java.lang.Object
  org.knime.core.node.NodeDialogPane
      org.knime.base.node.io.tablecreator.TableCreator2NodeDialog

public final class TableCreator2NodeDialog
extends NodeDialogPane

The dialog class of the Table Creator Node.

Author:

Heiko Hofer

Constructor Summary

TableCreator2NodeDialog()
Create a new instance.

Method Summary

boolean	closeOnESC() Controls the behavior of the dialog when the ESC key is pressed.
protected void	loadSettingsFrom(NodeSettingsRO settings, PortObjectSpec[] specs) Invoked before the dialog window is opened.
protected void	saveSettingsTo(NodeSettingsWO settings) Invoked when the settings need to be applied.

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

addFlowVariablesTab, addJobMgrTab, addTab, addTabAt, createFlowVariableModel, createFlowVariableModel, createFlowVariableModel, finishEditingAndSaveSettingsTo, getAvailableFlowVariables, getCredentialsNames, getCredentialsProvider, getPanel, getTab, getTabIndex, internalLoadSettingsFrom, isWriteProtected, loadSettingsFrom, loadSettingsFrom, onCancel, onClose, onOpen, removeTab, renameTab, saveSettingsTo, setEnabled, setSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

TableCreator2NodeDialog

TableCreator2NodeDialog()

Create a new instance.

Method Detail

closeOnESC

public boolean closeOnESC()

Controls the behavior of the dialog when the ESC key is pressed. By default it allows the dialog to cancel and close. Dialogs that consume the ESC event can overwrite and return false, if the dialog should not be canceled on ESC.

Overrides:

closeOnESC in class NodeDialogPane

Returns:

true, if the dialog should cancel on ESC, false if it should stay open.

loadSettingsFrom

protected void loadSettingsFrom(NodeSettingsRO settings,
                                PortObjectSpec[] specs)

Invoked before the dialog window is opened. The settings object passed, contains the current settings of the corresponding node model. The model and the dialog must agree on a mutual contract on how settings are stored in the spec. I.e. they must able to read each other's settings.

The implementation must be able to handle invalid or incomplete settings as the model may not have any reasonable values yet (for example when the dialog is opened for the first time). When an empty/invalid settings object is passed the dialog should set default values in its components.

Overrides:

loadSettingsFrom in class NodeDialogPane

Parameters:

settings - The settings to load into the dialog. Could be an empty object or contain invalid settings. But will never be null.

specs - The input data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type BufferedDataTable.TYPE and no spec is available the framework will replace null by an empty DataTableSpec (no columns) unless the port is marked as optional.

See Also:

NodeModel.loadSettingsFrom(NodeSettingsRO)

saveSettingsTo

protected void saveSettingsTo(NodeSettingsWO settings)
                       throws InvalidSettingsException

Invoked when the settings need to be applied. The implementation should write the current user settings from its components into the passed object. It should not check consistency or completeness of the settings - this is part of the model's load method. The only situation this method would throw an exception is when a component contains an invalid value that can't be stored in the settings object.
The settings must be written in a way the model is able to load in, i.e. with the model's keys.

Specified by:

saveSettingsTo in class NodeDialogPane

Parameters:

settings - The settings object to write into.

Throws:

InvalidSettingsException

See Also:

NodeModel.loadSettingsFrom(NodeSettingsRO)