org.knime.core.node.defaultnodesettings
Class DialogComponentNumber

java.lang.Object
  extended by org.knime.core.node.defaultnodesettings.DialogComponent
      extended by org.knime.core.node.defaultnodesettings.DialogComponentNumber

public class DialogComponentNumber
extends DialogComponent

Provide a standard component for a dialog that allows to edit number value. Provides label and spinner that checks ranges as well as functionality to load/store into config object. The type of the number entered is determined by the SettingsModel passed to the constructor (currently supported are double and int).

Author:
M. Berthold, 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
DialogComponentNumber(SettingsModelNumber numberModel, String label, Number stepSize)
          Constructor puts a label and spinner (with default width) into a panel.
DialogComponentNumber(SettingsModelNumber numberModel, String label, Number stepSize, FlowVariableModel fvm)
          Puts a label and spinner with default width into panel, offers also the registration of a FlowVariableModel.
DialogComponentNumber(SettingsModelNumber numberModel, String label, Number stepSize, int compWidth)
          Constructor puts label and spinner into panel.
DialogComponentNumber(SettingsModelNumber numberModel, String label, Number stepSize, int compWidth, FlowVariableModel fvm)
          Constructor puts label and spinner into panel and allows to specify width (in #characters) of component.
 
Method Summary
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 setToolTipText(String text)
          Implement this so it sets the tooltip on your component(s).
protected  void updateComponent()
          Read the value from the DialogComponent.EmptySettingsModel 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

DialogComponentNumber

public DialogComponentNumber(SettingsModelNumber numberModel,
                             String label,
                             Number stepSize)
Constructor puts a label and spinner (with default width) into a panel.

Parameters:
numberModel - the SettingsModel determining the number type (double or int)
label - label for dialog in front of the spinner
stepSize - step size for the spinner

DialogComponentNumber

public DialogComponentNumber(SettingsModelNumber numberModel,
                             String label,
                             Number stepSize,
                             FlowVariableModel fvm)
Puts a label and spinner with default width into panel, offers also the registration of a FlowVariableModel.

Parameters:
numberModel - the SettingsModel determining the number type (double or int)
label - label for dialog in front of the spinner
stepSize - step size for the spinner
fvm - The variable model (for displaying a little icon next to the component to overwrite the settings with variables). Can be null.

DialogComponentNumber

public DialogComponentNumber(SettingsModelNumber numberModel,
                             String label,
                             Number stepSize,
                             int compWidth)
Constructor puts label and spinner into panel.

Parameters:
numberModel - the SettingsModel determining the number type (double or int)
label - label for dialog in front of the spinner
stepSize - step size for the spinner
compWidth - the width (number of columns/characters) of the spinner

DialogComponentNumber

public DialogComponentNumber(SettingsModelNumber numberModel,
                             String label,
                             Number stepSize,
                             int compWidth,
                             FlowVariableModel fvm)
Constructor puts label and spinner into panel and allows to specify width (in #characters) of component.

Parameters:
numberModel - the SettingsModel determining the number type (double or int)
label - label for dialog in front of the spinner
stepSize - step size for the spinner
compWidth - the width (number of columns/characters) of the spinner
fvm - The variable model (for displaying a little icon next to the component to overwrite the settings with variables). Can be null.
Method Detail

updateComponent

protected void updateComponent()
Read the value from the DialogComponent.EmptySettingsModel 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)


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.