public interface IOpenTool
Modifier and Type | Field and Description |
---|---|
static int |
BIG_ICON
A constant used to refer to the large icon type, as passed to the function getIcon().
|
static int |
SMALL_ICON
A constant used to refer to the small icon type, as passed to the function getIcon().
|
Modifier and Type | Method and Description |
---|---|
void |
execute()
Called to carry out the main functionality of the Open Tool.
|
java.lang.String |
getDescription()
Returns a description of this Open Tool.
|
java.lang.String |
getIcon(int pIconType)
Returns a path to the .gif file within the Open Tool's .jar package for the icon of a certain type.
|
IOpenToolParameter[] |
getParameters()
Returns an array of IOpenToolParameter objects that can be used to configure the behavior of this Open Tool when it is executed.
|
java.lang.String |
getProvider()
Returns the name of the provider of this Open Tool.
|
java.lang.String |
getSyntax()
Returns the syntax of the Open Tool which is used to initialize the Command and General tabs of the tool in the package window.
|
java.lang.String |
getVersion()
Returns the version number of this Open Tool.
|
static final int SMALL_ICON
static final int BIG_ICON
void execute() throws OpenToolExecutionException
OpenToolExecutionException
- excepton during executionjava.lang.String getSyntax()
java.lang.String getDescription()
java.lang.String getVersion()
java.lang.String getProvider()
java.lang.String getIcon(int pIconType)
pIconType
- icon typeIOpenToolParameter[] getParameters()
IOpenToolParameter