|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
ExternalToolListener | Listener interface for clients that will be notified when an external tool is about to start executing, and when is has been launched. |
ExternalToolOptionsEnvironment | The options environment is provided to external tool options page to provide information about the environment in which the create or edit external tools dialog is invoked. |
ExternalToolOptionsPage | The external tools framework is extensible: you can register new external tool types. |
ExternalToolScanner | The interface for an object that can scan for external tools. |
ExternalToolType | A type of external tool. |
Class Summary | |
---|---|
ContextUtils | Utilities for processing the context, commonly used by external tools macros. |
ExternalProgramToolProperties | Properties for an external tool that provides access to an external program executable. |
ExternalTool | The base class for external tools. |
ExternalToolBaseProperties | Base properties for an external tool. |
ExternalToolEvent | An event object containing information about an event sent to an
ExternalToolListener . |
ExternalToolFactory | A factory that can create new tools provided in the base external tools implementation. |
ExternalToolManager | Manages external tools. |
Enum Summary | |
---|---|
Availability | Represents the availability of an external tool. |
IntegrationPoint | An IntegrationPoint represents a place in the user interface where an external tool may be integrated. |
Exception Summary | |
---|---|
ExternalToolVetoException | An exception thrown by ExternalToolListener.toolWillStart(ExternalToolEvent)
to veto the execution of a tool. |
ToolRunException | Exception thrown from ExternalTool.run() to indicate that the running of an external tool failed in some way. |
Contains interfaces and classes that allow external tools in the IDE to be invoked, manipulated and extended by extensions.
Obtain an instance of the ExternalToolManager
class using the utility method ExternalToolManager.getExternalToolManager()
.
External tool types provide an extension mechanism whereby extensions can register customized types of external tool and plug into the existing external tools user interface in the IDE.
Each type of external tool is represented by an implementation of the
ExternalToolType
interface. You can register
a new external tool type using the
ExternalToolManager.registerType(ExternalToolType)
method.
When a type is registered with the manager, the type will be available to the user when creating new external tools via the Define External Tool wizard.
You can programmatically create external tools which invoke external
programs using ExternalToolFactory.createProgramTool()
.
Configure the properties of the tool by obtaining a
ExternalToolBaseProperties
or
ExternalProgramToolProperties
object for the
tool, and finally, add the tool to the manager using
ExternalToolManager.addExternalTool(ExternalTool)
.
The external tools dialog can prompt the user to create tools by default.
This functionality is provided by ExternalToolScanner
s.
A default implementation shipped with the IDE scans for popular Windows
applications and installs external tools to invoke them.
The default tool scanning behavior is extensible. Just implement
ExternalToolScanner
and register your scanner
in extension.xml:
<extension ...> <hooks> <externaltools xmlns="http://xmlns.oracle.com/ide/extension"> <scanners> <scanner-class>org.foo.MyScannerClass</scanner-class> </scanners> </externaltools> </hooks> </extension>
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |