@ALDDataIOProvider public class ALDFileDirectoryDataIOSwing extends Object implements ALDDataIOSwing
This class provides a panel for a GUI which contains a text entry field for the path, and in addition a button that opens a dialog for browsing the file system. By this it allows to select files and directories in a comfortable manner.
Modifier and Type | Class and Description |
---|---|
protected class |
ALDFileDirectoryDataIOSwing.FileDirectoryDataIOPanel
GUI panel for IO of file and directory names.
|
Modifier and Type | Field and Description |
---|---|
protected static String |
directoryDefault
Default directory to be used initially.
|
protected static String |
fileDefault
Default file name in current working directory.
|
Constructor and Description |
---|
ALDFileDirectoryDataIOSwing() |
Modifier and Type | Method and Description |
---|---|
ALDSwingComponent |
createGUIElement(Field field,
Class<?> cl,
Object obj,
ALDParameterDescriptor descr)
Interface method to create a GUI element for data input.
|
Object |
getInitialGUIValue(Field field,
Class<?> cl,
Object obj,
ALDParameterDescriptor descr)
Interface method to request initial GUI values of provider.
|
Collection<Class<?>> |
providedClasses()
Interface method to announce class for which IO is provided for.
|
Object |
readData(Field field,
Class<?> cl,
ALDSwingComponent guiElement)
Interface method for getting parameter values via a GUI element.
|
void |
setValue(Field field,
Class<?> cl,
ALDSwingComponent guiElement,
Object value)
Interface method for setting new parameter values in GUI.
|
JComponent |
writeData(Object obj,
ALDParameterDescriptor descr)
Interface method for displaying an object in the GUI.
|
protected static final String directoryDefault
protected static final String fileDefault
public Collection<Class<?>> providedClasses()
providedClasses
in interface ALDDataIO
public Object getInitialGUIValue(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr)
ALDDataIOSwing
Note that while the object is allowed to be null
the descriptor has to be different from null
in any
case.
getInitialGUIValue
in interface ALDDataIOSwing
field
- Field of the parameter the GUI element is linked to.cl
- Class of the parameter and the returned object.obj
- The current value of corresponding parameter.descr
- Optional descriptor to provide additional information.public ALDSwingComponent createGUIElement(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr)
ALDDataIOSwing
Optionally an object may be supplied which is assumed to be of
type cl
and used as default.
createGUIElement
in interface ALDDataIOSwing
field
- Field of the parameter the GUI element is linked to.cl
- Class of object to be returned.obj
- The value of this object to be set as inital value.descr
- Optional descriptor to provide additional information.public void setValue(Field field, Class<?> cl, ALDSwingComponent guiElement, Object value) throws ALDDataIOProviderException
ALDDataIOSwing
setValue
in interface ALDDataIOSwing
field
- Field of parameter object to be handled.cl
- Class of parameter object to be handled.guiElement
- Corresponding GUI element.value
- New value of the parameter.ALDDataIOProviderException
- Thrown in case of failure.public Object readData(Field field, Class<?> cl, ALDSwingComponent guiElement) throws ALDDataIOProviderException
ALDDataIOSwing
readData
in interface ALDDataIOSwing
field
- Field associated with object to be returned.cl
- Class of object to be returned.guiElement
- Component from where to read data.null
.ALDDataIOProviderException
- Thrown in case of failure.public JComponent writeData(Object obj, ALDParameterDescriptor descr) throws ALDDataIOProviderException
ALDDataIOSwing
writeData
in interface ALDDataIOSwing
obj
- Object to be displayed or saved.descr
- Optional descriptor to hand over additional information.ALDDataIOProviderException
- Thrown in case of failure.Copyright © 2010–2021 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.