com.wewebu.ow.server.app

Class OwConfiguration.OwMasterPluginInstance

java.lang.Object

com.wewebu.ow.server.app.OwConfiguration.OwMasterPluginInstance

All Implemented Interfaces:

OwPlugin

Enclosing class:

OwConfiguration

public class OwConfiguration.OwMasterPluginInstance
extends Object
implements OwPlugin

plugin instance used as return value of createMasterPlugin function

Constructor Summary

Constructors

Constructor and Description
OwConfiguration.OwMasterPluginInstance(Exception e_p, OwXMLUtil configNode_p) signal an error occurred when loading / initializing the plugin
OwConfiguration.OwMasterPluginInstance(OwMasterView view_p, OwMasterDocument doc_p, OwXMLUtil configNode_p) construct a plugin instance

Method Summary

Methods

Modifier and Type	Method and Description
OwXMLUtil	getConfigNode() get the plugin config node
String	getDocID() get the document target ID
OwMasterDocument	getDocument() get the document instance
OwView	getErrorView(Exception e_p, String strTitle_p) get a error view if plugin addView failed to display instead of the plugin view
String	getIcon() get the icon URL for this plugin to be displayed
String	getPluginClassName() get the plugin document class name
String	getPluginID() get the plugin ID
String	getPluginTitle() get the title of the plugin
String	getPluginType() get the plugin type
String	getPluginTypeDisplayName() get a display name for the plugin type
OwView	getView() get the view instance
String	getViewID() get the view target ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OwConfiguration.OwMasterPluginInstance

public OwConfiguration.OwMasterPluginInstance(Exception e_p,
                                      OwXMLUtil configNode_p)

signal an error occurred when loading / initializing the plugin

OwConfiguration.OwMasterPluginInstance

public OwConfiguration.OwMasterPluginInstance(OwMasterView view_p,
                                      OwMasterDocument doc_p,
                                      OwXMLUtil configNode_p)
                                       throws Exception

construct a plugin instance

Throws:

Exception

Method Detail

getView

public OwView getView()

get the view instance

getDocument

public OwMasterDocument getDocument()

get the document instance

getPluginTitle

public String getPluginTitle()

get the title of the plugin

Specified by:

getPluginTitle in interface OwPlugin

Returns:

String

getPluginID

public String getPluginID()

get the plugin ID

Specified by:

getPluginID in interface OwPlugin

Returns:

String

getViewID

public String getViewID()

get the view target ID

getDocID

public String getDocID()

get the document target ID

getErrorView

public OwView getErrorView(Exception e_p,
                  String strTitle_p)

get a error view if plugin addView failed to display instead of the plugin view

getPluginClassName

public String getPluginClassName()

get the plugin document class name

getPluginTypeDisplayName

public String getPluginTypeDisplayName()

get a display name for the plugin type

Specified by:

getPluginTypeDisplayName in interface OwPlugin

Returns:

String

getConfigNode

public OwXMLUtil getConfigNode()

get the plugin config node

Specified by:

getConfigNode in interface OwPlugin

Returns:

OwXMLUtil

getPluginType

public String getPluginType()

get the plugin type

Specified by:

getPluginType in interface OwPlugin

Returns:

String as defined in OwConfiguration.PLUGINTYPE_...

getIcon

public String getIcon()
               throws Exception

get the icon URL for this plugin to be displayed

Specified by:

getIcon in interface OwPlugin

Returns:

String icon URL, or null if not defined

Throws:

Exception