-
public interface IIOParamControllerAn interface to be implemented by objects that can determine the settings of anIIOParamobject, either by putting up a GUI to obtain values from a user, or by other means. This interface merely specifies a genericactivatemethod that invokes the controller, without regard for how the controller obtains values (i.e., whether the controller puts up a GUI or merely computes a set of values is irrelevant to this interface).Within the
activatemethod, a controller obtains initial values by querying theIIOParamobject'sgetmethods, modifies values by whatever means, then invokes theIIOParamobject'ssetmethods to modify the appropriate settings. Normally, thesesetmethods will be invoked all at once at a final commit in order that a cancel operation not disturb existing values. In general, applications may expect that when theactivatemethod returnstrue, theIIOParamobject is ready for use in a read or write operation.Vendors may choose to provide GUIs for the
IIOParamsubclasses they define for a particular plug-in. These can be set up as default controllers in the correspondingIIOParamsubclasses.Applications may override any default GUIs and provide their own controllers embedded in their own framework. All that is required is that the
activatemethod behave modally (not returning until either cancelled or committed), though it need not put up an explicitly modal dialog. Such a non-modal GUI component would be coded roughly as follows:
class MyGUI extends SomeComponent implements IIOParamController { public MyGUI() { // ... setEnabled(false); } public boolean activate(IIOParam param) { // disable other components if desired setEnabled(true); // go to sleep until either cancelled or committed boolean ret = false; if (!cancelled) { // set values on param ret = true; } setEnabled(false); // enable any components disabled above return ret; }Alternatively, an algorithmic process such as a database lookup or the parsing of a command line could be used as a controller, in which case the
activatemethod would simply look up or compute the settings, call theIIOParam.setXXXmethods, and returntrue.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanactivate(IIOParam param)Activates the controller.
-
-
-
Method Detail
-
activate
boolean activate(IIOParam param)
Activates the controller. Iftrueis returned, all settings in theIIOParamobject should be ready for use in a read or write operation. Iffalseis returned, no settings in theIIOParamobject will be disturbed (i.e., the user canceled the operation).- Parameters:
param- theIIOParamobject to be modified.- Returns:
trueif theIIOParamhas been modified,falseotherwise.- Throws:
IllegalArgumentException- ifparamisnullor is not an instance of the correct class.
-
-