Package org.knime.core.node.defaultnodesettings

Contains default dialog components, which can be used to quickly create a simple dialog.

See:
          Description

Interface Summary
SettingsModelFlowVariableCompatible Interface for a @link SettingsModel which can be represented by a FlowVariable.
 

Class Summary
DefaultNodeSettingsPane Default implementation for a NodeDialogPane that allows to add standard DialogComponents which will be displayed in a standard way and automatically stored and retrieved in the node settings objects.
DialogComponent Abstract implementation of a component handling a standard type in a NodeDialog.
DialogComponent.EmptySettingsModel ------------------------------------------------------------------------- Components deriving from DialogComponent can use this model if they don't need or want to store any value (but are only displaying stuff).
DialogComponentBoolean Provides a standard component for a dialog that allows to edit a boolean value.
DialogComponentButton Provides a component containing a button.
DialogComponentButtonGroup A standard component to display radio buttons.
DialogComponentButtonLabel Provides a component containing a button and a label.
DialogComponentColumnFilter Provides a component for column filtering.
DialogComponentColumnNameSelection Provides a standard component for a dialog that allows to select a column in a given DataTableSpec.
DialogComponentDoubleRange Allows the user to enter a floating point number range.
DialogComponentFileChooser A standard component allowing to choose a location(directory) and/or file name.
DialogComponentLabel Provides a component containing a label.
DialogComponentMultiLineString  
DialogComponentNumber Provide a standard component for a dialog that allows to edit number value.
DialogComponentNumberEdit Provides a standard component for a dialog that allows to edit a number value.
DialogComponentPasswordField Provide a standard component for a dialog that allows to edit a text field.
DialogComponentString Provide a standard component for a dialog that allows to edit a text field.
DialogComponentStringListSelection Provide a standard component for a dialog that allows to select one or more strings from a list of strings.
DialogComponentStringSelection Provide a standard component for a dialog that allows to select a string from a list of strings.
SettingsModel Abstract implementation of an encapsulating class holding a (usually rather basic) model of NodeModel Settings.
SettingsModelBoolean A settingsmodel for boolean default components.
SettingsModelColumnName Extends the SettingsModelString to provide the SettingsModelColumnName.useRowID() method to check if the RowID should be used instead of a column.
SettingsModelDouble A settingsmodel for double default components.
SettingsModelDoubleBounded A settingsmodel for double default components accepting double between a min and max value.
SettingsModelDoubleRange Settings model for a double range [min, max].
SettingsModelFilterString Implements a settings model that provides include and exclude lists.
SettingsModelInteger  
SettingsModelIntegerBounded A settingsmodel for integer default components accepting double between a min and max value.
SettingsModelLong  
SettingsModelLongBounded  
SettingsModelNumber Used for components accepting numbers (doubles or ints).
SettingsModelOddIntegerBounded A settingsmodel for integer default components accepting double between a min and max value.
SettingsModelString  
SettingsModelStringArray  
 

Package org.knime.core.node.defaultnodesettings Description

Contains default dialog components, which can be used to quickly create a simple dialog. Components are provided for basic types, like string, boolean, integer or double numbers, and also for a list of column names. To create this default dialog, create a node dialog pane derived from DefaultNodeSettingsPane. In the constructor, add instances of the corresponding DialogComponents. Provide a new SettingsModel instance of appropriate type in the constructor call. Also, specify a unique key (string), which you re-use in the NodeModel. In the NodeModel use new instances of SettingsModels (the same type of model used when creating a default component) to retrieve the stored values. Settings models provide load and save methods and methods to get the values.

For a more detailed story (with code examples) about how to create a default dialog, please refer to the DefaultDialogHowto



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.