at.mug.iqm.api.operator

Interface IOperatorGUI

All Known Implementing Classes:

AbstractImageOperatorGUI, AbstractOperatorGUI, AbstractPlotOperatorGUI, OperatorGUI_ACF, OperatorGUI_Affine, OperatorGUI_Align, OperatorGUI_Border, OperatorGUI_BUnwarpJ, OperatorGUI_CalcImage, OperatorGUI_CalcValue, OperatorGUI_CoGReg, OperatorGUI_ColDecon, OperatorGUI_ComplexLogDepth, OperatorGUI_Convert, OperatorGUI_CreateFracSurf, OperatorGUI_CreateImage, OperatorGUI_Crop, OperatorGUI_DFT, OperatorGUI_DirLocal, OperatorGUI_DistMap, OperatorGUI_Edge, OperatorGUI_FracBox, OperatorGUI_FracFFT, OperatorGUI_FracGenDim, OperatorGUI_FracHiguchi, OperatorGUI_FracHRM, OperatorGUI_FracIFS, OperatorGUI_FracLac, OperatorGUI_FracMinkowski, OperatorGUI_FracPyramid, OperatorGUI_FracScan, OperatorGUI_FracSurrogate, OperatorGUI_HistoModify, OperatorGUI_ImgStabilizer, OperatorGUI_Invert, OperatorGUI_KMeans, OperatorGUI_KMeansFuzzy, OperatorGUI_Morph, OperatorGUI_NexelScan, OperatorGUI_Rank, OperatorGUI_RegGrow, OperatorGUI_Resize, OperatorGUI_RGBRelative, OperatorGUI_ROISegment, OperatorGUI_Smooth, OperatorGUI_StackStat, OperatorGUI_Statistics, OperatorGUI_StatRegMerge, OperatorGUI_TempMatch, OperatorGUI_Threshold, OperatorGUI_TurboReg, OperatorGUI_UnsharpMask, OperatorGUI_Watershed, OperatorGUI_WhiteBalance, PlotGUI_AutoCorrelation, PlotGUI_ComplLogDepth, PlotGUI_Cut, PlotGUI_DCMGenerator, PlotGUI_Entropy, PlotGUI_FFT, PlotGUI_Filter, PlotGUI_FracAllomScale, PlotGUI_FracHiguchi, PlotGUI_FracHurst, PlotGUI_FracSurrogate, PlotGUI_FractalGenerator, PlotGUI_Math, PlotGUI_PointFinder, PlotGUI_SignalGenerator, PlotGUI_Statistics, PlotGUI_SymbolicAggregation

public interface IOperatorGUI

This interface declares methods for an operator GUI in IQM.

Author:

Philipp Kainz

Method Summary

Modifier and Type	Method and Description
void	destroy() Custom routine for disposing the GUI, may be overridden.
void	disableInputs() Disables inputs on the GUI elements.
void	enableInputs() Enables or re-enables inputs on the GUI elements.
String	getOpName() Gets the operator's name associated with this GUI.
IWorkPackage	getWorkPackage() Gets the work package of an operator GUI using the current parameters set by the custom GUI elements.
void	initialize() Initialize the default settings for an IOperatorGUI, e.g.
boolean	isVisible() Determines whether or not the GUI is currently visible to the user.
void	reset() Resets the GUI to it's default values and default parameters in the work package.
void	setOpName(String opName) Sets the name of the operator to this GUI.
void	setParameterValuesToGUI() This method implements the initialization of the GUI.
void	setVisible(boolean b) A custom routine for setting the GUI visible (this may override the default implementation when using JFrame as base container class).
void	setWorkPackage(IWorkPackage wp) Sets the work package to the operator's GUI, so that the custom GUI elements can be constructed using the parameter values.
void	showPreview() Performs a preview of the operator using the current work package.
void	update() Instruct the GUI to validate and repaint for updated parameters, e.g.
void	updateParameterBlock() Updates the parameter block in the work package using the current states of the custom GUI elements.
void	updateParameterBlock(ParameterBlockIQM pb) Sets the parameter block in the work package.

Method Detail

initialize

void initialize()

Initialize the default settings for an IOperatorGUI, e.g. the location of the window or the default close operation.

setVisible

void setVisible(boolean b)

A custom routine for setting the GUI visible (this may override the default implementation when using JFrame as base container class).

isVisible

boolean isVisible()

Determines whether or not the GUI is currently visible to the user.

Returns:

true if the GUI is displayed, false otherwise

update

void update()
     throws Exception

Instruct the GUI to validate and repaint for updated parameters, e.g. if the GUI is altered for another input type.

This method alters the GUI elements in a container, if the input type is non-standard for this operator GUI. Furthermore, this method is responsible for setting the parameters to the elements and calls updateParameterBlock() before setParameterValuesToGUI() as last statements.

Throws:

Exception

setWorkPackage

void setWorkPackage(IWorkPackage wp)

Sets the work package to the operator's GUI, so that the custom GUI elements can be constructed using the parameter values.

Parameters:

wp -

getWorkPackage

IWorkPackage getWorkPackage()

Gets the work package of an operator GUI using the current parameters set by the custom GUI elements.

Returns:

the work package

setParameterValuesToGUI

void setParameterValuesToGUI()
                      throws Exception

This method implements the initialization of the GUI. An instance of IOperatorGUI may be constructed empty or directly using a valid IWorkPackage.

If the GUI is constructed empty, the work package must be set manually using setWorkPackage(IWorkPackage) and setParameterValuesToGUI() must be called in order to set the parameter values to the GUI.

Throws:

Exception

updateParameterBlock

void updateParameterBlock()
                   throws Exception

Updates the parameter block in the work package using the current states of the custom GUI elements.

Throws:

Exception

updateParameterBlock

void updateParameterBlock(ParameterBlockIQM pb)
                   throws Exception

Sets the parameter block in the work package. This method replaces the ParameterBlockIQM instance in the work package.

Hint: This method call should be followed by setParameterValuesToGUI() in order to update the GUI elements, too.

Parameters:

pb - the parameter block containing the new data

Throws:

Exception

showPreview

void showPreview()

Performs a preview of the operator using the current work package. This method calls executeTask(AbstractProcessingTask).

reset

void reset()

Resets the GUI to it's default values and default parameters in the work package.

destroy

void destroy()

Custom routine for disposing the GUI, may be overridden.

disableInputs

void disableInputs()

Disables inputs on the GUI elements.

enableInputs

void enableInputs()

Enables or re-enables inputs on the GUI elements.

setOpName

void setOpName(String opName)

Sets the name of the operator to this GUI.

Parameters:

opName -

getOpName

String getOpName()

Gets the operator's name associated with this GUI.

Returns:

the opName