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

package org.knime.core.webui.node.dialog

The dialog of a node is an UI extension that allows a user to change node settings. It translates between different states of the lifecycle of settings.

1. Loading: NodeSettingsRO → Node settings
2. Sending to the frontend: Node settings → Text
3. Applying data from the frontend: Text → Node settings
4. Saving data: Node settings → NodeSettingsRO
Hereby the Node settings are combined of classes for Model- and View-Settings of the node.

Persistence

By which rules the NodeSettings should be loaded and saved is specified by certain persistors associated to them (see org.knime.core.webui.node.dialog.defaultdialog.persistence)

Default Implementation: JsonForms

The default implementation of the above specifications is using JsonForms as text medium (see org.knime.core.webui.node.defaultdialog.jsonforms)

Related Packages

Package	Description
org.knime.core.webui.node
org.knime.core.webui.node.dialog.defaultdialog	This package offers a default implementation of a Node Dialog as described in org.knime.core.webui.node.dialog.
org.knime.core.webui.node.dialog.internal
org.knime.core.webui.node.impl	This package offers an factory for simple WebUI nodes making use of DefaultNodeSettings.
org.knime.core.webui.node.port
org.knime.core.webui.node.util
org.knime.core.webui.node.view

Class	Description
NodeAndVariableSettingsRO	Represents NodeSettingsRO and VariableSettingsRO.
NodeAndVariableSettingsWO	Represents NodeSettingsWO and VariableSettingsWO.
NodeDialog	Represents a dialog of a node.
NodeDialog.OnApplyNodeModifier	Can be implemented and provided to the NodeDialog upon creation.
NodeDialogFactory	Implemented by NodeFactorys to register a node dialog.
NodeDialogManager	Manages (web-ui) node dialog instances and provides associated functionality.
NodeSettingsService	Functionality around NodeSettings as required by the NodeDialog.
SettingsType	A settings type (usually associated with NodeSettings instances) denotes whether certain settings are going to be loaded into a NodeModel or a NodeView.
SubNodeContainerDialogFactory	The SubNodeContainerDialogFactory creates a NodeDialog for all the configuration nodes inside a SubNodeContainer by parsing the DialogNodeRepresentations of those nodes and converting those to jsonforms which is parsed by the NodeDialog page.
VariableSettingsRO	Gives access to the variable settings tree.
VariableSettingsWO	Write-only settings for using and exposing other settings via flow variables.