org.knime.core.node.defaultnodesettings
Class DialogComponentButtonGroup

java.lang.Object
  org.knime.core.node.defaultnodesettings.DialogComponent
      org.knime.core.node.defaultnodesettings.DialogComponentButtonGroup

public class DialogComponentButtonGroup
extends DialogComponent

A standard component to display radio buttons. The given SettingsModelString holds the value of the getActionCommand() of the selected ButtonGroupEnumInterface.

Author:

Tobias Koetter, 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

DialogComponentButtonGroup(SettingsModelString stringModel, boolean vertical, String label, String... elements)
Constructor for class DialogComponentButtonGroup.

DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, ButtonGroupEnumInterface[] elements)
Constructor for class DialogComponentButtonGroup.

DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String[] buttonLabels, String[] actionCommands)
Constructor for class DialogComponentButtonGroup.

DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String[] buttonLabels, String[] actionCommands, String defaultAction)
Deprecated. use DialogComponentButtonGroup(SettingsModelString, String, boolean, String[], String[]) instead

DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String defaultElement, String... elements)
Deprecated. use #DialogComponentButtonGroup(SettingsModelString, boolean, String, String...) instead

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

DialogComponentButtonGroup

public DialogComponentButtonGroup(SettingsModelString stringModel,
                                  String label,
                                  boolean vertical,
                                  ButtonGroupEnumInterface[] elements)

Constructor for class DialogComponentButtonGroup.

Parameters:

stringModel - the model that stores the action command of the selected radio button

label - the optional label of the group. Set to null for none label. Set an empty String for a border.

vertical - set to true to have the box in a vertical orientation

elements - the buttons of the group

DialogComponentButtonGroup

public DialogComponentButtonGroup(SettingsModelString stringModel,
                                  String label,
                                  boolean vertical,
                                  String[] buttonLabels,
                                  String[] actionCommands)

Constructor for class DialogComponentButtonGroup. The SettingsModel holds the action command of the selected radio button. The default value of the SettingModel is selected per default.

Parameters:

stringModel - the model that stores the action command of the selected radio button

label - the optional label of the group. Set to null for none label. Set an empty String for a border.

vertical - set to true to have the box in a vertical orientation

buttonLabels - the labels of the buttons

actionCommands - the action command of the buttons in the same order like the labels

DialogComponentButtonGroup

@Deprecated
public DialogComponentButtonGroup(SettingsModelString stringModel,
                                             String label,
                                             boolean vertical,
                                             String[] buttonLabels,
                                             String[] actionCommands,
                                             String defaultAction)

Deprecated. use DialogComponentButtonGroup(SettingsModelString, String, boolean, String[], String[]) instead

Constructor for class DialogComponentButtonGroup. The SettingsModel holds the action command of the selected radio button.

Parameters:

stringModel - the model that stores the action command of the selected radio button

label - the optional label of the group. Set to null for none label. Set an empty String for a border.

vertical - set to true to have the box in a vertical orientation

buttonLabels - the labels of the buttons

actionCommands - the action command of the buttons in the same order like the labels

defaultAction - the default action which should be selected

DialogComponentButtonGroup

public DialogComponentButtonGroup(SettingsModelString stringModel,
                                  boolean vertical,
                                  String label,
                                  String... elements)

Constructor for class DialogComponentButtonGroup. The given SettingsModel holds the selected element. The default value of the SettingModel is selected per default.

Parameters:

stringModel - the model that stores the action command of the selected radio button

label - the optional label of the group. Set to null for none label. Set an empty String for a border.

vertical - set to true to have the box in a vertical orientation

elements - the labels/action commands of the buttons

DialogComponentButtonGroup

@Deprecated
public DialogComponentButtonGroup(SettingsModelString stringModel,
                                             String label,
                                             boolean vertical,
                                             String defaultElement,
                                             String... elements)

Deprecated. use #DialogComponentButtonGroup(SettingsModelString, boolean, String, String...) instead

Constructor for class DialogComponentButtonGroup. The given SettingsModel holds the selected element.

Parameters:

stringModel - the model that stores the action command of the selected radio button

label - the optional label of the group. Set to null for none label. Set an empty String for a border.

vertical - set to true to have the box in a vertical orientation

defaultElement - the default element which should be selected

elements - the labels/action commands of the buttons

Method Detail

checkConfigurabilityBeforeLoad

protected void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs)

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.

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)

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()

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