|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.javatools.data.HashStructureAdapter
oracle.ide.externaltools.ExternalToolBaseProperties
public final class ExternalToolBaseProperties
Base properties for an external tool.
Field Summary |
---|
Fields inherited from class oracle.javatools.data.HashStructureAdapter |
---|
_hash |
Method Summary | |
---|---|
Availability |
getAvailability() Get when this tool is available. |
java.util.List<java.lang.String> |
getAvailableTypes() Get the types this tool is available on. |
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. |
static ExternalToolBaseProperties |
getInstance(ExternalTool tool) |
static ExternalToolBaseProperties |
getInstance(HashStructure hs) Gets an instance of ExternalToolBaseProperties for the specified hash structure. |
boolean |
getLogOutput() |
boolean |
getReloadBuffers() Get whether buffers will be reloaded after running this tool. |
boolean |
getSaveAllBeforeRun() |
java.lang.String |
getScannerTag() Get the scanner tag for this tool. |
boolean |
getShowInRunManager() Returns whether this tool will be shown in the run manager. |
java.lang.String |
getToolTipText() Get the tool tip text for this tool. |
boolean |
isIntegrated(IntegrationPoint ip) Returns true if this tool is integrated at the specified integration point. |
void |
setAvailability(Availability availability) Set when this tool is available. |
void |
setAvailableTypes(java.util.List<java.lang.String> types) Set the types this tool is available on. |
void |
setCaption(java.lang.String caption) Set the caption for this external tool. |
void |
setIconURL(java.net.URL url) Set the URL of the icon for this external tool. |
void |
setIntegrated(IntegrationPoint ip, boolean integrated) Sets whether this tool is integrated at a specific integration point. |
void |
setLogOutput(boolean logOutput) |
void |
setReloadBuffers(boolean reload) Set whether to reload buffers after running this tool |
void |
setSaveAllBeforeRun(boolean saveAllBeforeRun) |
void |
setScannerTag(java.lang.String tag) An ExternalToolScanner that creates a tool can set a tag on the tool so that it can identify whether the tool has been created in future. |
void |
setShowInRunManager(boolean showInRunManager) Sets whether this tool will be shown in the run manager. |
void |
setToolTipText(java.lang.String toolTipText) Set the tool tip text for this tool. |
Methods inherited from class oracle.javatools.data.HashStructureAdapter |
---|
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ExternalToolBaseProperties getInstance(HashStructure hs)
hs
- a hash structure.java.lang.NullPointerException
- if hs is null.public static ExternalToolBaseProperties getInstance(ExternalTool tool)
public void setShowInRunManager(boolean showInRunManager)
showInRunManager
- if true, show this tool in the run manager.public boolean getShowInRunManager()
public void setScannerTag(java.lang.String tag)
tag
- a tag recognized by the scanner that created a toolpublic java.lang.String getScannerTag()
public void setReloadBuffers(boolean reload)
reload
- if true, the tool will force a buffer reloadpublic boolean getReloadBuffers()
public void setLogOutput(boolean logOutput)
public boolean getLogOutput()
public void setSaveAllBeforeRun(boolean saveAllBeforeRun)
public boolean getSaveAllBeforeRun()
public java.util.List<java.lang.String> getAvailableTypes()
Availability.SELECTED_TYPES
.public void setAvailableTypes(java.util.List<java.lang.String> types)
Availability.SELECTED_TYPES
.types
- a list of class names, which should match class names in oracle.ide.config.DocumentExtensions.DocRecord.getDocClass().public java.net.URL getIconURL()
public void setIconURL(java.net.URL url)
url
- 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 boolean isIntegrated(IntegrationPoint ip)
ip
- an integration point.java.lang.NullPointerException
- if ip is null.public void setIntegrated(IntegrationPoint ip, boolean integrated)
ip
- an integration point.integrated
- true if this tool is integrated at the specified point, false otherwise.java.lang.NullPointerException
- if ip is null.public Availability getAvailability()
public void setAvailability(Availability availability)
availability
- an Availability enum value.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |