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

Interface NodeDialog

All Superinterfaces:

UIExtension

All Known Implementing Classes:

DefaultNodeDialog

public interface NodeDialog
extends UIExtension

Represents a dialog of a node.

Since:

4.5

Author:

Martin Horn, KNIME GmbH, Konstanz, Germany

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	NodeDialog.OnApplyNodeModifier	Can be implemented and provided to the NodeDialog upon creation.

Method Summary

Modifier and Type	Method	Description
default boolean	canBeEnlarged()	Indicates whether the dialog (optionally) wants/needs to be displayed in an enlarged display area.
Optional<RpcDataService>	createRpcDataService()
NodeSettingsService	getNodeSettingsService()
default Optional<NodeDialog.OnApplyNodeModifier>	getOnApplyNodeModifier()
Set<SettingsType>	getSettingsTypes()

Methods inherited from interface org.knime.core.webui.UIExtension

getPage

Method Details

getSettingsTypes

Set<SettingsType> getSettingsTypes()

Returns:

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

getNodeSettingsService

NodeSettingsService getNodeSettingsService()

Returns:

a NodeSettingsService-instance

createRpcDataService

Optional<RpcDataService> createRpcDataService()

Returns:

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

canBeEnlarged

default boolean canBeEnlarged()

Indicates whether the dialog (optionally) wants/needs to be displayed in an enlarged display area.

Returns:

if true if it can be enlarged, otherwise false

getOnApplyNodeModifier

default Optional<NodeDialog.OnApplyNodeModifier> getOnApplyNodeModifier()

Returns:

see NodeDialog.OnApplyNodeModifier