public interface ALDDataIOSwing extends ALDDataIO
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.
|
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 d)
Interface method for displaying an object in the GUI.
|
providedClasses
Object getInitialGUIValue(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr) throws ALDDataIOProviderException
Note that while the object is allowed to be null
the descriptor has to be different from null
in any
case.
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.ALDDataIOProviderException
- Thrown in case of failure.ALDSwingComponent createGUIElement(Field field, Class<?> cl, Object obj, ALDParameterDescriptor descr) throws ALDDataIOProviderException
Optionally an object may be supplied which is assumed to be of
type cl
and used as default.
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.ALDDataIOProviderException
- Thrown in case of failure.void setValue(Field field, Class<?> cl, ALDSwingComponent guiElement, Object value) throws ALDDataIOProviderException
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.Object readData(Field field, Class<?> cl, ALDSwingComponent guiElement) throws ALDDataIOProviderException
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.JComponent writeData(Object obj, ALDParameterDescriptor d) throws ALDDataIOProviderException
obj
- Object to be displayed or saved.d
- 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.