oracle.ide.externaltools
Interface ExternalToolType

All Superinterfaces:

Displayable

public interface ExternalToolType
extends Displayable

A type of external tool. To define a new type of external tool, provide an implementation of this interface, then register it with the tool manager using ExternalToolManager.registerType( ExternalToolType ).

Method Summary

ExternalTool	createExternalTool() Create an external tool of this type.
java.net.URL	getDefaultIconURL(ExternalTool tool) Get the default icon URL to use for the specified external tool of this type.
ExternalToolOptionsPage[]	getOptionsPages() Get the options page(s) for this external tool type.

Methods inherited from interface oracle.ide.model.Displayable

getIcon, getLongLabel, getShortLabel, getToolTipText, toString

Method Detail

createExternalTool

ExternalTool createExternalTool()

Create an external tool of this type.

Returns:

a new object that implements the ExternalTool interface. This method must not return null.

getOptionsPages

ExternalToolOptionsPage[] getOptionsPages()

Get the options page(s) for this external tool type. The options pages you provide are plugged into the extensible wizard used to create and edit external tools.

Returns:

an array of options pages. There should be at least one page in the array. This method must not return null.

getDefaultIconURL

java.net.URL getDefaultIconURL(ExternalTool tool)

Get the default icon URL to use for the specified external tool of this type.

Parameters:

tool - an external tool to get the default icon for, guaranteed to be a tool created by the createExternalTool() method of this interface.

Returns:

the URL of the default icon for this tool. This needn't be specific to tool, it could be a generic icon for all tools of this type. You can also return null if you want to use the ueber-generic icon that is provided by the external tool manager.

Throws:

java.lang.NullPointerException - if tool is null.

java.lang.IllegalArgumentException - if tool is not a tool handled by this type.