com.filenet.wcm.apps.server.ui

Class WcmPlugInModule

java.lang.Object
com.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.apps.server.ui.WcmPlugInModule

All implemented interfaces:

com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmPlugInModule
extends com.filenet.wcm.toolkit.server.base.WcmUiModule

Renders a series of tags for the Java Plug-in.

Field Summary

Modifier and Type	Field and Description
protected java.util.Locale	`m_locale`
protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider	`ndp`
protected ObjectStoreAccessUtil	`osau`
protected java.lang.String	`pe3ptJarVersion`
protected java.lang.String	`psclientJarVersion`
protected java.lang.String	`useAppletConfig`

Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`locale, NAME_DELIMITER`

Constructor Summary

Constructor and Description
`WcmPlugInModule()`

Method Summary

Modifier and Type	Method and Description
void	`initialize()` Initializes
void	`onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the onStartPage event.
void	`render(java.io.Writer writer)` Writes the page HTML to the stream.
void	`setAppletClassName(java.lang.String appletClassName)` Sets the class name for the applet, including the package information.
void	`setJarArchiveValues(java.lang.String jarArchiveValues)` Sets the JAR archive information for the plug-in.
void	`setJarVersionValues(java.lang.String jarVersionValues)` Sets the JAR version information for the plug-in.
void	`setRetrieveRunningRoutersFlag(java.lang.String retrieveRunningRoutersFlag)` Sets a flag to indicate whether the list running routers are to be retrieved.
void	`setUseAppletConfig(java.lang.String useAppletConfig)` Sets the appletParameters.properties.
void	`writevar(java.io.Writer writer,java.lang.String varname,java.lang.String value)`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
`getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP`

getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP

Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
`subscribeGlobalEvent`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty`

addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
`addDataProvider, addDataProvider`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
`addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent`

Field Detail

m_locale

protected java.util.Locale m_locale

ndp

protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp

osau

protected ObjectStoreAccessUtil osau

useAppletConfig

protected java.lang.String useAppletConfig

pe3ptJarVersion

protected java.lang.String pe3ptJarVersion

psclientJarVersion

protected java.lang.String psclientJarVersion

Constructor Detail

WcmPlugInModule

public WcmPlugInModule()

Method Detail

initialize

public void initialize()
throws java.lang.Exception

Initializes

Specified by:

initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface

Overrides:

initialize in class com.filenet.wcm.toolkit.server.base.WcmModule

Throws:

java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the onStartPage event.

Specified by:

onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

onStartPage in class com.filenet.wcm.toolkit.server.base.GlobalEventModule

Parameters:

request - The request object

response - The response object

Throws:

java.lang.Exception

writevar

public void writevar(java.io.Writer writer,
java.lang.String varname,
java.lang.String value)
throws java.io.IOException

Parameters:

writer -

varname -

value -

Throws:

java.io.IOException

render

public void render(java.io.Writer writer)
throws java.lang.Exception

Writes the page HTML to the stream.

Specified by:

render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

render in class com.filenet.wcm.toolkit.server.base.WcmUiModule

Parameters:

writer - Used for writing to character streams.

Throws:

java.lang.Exception

setUseAppletConfig

public void setUseAppletConfig( java.lang.String useAppletConfig)

Sets the appletParameters.properties.

Parameters:

useAppletConfig -

setAppletClassName

public void setAppletClassName( java.lang.String appletClassName)

Sets the class name for the applet, including the package information.

Parameters:

appletClassName - The class name, including package information.

setJarArchiveValues

public void setJarArchiveValues( java.lang.String jarArchiveValues)

Sets the JAR archive information for the plug-in.

Parameters:

jarArchiveValues - The JAR archive information.

setJarVersionValues

public void setJarVersionValues( java.lang.String jarVersionValues)

Sets the JAR version information for the plug-in.

Parameters:

jarVersionValues - The JAR version information.

setRetrieveRunningRoutersFlag

public void setRetrieveRunningRoutersFlag( java.lang.String retrieveRunningRoutersFlag)

Sets a flag to indicate whether the list running routers are to be retrieved.

Parameters:

retrieveRunningRoutersFlag - If not "true" the router information from site preferences is used.