nl.lxtreme.ols.tool.base
Interface ToolDialog

All Known Implementing Classes:
BaseToolDialog

public interface ToolDialog

Provides a common interface for all tool dialogs.


Method Summary
 void cancelTool()
          Called to cancel the tool (if it is running).
 boolean invokeTool()
          Called to invoke the actual tool.
 void reset()
          Resets the dialog, will be called if the dialog is shown at least once and should be redisplayed again.
 void showDialog()
          Shows the dialog with the given capture results.
 

Method Detail

cancelTool

void cancelTool()
                throws IllegalStateException
Called to cancel the tool (if it is running).

Throws:
IllegalStateException - in case the tool isn't running.

invokeTool

boolean invokeTool()
                   throws IllegalStateException
Called to invoke the actual tool.

Returns:
TODO
Throws:
IllegalStateException - in case the tool is already running.

reset

void reset()
Resets the dialog, will be called if the dialog is shown at least once and should be redisplayed again. Use this method to reset the state of the dialog to its initial state.


showDialog

void showDialog()
Shows the dialog with the given capture results.



Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.