Package org.knime.core.webui.node.dialog.defaultdialog

Class DefaultNodeDialog

java.lang.Object

org.knime.core.webui.node.dialog.defaultdialog.DefaultNodeDialog

All Implemented Interfaces:

NodeDialog, UIExtension

public final class DefaultNodeDialog
extends Object
implements NodeDialog

Default node dialog implementation where all the dialog widgets are defined through a DefaultNodeSettings-implementation.

Author:

Martin Horn, KNIME GmbH, Konstanz, Germany, Marc Bux, KNIME GmbH, Berlin, Germany

Nested Class Summary

Nested classes/interfaces inherited from interface org.knime.core.webui.node.dialog.NodeDialog

NodeDialog.OnApplyNodeModifier

Field Summary

Fields

Modifier and Type	Field	Description
static final Page	PAGE	The page representing the default node dialog.

Constructor Summary

Constructors

Constructor	Description
DefaultNodeDialog(SettingsType settingsType, Class<? extends DefaultNodeSettings> settingsClass)	Creates a new instance.
DefaultNodeDialog(SettingsType settingsType, Class<? extends DefaultNodeSettings> settingsClass, NodeDialog.OnApplyNodeModifier onApplyModifier)	Creates a new instance.
DefaultNodeDialog(SettingsType settingsType1, Class<? extends DefaultNodeSettings> settingsClass1, SettingsType settingsType2, Class<? extends DefaultNodeSettings> settingsClass2)	Creates a new instance.
DefaultNodeDialog(SettingsType settingsType1, Class<? extends DefaultNodeSettings> settingsClass1, SettingsType settingsType2, Class<? extends DefaultNodeSettings> settingsClass2, NodeDialog.OnApplyNodeModifier onApplyModifier)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Optional<RpcDataService>	createRpcDataService()
NodeSettingsService	getNodeSettingsService()
Optional<NodeDialog.OnApplyNodeModifier>	getOnApplyNodeModifier()
Page	getPage()	Returns the (html) page which represents the UI.
Set<SettingsType>	getSettingsTypes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.knime.core.webui.node.dialog.NodeDialog

canBeEnlarged

Field Details

PAGE

public static final Page PAGE

The page representing the default node dialog.

Constructor Details

DefaultNodeDialog

public DefaultNodeDialog(SettingsType settingsType,
 Class<? extends DefaultNodeSettings> settingsClass)

Creates a new instance.

Parameters:

settingsType - the type of settings this dialog provides

settingsClass - the class which defining the dialog

DefaultNodeDialog

public DefaultNodeDialog(SettingsType settingsType,
 Class<? extends DefaultNodeSettings> settingsClass,
 NodeDialog.OnApplyNodeModifier onApplyModifier)

Creates a new instance.

Parameters:

settingsType - the type of settings this dialog provides

settingsClass - the class which defining the dialog

onApplyModifier - an NodeDialog.OnApplyNodeModifier that will be invoked when cleaning up the ApplyDataService created in NodeDialogAdapter#createApplyDataService()

DefaultNodeDialog

public DefaultNodeDialog(SettingsType settingsType1,
 Class<? extends DefaultNodeSettings> settingsClass1,
 SettingsType settingsType2,
 Class<? extends DefaultNodeSettings> settingsClass2)

Creates a new instance.

Parameters:

settingsType1 - a settings type this dialog is able to provide

settingsClass1 - dialog definition for the first settings type

settingsType2 - another settings type this dialog is able to provide

settingsClass2 - dialog definition for the second settings type

DefaultNodeDialog

public DefaultNodeDialog(SettingsType settingsType1,
 Class<? extends DefaultNodeSettings> settingsClass1,
 SettingsType settingsType2,
 Class<? extends DefaultNodeSettings> settingsClass2,
 NodeDialog.OnApplyNodeModifier onApplyModifier)

Creates a new instance.

Parameters:

settingsType1 - a settings type this dialog is able to provide

settingsClass1 - dialog definition for the first settings type

settingsType2 - another settings type this dialog is able to provide

settingsClass2 - dialog definition for the second settings type

onApplyModifier - an NodeDialog.OnApplyNodeModifier that will be invoked when cleaning up the ApplyDataService created in NodeDialogAdapter#createApplyDataService()

Method Details

getSettingsTypes

public Set<SettingsType> getSettingsTypes()

Specified by:

getSettingsTypes in interface NodeDialog

Returns:

settingsTypes the list of SettingsTypes the NodeSettingsService is able to deal with; must not be empty

getPage

public Page getPage()

Description copied from interface: UIExtension

Returns the (html) page which represents the UI.

Specified by:

getPage in interface UIExtension

Returns:

the page

createRpcDataService

public Optional<RpcDataService> createRpcDataService()

Specified by:

createRpcDataService in interface NodeDialog

Returns:

optional service generally providing data to the node view, port view or node dialog.

getNodeSettingsService

public NodeSettingsService getNodeSettingsService()

Specified by:

getNodeSettingsService in interface NodeDialog

Returns:

a NodeSettingsService-instance

getOnApplyNodeModifier

public Optional<NodeDialog.OnApplyNodeModifier> getOnApplyNodeModifier()

Specified by:

getOnApplyNodeModifier in interface NodeDialog

Returns:

see NodeDialog.OnApplyNodeModifier