|
||||||||||
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.DialogComponentColumnFilter
public class DialogComponentColumnFilter
Provides a component for column filtering. This component for the default dialog allows to enter a list of columns to include from the set of available columns.
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 | |
---|---|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex)
Deprecated. Use the constructor @{link DialogComponentColumnFilter(SettingsModelFilterString, int, boolean)
instead. |
|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex,
boolean showKeepAllBox)
Creates a new filter column panel with three components which are the include list, button panel to shift elements between the two lists, and the exclude list. |
|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex,
boolean showKeepAllBox,
Class<? extends DataValue>... allowedTypes)
Creates a new filter column panel with three component which are the include list, button panel to shift elements between the two lists, and the exclude list. |
|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex,
boolean showKeepAllBox,
ColumnFilter filter)
Creates a new filter column panel with three component which are the include list, button panel to shift elements between the two lists, and the exclude list. |
|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex,
Class<? extends DataValue>... allowedTypes)
Deprecated. Use the constructor DialogComponentColumnFilter(SettingsModelFilterString, int, boolean, Class...)
instead |
|
DialogComponentColumnFilter(SettingsModelFilterString model,
int inPortIndex,
ColumnFilter filter)
Deprecated. Use the constructor DialogComponentColumnFilter(SettingsModelFilterString, int, boolean, ColumnFilter)
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 |
setExcludeTitle(String title)
Sets the title of the exclude panel. |
void |
setIncludeTitle(String title)
Sets the title of the include panel. |
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()
We store the values from the panel in the model now. |
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 |
---|
@Deprecated public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex)
DialogComponentColumnFilter(SettingsModelFilterString, int, boolean)
instead.
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filtered.public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex, boolean showKeepAllBox)
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filteredshowKeepAllBox
- if the keep-all check box should be visible@Deprecated public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex, Class<? extends DataValue>... allowedTypes)
DialogComponentColumnFilter(SettingsModelFilterString, int, boolean, Class...)
instead
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filtered.allowedTypes
- filter for the columns all column not compatible with
any of the allowed types are not displayed.public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex, boolean showKeepAllBox, Class<? extends DataValue>... allowedTypes)
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filteredshowKeepAllBox
- if the keep-all check box should be visibleallowedTypes
- filter for the columns all column not compatible with
any of the allowed types are not displayed@Deprecated public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex, ColumnFilter filter)
DialogComponentColumnFilter(SettingsModelFilterString, int, boolean, ColumnFilter)
instead
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filtered.filter
- for the columns, all column not compatible with
any of the allowed types are not displayed.public DialogComponentColumnFilter(SettingsModelFilterString model, int inPortIndex, boolean showKeepAllBox, ColumnFilter filter)
model
- a string array model that stores the valueinPortIndex
- the index of the port whose table is filteredshowKeepAllBox
- if the keep-all check box should be visiblefilter
- for the columns, all column not compatible with
any of the allowed types are not displayedMethod Detail |
---|
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() throws InvalidSettingsException
validateSettingsBeforeSave
in class DialogComponent
InvalidSettingsException
- if the entered values are invalidprotected void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs) throws NotConfigurableException
checkConfigurabilityBeforeLoad
in class DialogComponent
specs
- the specs from the input ports.
NotConfigurableException
- if the component can't be used due to
inappropriate table specs. (Prevents the dialog from being
opened.)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 setIncludeTitle(String title)
title
- the new titlepublic void setExcludeTitle(String title)
title
- the new titlepublic void setToolTipText(String text)
setToolTipText
in class DialogComponent
text
- the tool tip text to set.JComponent.setToolTipText(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |