de.ipk_gatersleben.bit.bi.edal.rmi.client.gui

Class EdalFileChooser

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalTitleDialog

de.ipk_gatersleben.bit.bi.edal.rmi.client.gui.EdalFileChooser

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class EdalFileChooser
extends EdalTitleDialog

EDALFileChooser provides a simple mechanism for the user to choose a file from EDAL File System.

The following code pops up a file chooser for the user that sees only .jpg and .gif images:

 EDALFileChooser chooser = new EDALFileChooser((Frame) window, rootDirectory);
 EdalFileNameExtensionFilter filter = new EdalFileNameExtensionFilter(
                "JPG & GIF Images", "jpg", "gif");
 chooser.setFileFilter(filter);
 int returnVal = chooser.showOpenDialog();
 if (returnVal == EDALFileChooser.APPROVE_OPTION) {
        System.out.println("You chose to open this file: "
                        + chooser.getSelectedFile().getName());
 }
 

Version:

1.0

Author:

Jinbo Chen

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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 and Description
static int	APPROVE_OPTION Return value if approve (yes, ok) is chosen.
static int	CANCEL_OPTION Return value if cancel is chosen.
protected ClientPrimaryDataDirectory	currentdir
static int	DIRECTORIES_ONLY Instruction to display only directories.
static int	ERROR_OPTION Return value if an error occured.
static int	FILES_AND_DIRECTORIES Instruction to display both files and directories.
static int	FILES_ONLY Instruction to display only files.
protected JButton	okbutton
protected JTextField	pathtext
protected ClientPrimaryDataEntity	selectedFile

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
EdalFileChooser(Dialog owner, ClientPrimaryDataDirectory rootDirectory, ClientDataManager client) Constructs a EDALFileChooser that is initialized with owner as the swing container owner(JDialog), rootDirectory as the root directory, and client as the rmi client datamanager.
EdalFileChooser(Frame owner, ClientPrimaryDataDirectory rootDirectory, ClientDataManager client) Constructs a EDALFileChooser that is initialized with owner as the swing container owner(JFrame), rootDirectory as the root directory, and client as the rmi client datamanager.

Method Summary

Methods

Modifier and Type	Method and Description
EdalAbstractFileFilter	getFileFilter() Returns the currently selected file filter.
int	getFileSelectionMode() Returns the current file-selection mode.
ClientPrimaryDataEntity	getSelectedFile() Returns the selected file.
ClientPrimaryDataEntity[]	getSelectedFiles() Returns a list of selected files if the file chooser is set to allow multiple selection.
protected void	handleokclick()
protected void	init(ClientPrimaryDataDirectory rootDirectory)
protected void	initViewers()
void	setFileFilter(EdalAbstractFileFilter filter) Sets the current file filter.
void	setFileSelectionMode(int mode) Sets the EDALFileChooser to allow the user to just select files, just select directories, or select both files and directories.
void	setMultiSelectionEnabled(boolean b) Sets the file chooser to allow multiple file selections.
int	showOpenDialog() Pops up an "Open File" file chooser dialog.
int	showSaveDialog() Pops up a "Save File" file chooser dialog.

Methods inherited from class de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalTitleDialog

getContentPane, getTitleComponent, setContentPane, setIconImage, setResizable, setTitle, setUndecorated

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setShape, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, 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

pathtext

protected final JTextField pathtext

selectedFile

protected ClientPrimaryDataEntity selectedFile

currentdir

protected ClientPrimaryDataDirectory currentdir

okbutton

protected JButton okbutton

CANCEL_OPTION

public static final int CANCEL_OPTION

Return value if cancel is chosen.

See Also:

Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

Return value if approve (yes, ok) is chosen.

See Also:

Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

Return value if an error occured.

See Also:

Constant Field Values

FILES_ONLY

public static final int FILES_ONLY

Instruction to display only files.

See Also:

Constant Field Values

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

