org.knime.core.node.defaultnodesettings

Class DialogComponentFlowVariableNameSelection

java.lang.Object

org.knime.core.node.defaultnodesettings.DialogComponent

org.knime.core.node.defaultnodesettings.DialogComponentFlowVariableNameSelection

public final class DialogComponentFlowVariableNameSelection
extends DialogComponent

Provides a standard component for a dialog that allows to select a flow variable from a list of flow variables.

Since:

2.8

Author:

Kilian Thiel, KNIME.com, Berlin, Germany

Nested Class Summary

Nested classes/interfaces inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

DialogComponent.EmptySettingsModel

Field Summary

Fields inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

DEFAULT_BG, DEFAULT_FG

Constructor Summary

Constructors

Constructor and Description
DialogComponentFlowVariableNameSelection(SettingsModelString model, String label, Collection<FlowVariable> flowVars, boolean hasNone, FlowVariable.Type... flowVarTypes) Constructor creates a label and a combobox and adds them to the component panel.
DialogComponentFlowVariableNameSelection(SettingsModelString model, String label, Collection<FlowVariable> flowVars, FlowVariable.Type... flowVarTypes) Constructor creates a label and a combobox and adds them to the component panel.

Method Summary

Modifier and Type	Method and Description
protected void	checkConfigurabilityBeforeLoad(PortObjectSpec[] specs) Will be called before the new values are loaded from the NodeSettings object.
void	replaceListItems(Collection<FlowVariable> newItems, String select) Replaces the list of selectable flow variables in the component.
protected void	setEnabledComponents(boolean enabled) This method is called by the above (final) DialogComponent.setEnabled(boolean) method.
void	setSizeComponents(int width, int height) Sets the preferred size of the internal component.
void	setToolTipText(String text) Implement this so it sets the tooltip on your component(s).
protected void	updateComponent() Read the value from the SettingsModel and set/display it in the component.
protected void	validateSettingsBeforeSave() Will be called before the value of the component is saved into the NodeSettings object.

Methods inherited from class org.knime.core.node.defaultnodesettings.DialogComponent

clearError, getComponentPanel, getLastTableSpec, getLastTableSpecs, getModel, loadSettingsFrom, saveSettingsTo, setEnabled, showError

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogComponentFlowVariableNameSelection

public DialogComponentFlowVariableNameSelection(SettingsModelString model,
                                                String label,
                                                Collection<FlowVariable> flowVars,
                                                FlowVariable.Type... flowVarTypes)

Constructor creates a label and a combobox and adds them to the component panel. The given flow variables, which are of the specified types are added as items to the combobox. If no types are specified all variables will be added.

Parameters:

model - The string model to store the name of the selected variable.

label - The title of the label to show.

flowVars - The flow variables to add to combobox.

flowVarTypes - The types of flow variables which are added to combobox.

DialogComponentFlowVariableNameSelection

public DialogComponentFlowVariableNameSelection(SettingsModelString model,
                                                String label,
                                                Collection<FlowVariable> flowVars,
                                                boolean hasNone,
                                                FlowVariable.Type... flowVarTypes)

Constructor creates a label and a combobox and adds them to the component panel. The given flow variables, which are of the specified types are added as items to the combobox. If no types are specified all variables will be added.

Parameters:

model - The string model to store the name of the selected variable.

label - The title of the label to show.

flowVars - The flow variables to add to combobox.

hasNone - if true the field is optional and can be set to "NONE"

flowVarTypes - The types of flow variables which are added to combobox.

Throws:

IllegalArgumentException - Collection of FlowVariables cannot be null

Method Detail

updateComponent

protected void updateComponent()

Read the value from the SettingsModel and set/display it in the component. (Called after loading new values in the model to ensure they are transfered into the component.) Implementations should set the new value(s) in the components, should clear any possible error indications, and should also take over the enable state.

Specified by:

updateComponent in class DialogComponent

validateSettingsBeforeSave

protected void validateSettingsBeforeSave()
                                   throws InvalidSettingsException

Will be called before the value of the component is saved into the NodeSettings object. Can be used to commit values, to update the model and must be used to validate the entered value. NOTE: it will be called even if the model is disabled.

Specified by:

validateSettingsBeforeSave in class DialogComponent

Throws:

InvalidSettingsException - if the entered values are invalid

checkConfigurabilityBeforeLoad

protected void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs)
                                       throws NotConfigurableException

Will be called before the new values are loaded from the NodeSettings object. Can be used to avoid loading due to missing, invalid, or inappropriate incoming table specs.
Note: This is called even if the component is disabled. Don't reject specs that might be handled by other components

Specified by:

checkConfigurabilityBeforeLoad in class DialogComponent

Parameters:

specs - the specs from the input ports.

Throws:

NotConfigurableException - if the component can't be used due to inappropriate table specs. (Prevents the dialog from being opened.)

setEnabledComponents

protected void setEnabledComponents(boolean enabled)

This method is called by the above (final) DialogComponent.setEnabled(boolean) method. Derived classes should disable all the contained components in here.

Specified by:

setEnabledComponents in class DialogComponent

Parameters:

enabled - the new status of the component

See Also:

DialogComponent.setEnabled(boolean)

setToolTipText

public void setToolTipText(String text)

Implement this so it sets the tooltip on your component(s).

Specified by:

setToolTipText in class DialogComponent

Parameters:

text - the tool tip text to set.

See Also:

JComponent.setToolTipText(java.lang.String)

setSizeComponents

public void setSizeComponents(int width,
                              int height)

Sets the preferred size of the internal component.

Parameters:

width - The width.

height - The height.

replaceListItems

public void replaceListItems(Collection<FlowVariable> newItems,
                             String select)

Replaces the list of selectable flow variables in the component. If select is specified (not null) and it exists in the collection it will be selected. If select is null, the previous value will stay selected (if it exists in the new list).

Parameters:

newItems - new flow variables for the combo box

select - the item to select after the replace. Can be null, in which case the previous selection remains - if it exists in the new list.

Throws:

IllegalArgumentException - if set of flow variables is null or empty