Package org.knime.core.webui.node.view

Interface NodeView

All Superinterfaces:
DataServiceProvider, UIExtension
All Known Subinterfaces:
NodeTableView
All Known Implementing Classes:
TableNodeView
public interface NodeView extends UIExtension, DataServiceProvider
Represents a view of a node.
Since:
4.5
Author:
Martin Horn, KNIME GmbH, Konstanz, Germany, Marc Bux, KNIME GmbH, Berlin, Germany

  • Method Details

    • validateSettings

      void validateSettings(org.knime.core.node.NodeSettingsRO settings) throws org.knime.core.node.InvalidSettingsException
      Validates the given settings before loading it via loadValidatedSettingsFrom(NodeSettingsRO). This is called as soon as new settings are applied via the node's dialog. Please also see NodeModel.validateViewSettings(org.knime.core.node.NodeSettingsRO) in order to validate view settings at configuration time.
      Parameters:
      settings - settings to validate
      Throws:
      org.knime.core.node.InvalidSettingsException - if the validation failed

    • loadValidatedSettingsFrom

      void loadValidatedSettingsFrom(org.knime.core.node.NodeSettingsRO settings)
      Loads validated settings.
      Parameters:
      settings - settings to load

    • getDefaultPageFormat

      default PageFormat getDefaultPageFormat()
      The default page format is being used to determine the size of the page if it's being displayed together with other pages (aka composite view).
      Returns:
      the page format

    • canBeUsedInReport

      default boolean canBeUsedInReport()
      Whether this node view can be used within a report (if the node view is created to be rendered into a report). If not, a 'not supported' placeholder will be added instead. If a node view can be used in a report, its frontend implementation must actively inform the framework that it's either done rendering or directly supply the content (image, html, ...) to it. This is done via the ReportingService in the knime-ui-extension-service package.
      Returns:
      true if this node view can be used in a report (and exhibits the necessary capabilities); otherwise false