org.knime.core.node.defaultnodesettings

Class DialogComponentMultiLineString

java.lang.Object

org.knime.core.node.defaultnodesettings.DialogComponent

org.knime.core.node.defaultnodesettings.DialogComponentMultiLineString

public class DialogComponentMultiLineString
extends DialogComponent

Author:

Kilian Thiel, 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
DialogComponentMultiLineString(SettingsModelString stringModel, String label) Constructor put label and JTextArea into panel.
DialogComponentMultiLineString(SettingsModelString stringModel, String label, boolean disallowEmptyString, int cols, int rows) Constructor put label and JTextArea 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.
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

DialogComponentMultiLineString

public DialogComponentMultiLineString(SettingsModelString stringModel,
                                      String label)

Constructor put label and JTextArea into panel. It will accept empty strings as legal input.

Parameters:

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

label - label for dialog in front of JTextArea

DialogComponentMultiLineString

public DialogComponentMultiLineString(SettingsModelString stringModel,
                                      String label,
                                      boolean disallowEmptyString,
                                      int cols,
                                      int rows)

Constructor put label and JTextArea into panel.

Parameters:

label - label for dialog in front of JTextArea

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

disallowEmptyString - if set true, the component request a non-empty string from the user.

cols - the number of columns.

rows - the number of rows.

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)