|
Oracle Reports Java API Reference 10g (9.0.4) B12019-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Creates plugin instances, holds static information, and provides shared functions of this type of plugin. One type of plugin, such as the JDBC Plugin Data Source, will have one PluginFactory instance.
Reports creates and registers PluginFactory with the following call sequence to related methods:
1. PluginFactory() (default constructor) 2. setReportContext() 3. getHelpSet() 4. getHelpPrefix() 5. setHelpSetID()
Note that setReportContext is called right after PluginFactory is created. If PluginFactory has any setup based on Report Context (or the environment), it needs to be done inside the setReportContext method.
Method Summary | |
void |
dispose() Removes the plugin instance and cleans up related resources. |
PluginEditor |
getEditor() Returns the plugin's editor. |
java.lang.String |
getHelpPrefix() Returns the prefix string for the error message help (e.g., "XR" for Express). |
java.lang.String |
getHelpSet() Returns the full path of the helpset file or a URL to the helpset file. |
java.lang.String |
getHint() Returns the hint message of this type of plugin. |
java.lang.String |
getIconName() Returns the icon name of the plugin. |
int |
getMajorVersion() Returns the major version of the plugin. |
int |
getMinorVersion() Returns the minor version of the plugin. |
java.lang.String |
getName() Returns the name of this type of plugin. |
Plugin |
make() Makes a plugin instance. |
void |
setHelpSetID(java.lang.String helpSetID) Sets the helpset ID for the plugin. |
void |
setReportContext(ReportContext reportContext) |
Method Detail |
public void setReportContext(ReportContext reportContext)
public int getMajorVersion() throws PluginException
public int getMinorVersion() throws PluginException
public java.lang.String getIconName() throws PluginException
The plugin's icon files must be placed in ORACLE_HOME/reports/plugin/resource. Please check the plugin's UI documentation for details.
public java.lang.String getName() throws PluginException
public java.lang.String getHint() throws PluginException
public void setHelpSetID(java.lang.String helpSetID) throws PluginException
public java.lang.String getHelpSet() throws PluginException
public java.lang.String getHelpPrefix() throws PluginException
public PluginEditor getEditor() throws PluginException
public Plugin make() throws PluginException
public void dispose() throws PluginException
|
Oracle Reports Java API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |