org.knime.core.node.util.dialog

Class OutFieldsTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.knime.core.node.util.ConfigTablePanel

org.knime.core.node.util.dialog.OutFieldsTable

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class OutFieldsTable
extends ConfigTablePanel

The table where fields for output columns and flow variables can be defined.

This class might change and is not meant as public API.

Since:

3.3

Author:

Christian Albrecht, KNIME.com GmbH, Konstanz, Germany, Heiko Hofer

See Also:

Serialized Form

No public API: not to be instantiated by clients

This class is not intended to be instantiated by clients.

No public API: not to be extended by clients

This class is not intended to be subclassed by clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	OutFieldsTable.BooleanRenderer Renders a boolean as a checkbox.
(package private) static class	OutFieldsTable.DataTypeTableCellEditor A cell editor to define the type of the output column or flow variable.
(package private) static class	OutFieldsTable.DefaultFieldTableCellRenderer Renders the table cells defining the default value fields.
(package private) static class	OutFieldsTable.InputTableCellEditor A cell editor to define the name of the output column or flow variable.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_FIELD_ADDED Property fired when a row is manually added by the user.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
OutFieldsTable(boolean flowVarsOnly, boolean defineDefaultValues) Create a new component.

Method Summary

Modifier and Type	Method and Description
boolean	addRow(DataColumnSpec colSpec) Adds a row using the give colSpec as a hint for the new row.
boolean	addRow(FlowVariable var) Adds a row using the given flow variable as a hint.
boolean	addRow(OutColumnField outCol) Adds a row using the values of the given output column.
boolean	addRow(OutFlowVariableField outVar) Adds a row using the values of the given output variable.
boolean	addRow(String name, FlowVariable.Type type) Adds a row using the give values as a hint.
protected ActionListener	createAddButtonListener() Create action listener reaction on the Add-Button.
protected TableCellEditor	createFieldTypeCellEditor() Create cell editor for for the input columns / flow variables.
OutFieldsTableModel.FieldType	getFieldType(int row) Returns the field type for the given column.
FieldList.OutColumnList	getOutColFields() Get the field definitions representing output columns.
FieldList.OutFlowVariableList	getOutVarFields() Get the field definitions representing output flow variables.
boolean	getReplaceExisting(int row) True when the given row represents a output that replaces an existing input.
String	getTargetFieldName(int row) Returns a name under which the output column or flow variable can be accessed or defined in the target script
void	updateData(FieldCollection fields, DataTableSpec spec, Map<String,FlowVariable> flowVars) Set the table data.

Methods inherited from class org.knime.core.node.util.ConfigTablePanel

commitOpenEditor, getModel, getTable, setEnabled

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FIELD_ADDED

public static final String PROP_FIELD_ADDED

Property fired when a row is manually added by the user.

See Also:

Constant Field Values

Constructor Detail

OutFieldsTable

public OutFieldsTable(boolean flowVarsOnly,
                      boolean defineDefaultValues)

Create a new component. The flowVarsOnly allow to switch between a table where columns and flow variables can be defined and where flow variables can be defined, only.

Parameters:

flowVarsOnly - true when only flow variables and no columns can be defined.

defineDefaultValues - true, when default values are supposed to be given

Method Detail

createAddButtonListener

protected ActionListener createAddButtonListener()

Create action listener reaction on the Add-Button. Default is to add an empty row.

Overrides:

createAddButtonListener in class ConfigTablePanel

Returns:

the action listener for the Add-Button

getTargetFieldName

public String getTargetFieldName(int row)

Returns a name under which the output column or flow variable can be accessed or defined in the target script

Parameters:

row - the row to check

Returns:

the target name

getReplaceExisting

public boolean getReplaceExisting(int row)

True when the given row represents a output that replaces an existing input.

Parameters:

row - the row to check

Returns:

true when the replace flag is set on the given row

getFieldType

public OutFieldsTableModel.FieldType getFieldType(int row)

Returns the field type for the given column.

Parameters:

row - the row to check

Returns:

the field type of the given column

addRow

public boolean addRow(DataColumnSpec colSpec)

Adds a row using the give colSpec as a hint for the new row.

Parameters:

colSpec - the input column

Returns:

true when the row was added successfully

addRow

public boolean addRow(FlowVariable var)

Adds a row using the given flow variable as a hint.

Parameters:

var - the flow variable definition

Returns:

true when the row was added successfully

addRow

public boolean addRow(String name,
                      FlowVariable.Type type)

Adds a row using the give values as a hint.

Parameters:

name - the knime name

type - the Type

Returns:

true when the row was added successfully

addRow

public boolean addRow(OutColumnField outCol)

Adds a row using the values of the given output column.

Parameters:

outCol - the output column definition

Returns:

true when the row was added successfully

addRow

public boolean addRow(OutFlowVariableField outVar)

Adds a row using the values of the given output variable.

Parameters:

outVar - the output variable definition

Returns:

true when the row was added successfully

updateData

public void updateData(FieldCollection fields,
                       DataTableSpec spec,
                       Map<String,FlowVariable> flowVars)

Set the table data.

Parameters:

fields - the fields

spec - the input spec

flowVars - the flow variables

getOutColFields

public FieldList.OutColumnList getOutColFields()

Get the field definitions representing output columns.

Returns:

fields representing output columns.

getOutVarFields

public FieldList.OutFlowVariableList getOutVarFields()

Get the field definitions representing output flow variables.

Returns:

fields representing output flow variables

createFieldTypeCellEditor

protected TableCellEditor createFieldTypeCellEditor()

Create cell editor for for the input columns / flow variables.

Returns:

an editor for the type field