org.knime.core.node.defaultnodesettings

Class DialogComponentStringSelection

java.lang.Object

org.knime.core.node.defaultnodesettings.DialogComponent

org.knime.core.node.defaultnodesettings.DialogComponentStringSelection

public final class DialogComponentStringSelection
extends DialogComponent

Provide a standard component for a dialog that allows to select a string from a list of strings.

Author:

Thomas Gabriel, University of Konstanz

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
DialogComponentStringSelection(SettingsModelString stringModel, String label, Collection<String> list) Constructor that puts label and combobox into panel.
DialogComponentStringSelection(SettingsModelString stringModel, String label, Collection<String> list, boolean editable) Constructor that puts label and combobox into panel.
DialogComponentStringSelection(SettingsModelString stringModel, String label, Collection<String> list, boolean editable, FlowVariableModel fvm) Constructor that puts label and combobox into panel.
DialogComponentStringSelection(SettingsModelString stringModel, String label, String... list) Constructor that puts label and combobox into panel.
DialogComponentStringSelection(SettingsModelString stringModel, String label, StringIconOption[] list) Constructor that puts label and combobox into panel.
DialogComponentStringSelection(SettingsModelString stringModel, String label, StringIconOption[] list, FlowVariableModel fvm) Constructor that puts label and combobox into 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<String> newItems, String select) Replaces the list of selectable strings in the component.
void	replaceListItems(StringIconOption[] newItems, String select) Replaces the list of selectable strings 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

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      String... list)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list of items for the combobox

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      Collection<String> list)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list (not empty) of strings (not null) for the combobox

Throws:

NullPointerException - if one of the strings in the list is null

IllegalArgumentException - if the list is empty or null.

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      Collection<String> list,
                                      boolean editable)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list (not empty) of strings (not null) for the combobox

editable - true if the user should be able to add a value to the combo box

Throws:

NullPointerException - if one of the strings in the list is null

IllegalArgumentException - if the list is empty or null.

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      Collection<String> list,
                                      boolean editable,
                                      FlowVariableModel fvm)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list (not empty) of strings (not null) for the combobox

editable - true if the user should be able to add a value to the combo box

fvm - model exposed to choose from available flow variables

Throws:

NullPointerException - if one of the strings in the list is null

IllegalArgumentException - if the list is empty or null.

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      StringIconOption[] list)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list (not empty) of StringIconOptions for the combobox. The text of the selected component is stored in the SettingsModelString.

Throws:

NullPointerException - if one of the strings in the list is null

IllegalArgumentException - if the list is empty or null.

DialogComponentStringSelection

public DialogComponentStringSelection(SettingsModelString stringModel,
                                      String label,
                                      StringIconOption[] list,
                                      FlowVariableModel fvm)

Constructor that puts label and combobox into panel. It expects the user to make a selection, thus, at least one item in the list of selectable items is required. When the settings are applied, the model stores one of the strings of the provided list.

Parameters:

stringModel - the model that stores the value for this component.

label - label for dialog in front of combobox

list - list (not empty) of StringIconOptions for the combobox. The text of the selected component is stored in the SettingsModelString.

fvm - model exposed to choose from available flow variables

Throws:

NullPointerException - if one of the strings in the list is null

IllegalArgumentException - if the list is empty or 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)

setSizeComponents

public void setSizeComponents(int width,
                              int height)

Sets the preferred size of the internal component.

Parameters:

width - The width.

height - The height.

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)

replaceListItems

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

Replaces the list of selectable strings 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 strings 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.

replaceListItems

public void replaceListItems(StringIconOption[] newItems,
                             String select)

Replaces the list of selectable strings 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 StringIconOptions 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.