oracle.ide.externaltools

Class ExternalToolType

java.lang.Object

oracle.ide.externaltools.ExternalToolType

All Implemented Interfaces:

Displayable

public abstract class ExternalToolType
extends java.lang.Object
implements Displayable

A type of external tool. To define a new type of external tool, subclass this class providing your own implementations of: - createExternalTool() - getOptionsPages() Then register your implementation declaratively in your extension's extension.xml with the externaltools trigger hook Note that the following methods are provided in this abstract class to satisfy the Displayable interface but these implementations will not be called. Instead the implementation in LazyExternalToolType will be used because that will be used to wrap each declaratively registered implementation. - getShortLabel() - getLongLabel() - getToolTipText() - getIcon()

Constructor Summary

Constructors

Constructor and Description
ExternalToolType()

Method Summary

Methods

Modifier and Type	Method and Description
ExternalTool	createExternalTool() Note: this method should not be overridden by declarative implementations
java.lang.String	getClassName() Note: this method should not be overridden by declarative implementations
java.net.URL	getDefaultIconURL(ExternalTool tool) Get the default icon URL to use for the specified external tool of this type.
javax.swing.Icon	getIcon() Note: this method should not be overridden by declarative implementations
java.lang.String	getId() Gets an id that uniquely identifies this external tool type.
java.lang.String	getLongLabel() Note: this method should not be overridden by declarative implementations
abstract ExternalToolOptionsPage[]	getOptionsPages() Get the options page(s) for this external tool type.
java.lang.String	getShortLabel() Note: this method should not be overridden by declarative implementations
java.lang.String	getToolTipText() Note: this method should not be overridden by declarative implementations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.ide.model.Displayable

toString

Constructor Detail

ExternalToolType

public ExternalToolType()

Method Detail

getOptionsPages

public abstract 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

public java.net.URL getDefaultIconURL(ExternalTool tool)

Get the default icon URL to use for the specified external tool of this type. Note: this method should not be overridden by declarative implementations

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.

getId

public java.lang.String getId()

Gets an id that uniquely identifies this external tool type. This will be used to determine if a MacroExpander is valid for a given external tool type Note: this method should not be overridden by declarative implementations

Returns:

unique identifier for this external tool type

getIcon

public javax.swing.Icon getIcon()

Note: this method should not be overridden by declarative implementations

Specified by:

getIcon in interface Displayable

Returns:

the Icon to be displayed for the Displayable.

getLongLabel

public java.lang.String getLongLabel()

Note: this method should not be overridden by declarative implementations

Specified by:

getLongLabel in interface Displayable

Returns:

a long descriptive label of the Displayable that can be shown to the user.

getShortLabel

public java.lang.String getShortLabel()

Note: this method should not be overridden by declarative implementations

Specified by:

getShortLabel in interface Displayable

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getToolTipText

public java.lang.String getToolTipText()

Note: this method should not be overridden by declarative implementations

Specified by:

getToolTipText in interface Displayable

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

getClassName

public java.lang.String getClassName()

Note: this method should not be overridden by declarative implementations

createExternalTool

public ExternalTool createExternalTool()

Note: this method should not be overridden by declarative implementations