|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.NodeDialogPane
org.knime.core.node.defaultnodesettings.DefaultNodeSettingsPane
public class DefaultNodeSettingsPane
Default implementation for a NodeDialogPane that allows to add standard DialogComponents which will be displayed in a standard way and automatically stored and retrieved in the node settings objects.
Constructor Summary | |
---|---|
DefaultNodeSettingsPane()
Constructor for DefaultNodeDialogPane. |
Method Summary | |
---|---|
void |
addDialogComponent(DialogComponent diaC)
Add a new DialogComponent to the underlying dialog. |
void |
closeCurrentGroup()
Closes the current group. |
void |
createNewGroup(String title)
Creates a new dialog component group and closes the current one. |
void |
createNewTab(String tabTitle)
Creates a new tab in the dialog. |
void |
createNewTabAt(String tabTitle,
int index)
Creates a new tab in the dialog. |
void |
loadAdditionalSettingsFrom(NodeSettingsRO settings,
DataTableSpec[] specs)
Override hook to load additional settings when all input ports are data ports. |
void |
loadAdditionalSettingsFrom(NodeSettingsRO settings,
PortObjectSpec[] specs)
This method can be overridden to load additional settings. |
void |
loadSettingsFrom(NodeSettingsRO settings,
PortObjectSpec[] specs)
Load settings for all registered components. |
void |
saveAdditionalSettingsTo(NodeSettingsWO settings)
This method can be overridden to save additional settings to the given settings object. |
void |
saveSettingsTo(NodeSettingsWO settings)
Save settings of all registered DialogComponents into the
configuration object. |
void |
selectTab(String tabTitle)
Brings the specified tab to front and shows its components. |
void |
setDefaultTabTitle(String tabTitle)
Sets the title of the default tab that is created and used until you call createNewTab(java.lang.String) . |
void |
setHorizontalPlacement(boolean horizontal)
Changes the orientation the components get placed in the dialog. |
Methods inherited from class org.knime.core.node.NodeDialogPane |
---|
addJobMgrTab, addTab, addTabAt, createFlowVariableModel, createFlowVariableModel, createFlowVariableModel, finishEditingAndSaveSettingsTo, getAvailableFlowVariables, getPanel, getTab, getTabIndex, internalLoadSettingsFrom, 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 |
---|
public DefaultNodeSettingsPane()
Method Detail |
---|
public void setDefaultTabTitle(String tabTitle)
createNewTab(java.lang.String)
.
tabTitle
- the new title of the first tab. Can't be null or empty.
IllegalArgumentException
- if the title is already used by another
tab, or if the specified title is null or empty.public void createNewTabAt(String tabTitle, int index)
tabTitle
- the title of the new tab to use from now on. Can't be
null or empty.index
- the index to place the new tab at. Can't be negative.
IllegalArgumentException
- if you specify a title that is already
been used by another tab. Or if the specified title is null
or empty.setDefaultTabTitle(String)
public void createNewTab(String tabTitle)
tabTitle
- the title of the new tab to use from now on. Can't be
null or empty.
IllegalArgumentException
- if you specify a title that is already
been used by another tab. Or if the specified title is null
or empty.setDefaultTabTitle(String)
public void selectTab(String tabTitle)
tabTitle
- the title of the tab to select. If the specified title
doesn't exist, this method does nothing.public void createNewGroup(String title)
title
- - the title of the new group.public void closeCurrentGroup()
public void addDialogComponent(DialogComponent diaC)
diaC
- component to be addedpublic void setHorizontalPlacement(boolean horizontal)
horizontal
- true
if the next components should be
placed next to each other or false
if the next components
should be placed below each other.public final void loadSettingsFrom(NodeSettingsRO settings, PortObjectSpec[] specs) throws NotConfigurableException
loadSettingsFrom
in class NodeDialogPane
settings
- the NodeSettings
to read fromspecs
- the input specs
NotConfigurableException
- if the node can currently not be
configuredNodeModel.loadSettingsFrom(NodeSettingsRO)
public final void saveSettingsTo(NodeSettingsWO settings) throws InvalidSettingsException
DialogComponents
into the
configuration object.
saveSettingsTo
in class NodeDialogPane
settings
- the NodeSettings
to write into
InvalidSettingsException
- if the user has entered wrong valuesNodeModel.loadSettingsFrom(NodeSettingsRO)
public void loadAdditionalSettingsFrom(NodeSettingsRO settings, PortObjectSpec[] specs) throws NotConfigurableException
loadAdditionalSettingsFrom(NodeSettingsRO, DataTableSpec[])
method, which does the type casting already.
settings
- the NodeSettings
to read fromspecs
- the input specs
NotConfigurableException
- if the node can currently not be
configuredpublic void loadAdditionalSettingsFrom(NodeSettingsRO settings, DataTableSpec[] specs) throws NotConfigurableException
loadAdditionalSettingsFrom(NodeSettingsRO, PortObjectSpec[])
if
all input ports are data ports. All elements in the specs
argument are guaranteed to be non-null.
settings
- The settings of the nodespecs
- The DataTableSpec
of the input tables.
NotConfigurableException
- If not configurablepublic void saveAdditionalSettingsTo(NodeSettingsWO settings) throws InvalidSettingsException
settings
- the NodeSettings
to write into
InvalidSettingsException
- if the user has entered wrong values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |