public interface Tool<RESULT_TYPE>
All tools implementing this interface that are added to the tools class list will be automatically added to the tools menu in the client.
Modifier and Type | Method and Description |
---|---|
ToolTask<RESULT_TYPE> |
createToolTask(ToolContext aContext,
ToolProgressListener aProgressListener,
AnnotationListener aAnnotationListener)
Factory method for creating a new
ToolTask instance. |
ToolCategory |
getCategory()
Returns the category for this tool.
|
String |
getName()
Is called to get the name for the menu entry.
|
void |
invoke(Window aParent,
ToolContext aContext)
Allows this tool controller to set up the tool by means of presenting an
UI.
|
ToolTask<RESULT_TYPE> createToolTask(ToolContext aContext, ToolProgressListener aProgressListener, AnnotationListener aAnnotationListener)
ToolTask
instance.aContext
- the tool context to use within the tool taks, cannot be
null
;aProgressListener
- the tool progress listener the tool can use to report its
progress, cannot be null
.ToolCategory getCategory()
Each tool must provide a category in order to be grouped correctly.
null
.String getName()
The name must be unique among all tools. Should end in "..." if it opens a dialog window.
void invoke(Window aParent, ToolContext aContext)
aParent
- the parent window that can be used to display (modal) dialogs, can
be null
;aContext
- the context in which the tool should be run, cannot be
null
;Copyright © 2015 L'Xtreme IT consultancy. All rights reserved.