|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.defaultnodesettings.DialogComponent
org.knime.core.node.defaultnodesettings.DialogComponentButtonGroup
public class DialogComponentButtonGroup
A standard component to display radio buttons. The given
SettingsModelString
holds the value of the
getActionCommand()
of the selected
ButtonGroupEnumInterface
.
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 |
---|
public DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, ButtonGroupEnumInterface[] elements)
stringModel
- the model that stores the action command of the
selected radio buttonlabel
- 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
orientationelements
- the buttons of the grouppublic DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String[] buttonLabels, String[] actionCommands)
SettingsModel
holds the action command of the selected
radio button. The default value of the SettingModel
is
selected per default.
stringModel
- the model that stores the action command of the
selected radio buttonlabel
- 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
orientationbuttonLabels
- the labels of the buttonsactionCommands
- the action command of the buttons in the same order
like the labels@Deprecated public DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String[] buttonLabels, String[] actionCommands, String defaultAction)
DialogComponentButtonGroup(SettingsModelString, String, boolean, String[], String[])
instead
SettingsModel
holds the action command of the selected
radio button.
stringModel
- the model that stores the action command of the
selected radio buttonlabel
- 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
orientationbuttonLabels
- the labels of the buttonsactionCommands
- the action command of the buttons in the same order
like the labelsdefaultAction
- the default action which should be selectedpublic DialogComponentButtonGroup(SettingsModelString stringModel, boolean vertical, String label, String... elements)
SettingsModel
holds the selected element. The default
value of the SettingModel
is selected per default.
stringModel
- the model that stores the action command of the
selected radio buttonlabel
- 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
orientationelements
- the labels/action commands of the buttons@Deprecated public DialogComponentButtonGroup(SettingsModelString stringModel, String label, boolean vertical, String defaultElement, String... elements)
#DialogComponentButtonGroup(SettingsModelString, boolean, String,
String...)
instead
SettingsModel
holds the selected element.
stringModel
- the model that stores the action command of the
selected radio buttonlabel
- 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
orientationdefaultElement
- the default element which should be selectedelements
- the labels/action commands of the buttonsMethod Detail |
---|
protected void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs)
checkConfigurabilityBeforeLoad
in class DialogComponent
specs
- the specs from the input ports.protected void setEnabledComponents(boolean enabled)
DialogComponent.setEnabled(boolean)
method. Derived classes should disable all the contained components in
here.
setEnabledComponents
in class DialogComponent
enabled
- the new status of the componentDialogComponent.setEnabled(boolean)
public void setToolTipText(String text)
setToolTipText
in class DialogComponent
text
- the tool tip text to set.JComponent.setToolTipText(java.lang.String)
protected void updateComponent()
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.
updateComponent
in class DialogComponent
protected void validateSettingsBeforeSave()
validateSettingsBeforeSave
in class DialogComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |