com.filenet.wcm.apps.server.ui
Class WcmPlugInModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.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

This class renders a series of tags for the Java Plug-in.


Field Summary
protected  java.util.Locale m_locale
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
           
protected  ObjectStoreAccessUtil osau
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmPlugInModule()
           
 
Method Summary
 void initialize()
          Initialize
 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 applet's class name, including package information.
 void setJarArchiveValues(java.lang.String jarArchiveValues)
          Sets the plug-in's jar archive information.
 void setJarVersionValues(java.lang.String jarVersionValues)
          Sets the plug-in's jar version information.
 void setRetrieveRunningRoutersFlag(java.lang.String retrieveRunningRoutersFlag)
          Sets the flag that determines if the list running routers should be retrieved.
 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
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
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
Constructor Detail

WcmPlugInModule

public WcmPlugInModule()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initialize

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.

Parameters:
request - The request object
response - The response object
Throws:
java.lang.Exception - if an error occurs.

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.

Parameters:
writer - Used for writing to character streams.
Throws:
java.lang.Exception - if an error occurs.

setAppletClassName

public void setAppletClassName(java.lang.String appletClassName)
Sets the applet's class name, including package information.

Parameters:
appletClassName - The applet's class name, including package information.

setJarArchiveValues

public void setJarArchiveValues(java.lang.String jarArchiveValues)
Sets the plug-in's jar archive information.

Parameters:
jarArchiveValues - The plug-in's jar archive information.

setJarVersionValues

public void setJarVersionValues(java.lang.String jarVersionValues)
Sets the plug-in's jar version information.

Parameters:
jarVersionValues - The plug-in's jar version information.

setRetrieveRunningRoutersFlag

public void setRetrieveRunningRoutersFlag(java.lang.String retrieveRunningRoutersFlag)
Sets the flag that determines if the list running routers should be retrieved.

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


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.