Package org.knime.gateway.api.entity

Class PortViewEnt

java.lang.Object

org.knime.gateway.api.entity.NodeUIExtensionEnt<NodePortWrapper>

org.knime.gateway.api.entity.PortViewEnt

public class PortViewEnt
extends NodeUIExtensionEnt<NodePortWrapper>

Port view entity containing the info required by the UI (i.e. frontend) to be able to display a port view.

Author:

Martin Horn, KNIME GmbH, Konstanz, Germany

Constructor Summary

Constructors

Constructor	Description
PortViewEnt(NodePortWrapper wrapper, PortViewManager manager, Supplier<List<String>> initialSelectionSupplier)

Method Summary

Modifier and Type	Method	Description
static PortViewEnt	createPortViewEntAndInitSelectionEventSource(NodePortWrapper npw, PortViewManager manager, BiConsumer<String,Object> eventConsumer)	Helper to create a port with and at the same time initialize the SelectionEventSource while also determining the initial selection.
String	getIFrameStyle()
List<String>	getInitialSelection()
NodeInfoEnt	getNodeInfo()

Methods inherited from class org.knime.gateway.api.entity.NodeUIExtensionEnt

getExtensionType, getInitialData, getNodeId, getProjectId, getResourceInfo, getWorkflowId

Methods inherited from class java.lang.Object

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

Constructor Details

PortViewEnt

public PortViewEnt(NodePortWrapper wrapper,
 PortViewManager manager,
 Supplier<List<String>> initialSelectionSupplier)

Parameters:

wrapper -

manager -

initialSelectionSupplier - supplies the initial selection; can be null if selection is not supported by the port view

Method Details

createPortViewEntAndInitSelectionEventSource

public static PortViewEnt createPortViewEntAndInitSelectionEventSource(NodePortWrapper npw,
 PortViewManager manager,
 BiConsumer<String,Object> eventConsumer)

Helper to create a port with and at the same time initialize the SelectionEventSource while also determining the initial selection. The listeners for the SelectionEventSource on the node are removed on node state change.

Parameters:

npw -

manager -

eventConsumer - consumer of the SelectionEventSource-events

Returns:

a new port view ent instance

getIFrameStyle

public String getIFrameStyle()

Returns:

custom styling of the iframe that displays the port view's page

getNodeInfo

public NodeInfoEnt getNodeInfo()

Returns:

additional info for the node providing the view

getInitialSelection

public List<String> getInitialSelection()

Returns:

the initial selection (e.g. a list of row keys)