org.knime.core.node.util
Class FilesHistoryPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.knime.core.node.util.FilesHistoryPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public final class FilesHistoryPanel
extends JPanel

Panel that contains an editable Combo Box showing the file to write to and a button to trigger a file chooser. The elements in the combo are files that have been recently used.

Author:

Bernd Wiswedel, University of Konstanz

See Also:

StringHistory, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

FilesHistoryPanel(FlowVariableModel fvm, String historyID, boolean showErrorMessage, String... suffixes)
Creates new instance, sets properties, for instance renderer, accordingly.

FilesHistoryPanel(String historyID, boolean showErrorMessage)
Creates new instance, sets properties, for instance renderer, accordingly.

FilesHistoryPanel(String historyID, String... suffixes)
Creates new instance, sets properties, for instance renderer, accordingly.

Method Summary

void	addChangeListener(ChangeListener cl) Adds a change listener that gets notified if a new file name is entered into the text field.
static File	getFile(String fileOrUrl) Return a file object for the given fileName.
String	getSelectedFile() Get currently selected file.
String[]	getSuffixes()
void	removeChangeListener(ChangeListener cl) Removes the given change listener from the listener list.
void	setEnabled(boolean enabled)
void	setMarkIfNonexisting(boolean b) Sets if the text field should be colored if the selected file does not exist.
void	setSelectedFile(String url) Set the file url as default.
void	setSelectMode(int mode) Sets the select mode for the file chooser dialog.
void	setSuffixes(String... suffixes) Set file file as part of the suffix.
void	updateHistory() Updates the elements in the combo box, reads the file history.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FilesHistoryPanel

public FilesHistoryPanel(String historyID,
                         String... suffixes)

Creates new instance, sets properties, for instance renderer, accordingly.

Parameters:

historyID - identifier for the string history, see StringHistory

suffixes - the set of suffixes for the file chooser

FilesHistoryPanel

public FilesHistoryPanel(FlowVariableModel fvm,
                         String historyID,
                         boolean showErrorMessage,
                         String... suffixes)

Creates new instance, sets properties, for instance renderer, accordingly.

Parameters:

historyID - identifier for the string history, see StringHistory

suffixes - the set of suffixes for the file chooser

fvm - model to allow to use a variable instead of the text field.

showErrorMessage - if true there are error messages if the file exists or the path is not available and so on.

FilesHistoryPanel

public FilesHistoryPanel(String historyID,
                         boolean showErrorMessage)

Creates new instance, sets properties, for instance renderer, accordingly.

Parameters:

historyID - identifier for the string history, see StringHistory

showErrorMessage - if true there are error messages if the file exists or the path is not available and so on.

Method Detail

setSuffixes

public void setSuffixes(String... suffixes)

Set file file as part of the suffix.

Parameters:

suffixes - The new list of valid suffixes.

getSuffixes

public String[] getSuffixes()

Returns:

the currently set list of file filter suffixes.

getSelectedFile

public String getSelectedFile()

Get currently selected file.

Returns:

the current file url

See Also:

JComboBox.getSelectedItem()

setSelectedFile

public void setSelectedFile(String url)

Set the file url as default.

Parameters:

url - the file to choose

See Also:

JComboBox.setSelectedItem(java.lang.Object)

updateHistory

public void updateHistory()

Updates the elements in the combo box, reads the file history.

addChangeListener

public void addChangeListener(ChangeListener cl)

Adds a change listener that gets notified if a new file name is entered into the text field.

Parameters:

cl - a change listener

removeChangeListener

public void removeChangeListener(ChangeListener cl)

Removes the given change listener from the listener list.

Parameters:

cl - a change listener

setSelectMode

public void setSelectMode(int mode)

Sets the select mode for the file chooser dialog.

Parameters:

mode - one of JFileChooser.FILES_ONLY, JFileChooser.DIRECTORIES_ONLY, or JFileChooser.FILES_AND_DIRECTORIES

See Also:

JFileChooser.setFileSelectionMode(int)

getFile

public static final File getFile(String fileOrUrl)

Return a file object for the given fileName. It makes sure that if the fileName is not absolute it will be relative to the user's home dir.

Parameters:

fileOrUrl - the file name to convert to a file

Returns:

a file representing fileName

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

setMarkIfNonexisting

public void setMarkIfNonexisting(boolean b)

Sets if the text field should be colored if the selected file does not exist.

Parameters:

b - true if the text field should be colored, false otherwise