Instruction to display only directories.

See Also:

Constant Field Values

FILES_AND_DIRECTORIES

public static final int FILES_AND_DIRECTORIES

Instruction to display both files and directories.

See Also:

Constant Field Values

Constructor Detail

EdalFileChooser

public EdalFileChooser(Frame owner,
               ClientPrimaryDataDirectory rootDirectory,
               ClientDataManager client)

Constructs a EDALFileChooser that is initialized with owner as the swing container owner(JFrame), rootDirectory as the root directory, and client as the rmi client datamanager. If any of the parameters are null this method will not initialize.

Parameters:

owner - the swing container owner

rootDirectory - the root directory

client - the rmi client datamanager

EdalFileChooser

public EdalFileChooser(Dialog owner,
               ClientPrimaryDataDirectory rootDirectory,
               ClientDataManager client)

Constructs a EDALFileChooser that is initialized with owner as the swing container owner(JDialog), rootDirectory as the root directory, and client as the rmi client datamanager. If any of the parameters are null this method will not initialize.

Parameters:

owner - the swing container owner

rootDirectory - the root directory

client - the rmi client datamanager

Method Detail

getSelectedFile

public ClientPrimaryDataEntity getSelectedFile()

Returns the selected file. This can be set by a user action, such as selecting the file from a list in the UI.

Returns:

the selected file

getSelectedFiles

public ClientPrimaryDataEntity[] getSelectedFiles()

Returns a list of selected files if the file chooser is set to allow multiple selection.

showOpenDialog

public int showOpenDialog()

Pops up an "Open File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.

Returns:

the return state of the file chooser on popdown:

• EDALFileChooser.CANCEL_OPTION
• EDALFileChooser.APPROVE_OPTION
• EDALFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed

showSaveDialog

public int showSaveDialog()

Pops up a "Save File" file chooser dialog. Note that the text that appears in the approve button is determined by the L&F.

Returns:

the return state of the file chooser on popdown:

• EDALFileChooser.CANCEL_OPTION
• EDALFileChooser.APPROVE_OPTION
• EDALFileChooser.ERROR_OPTION if an error occurs or the dialog is dismissed

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean b)

Sets the file chooser to allow multiple file selections.

Parameters:

b - true if multiple files may be selected

setFileFilter

public void setFileFilter(EdalAbstractFileFilter filter)

Sets the current file filter. The file filter is used by the file chooser to filter out files from the user's view.

Parameters:

filter - the new current file filter to use

See Also:

getFileFilter()

getFileFilter

public EdalAbstractFileFilter getFileFilter()

Returns the currently selected file filter.

Returns:

the current file filter

See Also:

setFileFilter(de.ipk_gatersleben.bit.bi.edal.rmi.client.util.EdalAbstractFileFilter)

setFileSelectionMode

public void setFileSelectionMode(int mode)

Sets the EDALFileChooser to allow the user to just select files, just select directories, or select both files and directories. The default is EDALFileChooser.FILES_ONLY.

Parameters:

mode - the type of files to be displayed:

• EDALFileChooser.FILES_ONLY
• EDALFileChooser.DIRECTORIES_ONLY
• EDALFileChooser.FILES_AND_DIRECTORIES

Throws:

IllegalArgumentException - if mode is an illegal file selection mode

See Also:

getFileSelectionMode()

getFileSelectionMode

public int getFileSelectionMode()

Returns the current file-selection mode. The default is EDALFileChooser.FILES_ONLY.

Returns:

the type of files to be displayed, one of the following:

• EDALFileChooser.FILES_ONLY
• EDALFileChooser.DIRECTORIES_ONLY
• EDALFileChooser.FILES_AND_DIRECTORIES

See Also:

setFileSelectionMode(int)

init

protected void init(ClientPrimaryDataDirectory rootDirectory)

initViewers

protected void initViewers()

handleokclick

protected void handleokclick()