|
Extension SDK 9.0.5 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.jdeveloper.externaltools.ExternalTool
The base class for external tools in JDeveloper.
Field Summary | |
static int |
AVAIL_ALWAYS
Indicates that the tool is always available |
static int |
AVAIL_REGEXP
Indicates that the tool is available when the selection matches a regular expression. |
static int |
AVAIL_SELECTION
Indicates that the tool is available when there is a selection. |
static int |
AVAIL_TYPES
Indicates that the tool is available when the selection is included in a set of document types. |
static int |
INTEG_CODE_EDITOR_CONTEXT_MENU_ITEM
Indicates that the tool has a menu item in the code editor context menu. |
static int |
INTEG_MAIN_WINDOW_TOOLBAR_BUTTON
Indicates that the tool has a toolbar button in the main window toolbar. |
static int |
INTEG_NAVIGATOR_CONTEXT_MENU_ITEM
Indicates that the tool has a menu item in the navigator context menu. |
static int |
INTEG_NAVIGATOR_TOOLBAR_BUTTON
Indicates that the tool has a toolbar button in the navigator toolbar. |
static int |
INTEG_TOOLS_MENU_ITEM
Indicates that the tool has a menu item in the Tools menu. |
Constructor Summary | |
ExternalTool()
|
Method Summary | |
protected void |
copyToImpl(ExternalTool copy)
Use this method when implementing the oracle.ide.util.Copyable interface. |
int |
getAvailability()
Get when this tool is available. |
java.lang.String |
getAvailabilityExpression()
Get the regular expression to be used when getAvailability() is of type AVAIL_REGEXP. |
java.util.List |
getAvailableTypes()
Get the types this tool is available on, if the availability type is set to AVAIL_TYPES. |
java.lang.String |
getCaption()
Get the caption for this external tool. |
java.net.URL |
getIconURL()
Get the URL of the icon for this external tool. |
javax.swing.Icon |
getIconWhenRequired()
If an external tool is displayed in the toolbar, an icon is required. |
int |
getIntegrationMask()
Get the types of integration this tool has with the IDE. |
boolean |
getReloadBuffers()
Get whether buffers will be reloaded after running this tool. |
java.lang.String |
getToolTipText()
Get the tool tip text for this tool. |
abstract java.lang.Class |
getType()
Get the type of tool this is. |
boolean |
hasIntegration(int integrationType)
Is this tool integrated in the specified way? Utility method, equivalent to ((getIntegrationMask() & integrationType) != 0) |
abstract void |
run(ExternalToolManager manager,
Context context)
Invoke the external tool instance on the specified context. |
void |
setAvailability(int availability)
Set when this tool is available. |
void |
setAvailabilityExpression(java.lang.String expression)
Set the regular expression to be used when getAvailability() is of type AVAIL_REGEXP. |
void |
setAvailableTypes(java.util.List types)
Set the types this tool is available on, if the availability type is set to AVAIL_TYPES. |
void |
setCaption(java.lang.String caption)
Set the caption for this external tool. |
void |
setIconURL(java.net.URL u)
Set the URL of the icon for this external tool. |
void |
setIntegrationMask(int integrationMask)
Set the types of integration this tool has with the IDE. |
void |
setReloadBuffers(boolean reload)
Set whether to reload buffers after running this tool |
void |
setToolTipText(java.lang.String toolTipText)
Set the tool tip text for this tool. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.ide.util.Copyable |
copyTo |
Field Detail |
public static final int INTEG_TOOLS_MENU_ITEM
public static final int INTEG_CODE_EDITOR_CONTEXT_MENU_ITEM
public static final int INTEG_NAVIGATOR_CONTEXT_MENU_ITEM
public static final int INTEG_MAIN_WINDOW_TOOLBAR_BUTTON
public static final int INTEG_NAVIGATOR_TOOLBAR_BUTTON
public static final int AVAIL_ALWAYS
public static final int AVAIL_SELECTION
public static final int AVAIL_REGEXP
public static final int AVAIL_TYPES
Constructor Detail |
public ExternalTool()
Method Detail |
public boolean getReloadBuffers()
public void setReloadBuffers(boolean reload)
reload
- if true, the tool will force a buffer reloadpublic javax.swing.Icon getIconWhenRequired()
public boolean hasIntegration(int integrationType)
integrationType
- one of the INTEG_ constants defined in this class.
public java.lang.String toString()
public void setAvailableTypes(java.util.List types)
types
- a list of class names, which should match class names
in oracle.ide.config.DocumentExtensions.DocRecord.getDocClass().public java.util.List getAvailableTypes()
public java.net.URL getIconURL()
public void setIconURL(java.net.URL u)
u
- a URL pointing to an icon file to use for this tool. If null,
no icon will be used.public java.lang.String getCaption()
public void setCaption(java.lang.String caption)
caption
- a String caption for the tool. Must not be null.public java.lang.String getToolTipText()
public void setToolTipText(java.lang.String toolTipText)
toolTipText
- a String to be used as tool tip text for the tool. May be null.public int getIntegrationMask()
public void setIntegrationMask(int integrationMask)
integrationMask
- a bitmask of IT_ constants from this interface.public int getAvailability()
public void setAvailability(int availability)
availability
- one of the AVAIL_ constants from this interface.public java.lang.String getAvailabilityExpression()
public void setAvailabilityExpression(java.lang.String expression)
expression
- a string containing a regular expression. Optional if
getAvailability() != AVAIL_REGEXP, otherwise must not be null.protected void copyToImpl(ExternalTool copy)
Copyable.copyTo( Object )
public abstract void run(ExternalToolManager manager, Context context) throws ToolRunException
context
- the IDE context the tool was invoked in.
ToolRunException
- if the
tool failed to run.public abstract java.lang.Class getType()
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.