org.knime.core.node.defaultnodesettings
Class DialogComponentFileChooser

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

public class DialogComponentFileChooser
extends DialogComponent

A standard component allowing to choose a location(directory) and/or file name.

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
DialogComponentFileChooser(SettingsModelString stringModel, String historyID, int dialogType, boolean directoryOnly)
          Constructor that creates a file/directory chooser of the given type without a file filter.
DialogComponentFileChooser(SettingsModelString stringModel, String historyID, int dialogType, boolean directoryOnly, String... validExtensions)
          Constructor that creates a file or directory chooser of the given type that filters the files according to the given extensions.
DialogComponentFileChooser(SettingsModelString stringModel, String historyID, int dialogType, String... validExtensions)
          Constructor that creates a file chooser of the given type that filters the files according to the given extensions.
DialogComponentFileChooser(SettingsModelString stringModel, String historyID, String... validExtensions)
          Constructor that creates a file chooser with an JFileChooser.OPEN_DIALOG that filters files according to the given extensions.
 
Method Summary
protected  void checkConfigurabilityBeforeLoad(PortObjectSpec[] specs)
          Will be called before the new values are loaded from the NodeSettings object.
protected  void clearError(JComboBox box)
          Sets the coloring of the specified component back to normal.
 void setBorderTitle(String newTitle)
          Replaces the title displayed in the border that surrounds the editfield and browse button with the specified new title.
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

DialogComponentFileChooser

public DialogComponentFileChooser(SettingsModelString stringModel,
                                  String historyID,
                                  String... validExtensions)
Constructor that creates a file chooser with an JFileChooser.OPEN_DIALOG that filters files according to the given extensions. Also non-existing paths are accepted.

Parameters:
stringModel - the model holding the value
historyID - to identify the file history
validExtensions - only show files with those extensions. An entry in this array may contain the | character between two file extensions that will be shown in one item of the file type combo box. This means that one item allows for more than one file type. Specify extension including the dot ".".

DialogComponentFileChooser

public DialogComponentFileChooser(SettingsModelString stringModel,
                                  String historyID,
                                  int dialogType,
                                  boolean directoryOnly)
Constructor that creates a file/directory chooser of the given type without a file filter. Also non-existing paths are accepted.

Parameters:
stringModel - the model holding the value
dialogType - JFileChooser.OPEN_DIALOG, JFileChooser.SAVE_DIALOG or JFileChooser.CUSTOM_DIALOG
historyID - to identify the file history
directoryOnly - true if only directories should be selectable, otherwise only files can be selected

DialogComponentFileChooser

public DialogComponentFileChooser(SettingsModelString stringModel,
                                  String historyID,
                                  int dialogType,
                                  String... validExtensions)
Constructor that creates a file chooser of the given type that filters the files according to the given extensions. Also non-existing paths are accepted.

Parameters:
stringModel - the model holding the value
historyID - id for the file history
dialogType - JFileChooser.OPEN_DIALOG, JFileChooser.SAVE_DIALOG or JFileChooser.CUSTOM_DIALOG
validExtensions - only show files with those extensions. An entry in this array may contain the | character between two file extensions that will be shown in one item of the file type combo box. This means that one item allows for more than one file type. Specify extension including the dot ".".

DialogComponentFileChooser

public DialogComponentFileChooser(SettingsModelString stringModel,
                                  String historyID,
                                  int dialogType,
                                  boolean directoryOnly,
                                  String... validExtensions)
Constructor that creates a file or directory chooser of the given type that filters the files according to the given extensions. Also non-existing paths are accepted.

Parameters:
stringModel - the model holding the value
historyID - to identify the file history
dialogType - JFileChooser.OPEN_DIALOG, JFileChooser.SAVE_DIALOG or JFileChooser.CUSTOM_DIALOG
directoryOnly - true if only directories should be selectable, otherwise only files can be selected
validExtensions - only show files with those extensions. An entry in this array may contain the | character between two file extensions that will be shown in one item of the file type combo box. This means that one item allows for more than one file type. Specify extension including the dot ".".
Method Detail

clearError

protected void clearError(JComboBox box)
Sets the coloring of the specified component back to normal.

Parameters:
box - the component to clear the error status for.

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)

setBorderTitle

public void setBorderTitle(String newTitle)
Replaces the title displayed in the border that surrounds the editfield and browse button with the specified new title. The default title of the component is "Selected File:" or "Selected Directory:".

Parameters:
newTitle - the new title to display in the border.
Throws:
NullPointerException - if the new title is null.

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.