public abstract class ExternalToolManager
extends java.lang.Object
getExternalToolManager()
method.Extension developers should not subclass this class.
Modifier | Constructor and Description |
---|---|
protected |
ExternalToolManager() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addExternalTool(ExternalTool tool)
Programmatically adds an external tool.
|
void |
addExternalToolListener(ExternalToolListener listener)
Adds a listener for events related to external tools.
|
void |
fireToolStarted(ExternalToolEvent event)
Notifies all listeners that an external tool has started.
|
void |
fireToolWillStart(ExternalToolEvent event)
Notifies all listeners that an external tool is about to start.
|
java.util.Iterator<ExternalTool> |
getAllExternalTools()
Deprecated.
since 11.1.1.0.1. Use
tools() . |
static ExternalToolManager |
getExternalToolManager()
Obtains the singleton external tool manager.
|
java.util.Iterator<ExternalTool> |
getExternalToolsByType(ExternalToolType type)
Deprecated.
since 11.1.1.0.1. Use
toolsOfType(ExternalToolType) . |
abstract MacroRegistry |
getMacroRegistry()
Gets the macro registry.
|
abstract int |
getRegisteredTypeCount()
Returns the number of registered types.
|
abstract java.util.Iterator<ExternalToolType> |
getRegisteredTypes()
Gets all registered external tool types.
|
java.util.List<ExternalToolScanner> |
getScanners()
Returns all registered scanners.
|
ExternalToolType |
getType(ExternalTool tool)
Gets the type of the specified external tool
|
abstract ExternalTool |
invokeCreateWizard(java.awt.Component parent,
ExternalToolType type)
Invokes the Define External Tool wizard programmatically.
|
abstract boolean |
invokeEditDialog(java.awt.Component parent,
ExternalTool tool)
Invokes the Edit External Tool dialog programmatically.
|
void |
registerScanner(ExternalToolScanner scanner)
Deprecated.
since 11.0. Scanners should be registered in the
<externaltools> section of the extension manifest.
|
abstract void |
registerType(ExternalToolType type)
Deprecated.
since 11.1.2.0 where external tools must be declaratively registered
|
abstract void |
removeExternalTool(ExternalTool tool)
Removes an existing external tool.
|
void |
removeExternalToolListener(ExternalToolListener listener)
Removes a listener for events related to external tools.
|
static java.util.Set<java.lang.String> |
scannerTags(java.util.Collection<ExternalTool> tools)
Returns the set of
scannerTags
used by a collection of tools. |
abstract java.util.Collection<ExternalTool> |
tools()
Returns all defined external tools.
|
abstract java.util.Collection<ExternalTool> |
toolsOfType(ExternalToolType type)
Returns external tools of a specific type.
|
void |
unregisterScanner(ExternalToolScanner scanner)
Deprecated.
since 11.0. No replacement.
|
abstract void |
unregisterType(ExternalToolType type)
Deprecated.
since 11.1.2.0 where external tools must be declaratively registered
|
public static final ExternalToolManager getExternalToolManager()
public final void addExternalToolListener(ExternalToolListener listener)
It is safe to call this method from any thread.
listener
- a listener to add.java.lang.NullPointerException
- if listener is null.public final void removeExternalToolListener(ExternalToolListener listener)
It is safe to call this method from any thread.
listener
- a listener to remove.public final void fireToolWillStart(ExternalToolEvent event) throws ExternalToolVetoException
This API is intended for ExternalToolType
implementors, and should
not be used directly by extension developers.
It is safe to call this method from any thread.
event
- an event to fire.java.lang.NullPointerException
- if tool is null.ExternalToolVetoException
- if a listener vetoed the event.public final void fireToolStarted(ExternalToolEvent event)
This API is intended for ExternalToolType
implementors, and should
not be used directly by extension developers.
It is safe to call this method from any thread.
event
- an event to fire.java.lang.NullPointerException
- if tool is null.public void registerScanner(ExternalToolScanner scanner)
scanner
- a scanner that can find external toolspublic void unregisterScanner(ExternalToolScanner scanner)
scanner
- the scanner to unregister.public java.util.List<ExternalToolScanner> getScanners()
public abstract MacroRegistry getMacroRegistry()
@Deprecated public abstract void registerType(ExternalToolType type)
type
- the external tool type to register.@Deprecated public abstract void unregisterType(ExternalToolType type)
type
- the external tool type to unregister.public abstract int getRegisteredTypeCount()
public abstract java.util.Iterator<ExternalToolType> getRegisteredTypes()
public final java.util.Iterator<ExternalTool> getAllExternalTools()
tools()
.public abstract java.util.Collection<ExternalTool> tools()
public final java.util.Iterator<ExternalTool> getExternalToolsByType(ExternalToolType type)
toolsOfType(ExternalToolType)
.type
- the type of external tool to getpublic abstract java.util.Collection<ExternalTool> toolsOfType(ExternalToolType type)
type
- the type of external tool to get.public abstract void addExternalTool(ExternalTool tool)
tool
- the tool to add.public abstract void removeExternalTool(ExternalTool tool)
tool
- the tool to remove.public abstract ExternalTool invokeCreateWizard(java.awt.Component parent, ExternalToolType type)
parent
- a component for parenting the wizard on.type
- an external tool type. If specified, the first page of
the wizard will not be displayed, and the user will only be able to
create a tool of the specified type. If null, the first page of the
wizard will allow the user to choose which type of tool to create.public abstract boolean invokeEditDialog(java.awt.Component parent, ExternalTool tool)
parent
- a component for parenting the wizard on.tool
- the tool to edit. This tool must already exist and be
registered with the tool manager. On return, if the user clicked OK,
the specified tool will have been modified topublic ExternalToolType getType(ExternalTool tool)
tool
- the tool to get the type of@NotNull public static java.util.Set<java.lang.String> scannerTags(java.util.Collection<ExternalTool> tools)
scannerTags
used by a collection of tools. This method is provided as a
convenience for ExternalToolScanner
implementations.tools
- a collection of tools.