org.scijava.ui.swing.widget

Class SwingFileWidget

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.plugin.AbstractTypedPlugin<D>

org.scijava.plugin.AbstractWrapperPlugin<WidgetModel>

org.scijava.widget.AbstractInputWidget<T,W>

org.scijava.ui.AbstractUIInputWidget<T,JPanel>

org.scijava.ui.swing.widget.SwingInputWidget<File>

org.scijava.ui.swing.widget.SwingFileWidget

All Implemented Interfaces:

ActionListener, Comparable<Prioritized>, EventListener, DocumentListener, Contextual, Identifiable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, TypedPlugin<WidgetModel>, WrapperPlugin<WidgetModel>, Prioritized, Typed<WidgetModel>, Versioned, FileWidget<JPanel>, InputWidget<File,JPanel>, UIComponent<JPanel>

public class SwingFileWidget
extends SwingInputWidget<File>
implements FileWidget<JPanel>, ActionListener, DocumentListener

Swing implementation of file selector widget.

Author:

Curtis Rueden

Field Summary

Fields inherited from interface org.scijava.widget.FileWidget

DIRECTORY_STYLE, OPEN_STYLE, SAVE_STYLE

Constructor Summary

Constructors

Constructor and Description
SwingFileWidget()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	changedUpdate(DocumentEvent e)
static FileFilter	createFileFilter(String widgetStyle) Creates a FileFilter that filters files and/or directories according to the given widget style.
void	doRefresh()
static List<File>	filterFiles(List<File> list, FileFilter filter) Filters the given list of files according to the specified FileFilter.
static List<File>	getFiles(TransferHandler.TransferSupport support) Gets the list of files associated with the given drag and drop operation.
static String	getText(TransferHandler.TransferSupport support) Gets the String content of the current transfer support
File	getValue()
static boolean	hasFiles(TransferHandler.TransferSupport support) Checks whether the given drag and drop operation offers a list of files as one of its flavors.
void	insertUpdate(DocumentEvent e)
void	removeUpdate(DocumentEvent e)
void	set(WidgetModel model)
boolean	supports(WidgetModel model)

Methods inherited from class org.scijava.ui.swing.widget.SwingInputWidget

getComponent, getComponentType, setToolTip, ui

Methods inherited from class org.scijava.ui.AbstractUIInputWidget

refreshWidget, ui

Methods inherited from class org.scijava.widget.AbstractInputWidget

get, updateModel

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.widget.InputWidget

get, getType, isLabeled, isMessage, refreshWidget, updateModel

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.widget.UIComponent

getComponent, getComponentType

Constructor Detail

SwingFileWidget

public SwingFileWidget()

Method Detail

getValue

public File getValue()

Specified by:

getValue in interface InputWidget<File,JPanel>

set

public void set(WidgetModel model)

Specified by:

set in interface WrapperPlugin<WidgetModel>

Specified by:

set in interface InputWidget<File,JPanel>

Overrides:

set in class SwingInputWidget<File>

supports

public boolean supports(WidgetModel model)

Specified by:

supports in interface Typed<WidgetModel>

Specified by:

supports in interface InputWidget<File,JPanel>

Overrides:

supports in class AbstractInputWidget<File,JPanel>

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

doRefresh

public void doRefresh()

Specified by:

doRefresh in class AbstractUIInputWidget<File,JPanel>

createFileFilter

public static FileFilter createFileFilter(String widgetStyle)

Creates a FileFilter that filters files and/or directories according to the given widget style.

It supports filtering files by extension as specified by the syntax extensions:ext1/ext2 where ext1, ext2, etc., are extensions to accept. It also filters files and/or directories as specified by the following styles:

• FileWidget.OPEN_STYLE
• FileWidget.SAVE_STYLE
• FileListWidget.FILES_ONLY
• FileWidget.DIRECTORY_STYLE
• FileListWidget.DIRECTORIES_ONLY
• FileListWidget.FILES_AND_DIRECTORIES

Parameters:

widgetStyle - The style defining which files get accepted by the filter.

Returns:

A FileFilter that accepts files matching the given widget style.

hasFiles

public static boolean hasFiles(TransferHandler.TransferSupport support)

Checks whether the given drag and drop operation offers a list of files as one of its flavors.

Parameters:

support - The drag and drop operation that should be checked.

Returns:

True iff the operation can provide a list of files.

getFiles

public static List<File> getFiles(TransferHandler.TransferSupport support)

Gets the list of files associated with the given drag and drop operation.

Parameters:

support - The drag and drop operation from which files should be extracted.

Returns:

The list of files, or null if something goes wrong: operation does not provide a list; the list contains something other than File objects; or an exception is thrown.

getText

public static String getText(TransferHandler.TransferSupport support)

Gets the String content of the current transfer support

Parameters:

support - The paste (or drag and drop) operation from which text should be extracted.

Returns:

The pasted (or dropped) text

filterFiles

public static List<File> filterFiles(List<File> list,
                                     FileFilter filter)

Filters the given list of files according to the specified FileFilter.

Parameters:

list - The list of files to filter.

filter - The filter to use.

Returns:

A newly created list including only the matching files.