|
Oracle Reports Java API Reference 10g Release 2 (10.1.2) B14049-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.reports.plugin.PluginFactoryTemplate
Base Factory class of Template Plug-in Data Source. It provides sample code of a real functioning Plug-in Data Source. Application developers are encouraged to extend, or copy/modify Template Plug-in Data Source to create their own Plug-in Data Source. Subclasse would typically call the following methods in its constructor or setReportContext to set up the Plugin Factory. Reports will call conrresponding get methods to get the related Plugin Factory information after setReportContext is called. setPluginClass("sample.MyDataSourceClassName"); setEditorClass("sample.MyEditorClassName"); setMajorVersion(2); setMinorVersion(0); setName("MyDataSource"); setIconName("MyDSIcon"); Please see PluginDataSourceTemplate for example.
Constructor Summary | |
PluginFactoryTemplate() |
Method Summary | |
void |
dispose() Clean any factory resources here. |
PluginEditor |
getEditor() Returns Plug-in's Editor |
java.lang.String |
getEditorClass() Returns Plug-in Editor class name. |
java.lang.String |
getHelpPrefix() Gets prefix string for the error message help. |
java.lang.String |
getHelpSet() Returns the full path of helpset file or a URL to the helpset file |
java.lang.String |
getHint() Returns Plug-in class name. |
java.lang.String |
getIconName() Returns icon name of the Plug-in. |
int |
getMajorVersion() Returns major version. |
int |
getMinorVersion() Returns minor version. |
java.lang.String |
getName() Returns Plug-in name. |
java.lang.String |
getPluginClass() Returns Plug-in class name. |
ReportContext |
getReportContext() Returns Report Context which is passed in to setReportContext. |
Plugin |
make() Make new Plug-in instance. |
protected void |
setEditorClass(java.lang.String editorname) For subclass to set edior class name in its constructor. |
protected void |
setHelpPrefix(java.lang.String helpPrefix) For subclass to set help prefix in its constructor. |
protected void |
setHelpSet(java.lang.String helpSet) For subclass to set help set in its constructor. |
void |
setHelpSetID(java.lang.String helpSetID) Set helpset id to the plugin. |
protected void |
setHint(java.lang.String hint) For subclass to set hint message in its constructor. |
protected void |
setIconName(java.lang.String icon) For subclass to set icon name in its constructor. |
protected void |
setMajorVersion(int majorVersion) For subclass to set major version in its constructor. |
protected void |
setMinorVersion(int minorVersion) For subclass to set minor version in its constructor. |
protected void |
setName(java.lang.String pluginname) For subclass to set Plug-in name in its constructor. |
protected void |
setPluginClass(java.lang.String classname) For subclass to set Plug-in class name in its constructor. |
void |
setReportContext(ReportContext pReportContext) Passed in ReportContext. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PluginFactoryTemplate()
Method Detail |
protected void setMajorVersion(int majorVersion)
protected void setMinorVersion(int minorVersion)
protected void setIconName(java.lang.String icon)
protected void setName(java.lang.String pluginname)
protected void setPluginClass(java.lang.String classname)
protected void setEditorClass(java.lang.String editorname)
protected void setHint(java.lang.String hint)
protected void setHelpSet(java.lang.String helpSet)
protected void setHelpPrefix(java.lang.String helpPrefix)
public void dispose()
dispose
in interface PluginFactory
public void setReportContext(ReportContext pReportContext)
setReportContext
in interface PluginFactory
public ReportContext getReportContext() throws PluginException
public java.lang.String getPluginClass()
public java.lang.String getEditorClass()
public int getMajorVersion()
getMajorVersion
in interface PluginFactory
public int getMinorVersion()
getMinorVersion
in interface PluginFactory
public java.lang.String getIconName()
getIconName
in interface PluginFactory
public java.lang.String getName()
getName
in interface PluginFactory
public java.lang.String getHint()
getHint
in interface PluginFactory
public void setHelpSetID(java.lang.String helpSetID) throws PluginException
setHelpSetID
in interface PluginFactory
public java.lang.String getHelpSet()
getHelpSet
in interface PluginFactory
public java.lang.String getHelpPrefix()
getHelpPrefix
in interface PluginFactory
public PluginEditor getEditor() throws PluginException
getEditor
in interface PluginFactory
oracle.reports.plugin.PluginFactory
public Plugin make() throws PluginException
make
in interface PluginFactory
oracle.reports.plugin.PluginFactory
|
Oracle Reports Java API Reference |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |