Package adams.gui.wizard

Class SelectMultipleFilesPage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.wizard.AbstractWizardPage

adams.gui.wizard.SelectMultipleFilesPage

All Implemented Interfaces:

LoggingSupporter, ImageObserver, MenuContainer, Serializable, Accessible

public class SelectMultipleFilesPage
extends AbstractWizardPage

Wizard page that allows the user to select multiple files. File filters can be defined as well. Stores the selected files as blank-separated list.

Version:

$Revision: 9915 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

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

Modifier and Type	Field	Description
static String	KEY_FILES	key in the properties that contains the file name.
protected BaseButton	m_ButtonAdd	the button for bringing up the filechooser.
protected BaseButton	m_ButtonMoveDown	the button for moving the selected files down.
protected BaseButton	m_ButtonMoveUp	the button for moving the selected files up.
protected BaseButton	m_ButtonRemove	the button for removing the selected files.
protected BaseButton	m_ButtonRemoveAll	the button for removing all files.
protected BaseFileChooser	m_FileChooser	the filechooser for selecting the files.
protected BaseListWithButtons	m_ListFiles	the list for the file names.

Fields inherited from class adams.gui.wizard.AbstractWizardPage

m_ButtonLoad, m_ButtonSave, m_Owner, m_PageCheck, m_PageName, m_PanelButtons, m_ProceedAction, m_ScrollPaneDescription, m_TextDescription, m_Valid

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
SelectMultipleFilesPage()	Default constructor.
SelectMultipleFilesPage(String pageName)	Initializes the page with the given page name.

Method Summary

Modifier and Type	Method	Description
void	addChoosableFileFilter(FileFilter value)	Adds the given file filter to the filechooser.
protected void	finishInit()	finishes the initialization.
boolean	getAutoAppendExtension()	Returns whether to automatically append the currently selected file extension or the default one (if All-Filter is used).
File[]	getCurrent()	Returns the current files.
File	getCurrentDirectory()	Returns the current directory in use by the file chooser.
String	getDefaultExtension()	Returns the default extension.
FileFilter	getFileFilter()	Returns the active file filter.
Properties	getProperties()	Returns the content of the page (ie parameters) as properties.
protected void	initGUI()	Initializes the widets.
protected void	initialize()	Initializes the members.
void	setAutoAppendExtension(boolean value)	Sets whether to automatically append the currently selected file extension or the default one (if All-Filter is used).
void	setCurrent(File[] value)	Sets the current files.
void	setCurrentDirectory(File value)	Sets the current directory to use for the file chooser.
void	setDefaultExtension(String value)	Sets the default extension.
void	setFileFilter(FileFilter value)	Sets the active file filter.
void	setProperties(Properties value)	Sets the content of the page (ie parameters) as properties.
protected void	updateListButtons()	Updates the enabled state of the buttons.

Methods inherited from class adams.gui.wizard.AbstractWizardPage

canProceed, getDescription, getDescriptionHeight, getFileChooser, getLogger, getOwner, getPageCheck, getPageName, getProceedAction, invalidate, isButtonPanelVisible, isLoggingEnabled, isValid, loadProperties, saveProperties, setButtonPanelVisible, setDescription, setDescription, setDescriptionHeight, setOwner, setPageCheck, setPageName, setProceedAction, update, updateButtons, validate

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

KEY_FILES

public static final String KEY_FILES

key in the properties that contains the file name.

See Also:

Constant Field Values

m_ListFiles

protected BaseListWithButtons m_ListFiles

the list for the file names.

m_FileChooser

protected BaseFileChooser m_FileChooser

the filechooser for selecting the files.

m_ButtonAdd

protected BaseButton m_ButtonAdd

the button for bringing up the filechooser.

m_ButtonRemove

protected BaseButton m_ButtonRemove

the button for removing the selected files.

m_ButtonRemoveAll

protected BaseButton m_ButtonRemoveAll

the button for removing all files.

m_ButtonMoveUp

protected BaseButton m_ButtonMoveUp

the button for moving the selected files up.

m_ButtonMoveDown

protected BaseButton m_ButtonMoveDown

the button for moving the selected files down.

Constructor Detail

SelectMultipleFilesPage

public SelectMultipleFilesPage()

Default constructor.

SelectMultipleFilesPage

public SelectMultipleFilesPage(String pageName)

Initializes the page with the given page name.

Parameters:

pageName - the page name to use

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractWizardPage

initGUI

protected void initGUI()

Initializes the widets.

Overrides:

initGUI in class AbstractWizardPage

finishInit

protected void finishInit()

finishes the initialization.

Overrides:

finishInit in class BasePanel

updateListButtons

protected void updateListButtons()

Updates the enabled state of the buttons.

setAutoAppendExtension

public void setAutoAppendExtension(boolean value)

Sets whether to automatically append the currently selected file extension or the default one (if All-Filter is used).

Parameters:

value - if true, then the file extension will be added automatically

getAutoAppendExtension

public boolean getAutoAppendExtension()

Returns whether to automatically append the currently selected file extension or the default one (if All-Filter is used).

Returns:

true if the file extension will be added automatically

setDefaultExtension

public void setDefaultExtension(String value)

Sets the default extension. Is used if m_AutoAppendExtension is true and the All-Filter is selected.

Parameters:

value - the extension (without dot), use null to unset

getDefaultExtension

public String getDefaultExtension()

Returns the default extension. Is used if m_AutoAppendExtension is true and the All-Filter is selected.

Returns:

the extension, can be null

setCurrentDirectory

public void setCurrentDirectory(File value)

Sets the current directory to use for the file chooser.

Parameters:

value - the current directory

getCurrentDirectory

public File getCurrentDirectory()

Returns the current directory in use by the file chooser.

Returns:

the current directory

setCurrent

public void setCurrent(File[] value)

Sets the current files.

Parameters:

value - the files

getCurrent

public File[] getCurrent()

Returns the current files.

Returns:

the current files

addChoosableFileFilter

public void addChoosableFileFilter(FileFilter value)

Adds the given file filter to the filechooser.

Parameters:

value - the file filter to add

setFileFilter

public void setFileFilter(FileFilter value)

Sets the active file filter.

Parameters:

value - the file filter to select

getFileFilter

public FileFilter getFileFilter()

Returns the active file filter.

Returns:

the current file filter

setProperties

public void setProperties(Properties value)

Sets the content of the page (ie parameters) as properties.

Specified by:

setProperties in class AbstractWizardPage

Parameters:

value - the parameters as properties

getProperties

public Properties getProperties()

Returns the content of the page (ie parameters) as properties.

Specified by:

getProperties in class AbstractWizardPage

Returns:

the parameters as properties