com.filenet.wcm.apps.server.ui

Class WcmAuthorModule

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
  3. extended bycom.filenet.wcm.toolkit.server.base.WcmModule
  4. extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
  5. extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
  6. extended bycom.filenet.wcm.apps.server.ui.WcmAuthorModule
All implemented interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

  1. public class WcmAuthorModule
  2. extends com.filenet.wcm.toolkit.server.base.WcmUiModule
Provides a UI Module that lets users add, check in, cancel check out, and publish documents, as well as create folders.

Nested Class Summary

Modifier and Type Class and Description
  1. static class
WcmAuthorModule.WcmAdvancedModule
  1. static class
WcmAuthorModule.WcmGeneralModule

Field Summary

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

Constructor Summary

Constructor and Description
WcmAuthorModule()

Method Summary

Modifier and Type Method and Description
  1. void
initialize()
Initializes the module variables.
  1. void
onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
Provides a global even handler that indicates when a user clicks the Home Link thus requiring this page to be reset to the top level and state information cleared.
  1. void
onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
  1. void
onSelectTab(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Handles user selection of the General Tools or Advanced Tools option.
  1. void
onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. void
render(java.io.Writer w)
Renders the content based on the selected option: General or Advanced.
  1. static
  2. void
renderAdditionalLinks(java.util.List links,java.io.Writer w,com.filenet.wcm.toolkit.server.base.WcmUiModule module)
  1. static
  2. void
renderAuthorLink(java.lang.String url,java.lang.String icon,java.lang.Object label,java.lang.Object description,boolean popup,java.io.Writer w,int width,int height)
  1. static
  2. void
renderAuthorLink(java.lang.String url,java.lang.String icon,java.lang.Object label,java.lang.Object description,java.io.Writer w)
  1. protected
  2. void
selectTab(java.lang.String sSelectedTab)
  1. void
setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
  1. static
  2. boolean
showAdvancedTools(com.filenet.wcm.toolkit.server.base.WcmController controller)
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

Constructor Detail

WcmAuthorModule

  1. public WcmAuthorModule()

Method Detail

showAdvancedTools

  1. public static boolean showAdvancedTools( com.filenet.wcm.toolkit.server.base.WcmController controller)
  2. throws java.lang.Exception
Throws:
java.lang.Exception

initialize

  1. public void initialize()
  2. throws java.lang.Exception
Initializes the module variables. Called by Controller during page initialization. State information will be filled by Controller page parameter provided by JSP for the selected object, if it exists.
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

onReset

  1. public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
  2. throws java.lang.Exception
Provides a global even handler that indicates when a user clicks the Home Link thus requiring this page to be reset to the top level and state information cleared.
Parameters:
evt - - GlobalEvent handler
Throws:
java.lang.Exception

setTree

  1. public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)

  1. public static void renderAdditionalLinks( java.util.List links,
  2. java.io.Writer w,
  3. com.filenet.wcm.toolkit.server.base.WcmUiModule module)
  4. throws java.lang.Exception
Throws:
java.lang.Exception

  1. public static void renderAuthorLink( java.lang.String url,
  2. java.lang.String icon,
  3. java.lang.Object label,
  4. java.lang.Object description,
  5. boolean popup,
  6. java.io.Writer w,
  7. int width,
  8. int height)
  9. throws java.io.IOException
Throws:
java.io.IOException

  1. public static void renderAuthorLink( java.lang.String url,
  2. java.lang.String icon,
  3. java.lang.Object label,
  4. java.lang.Object description,
  5. java.io.Writer w)
  6. throws java.io.IOException
Throws:
java.io.IOException

render

  1. public void render(java.io.Writer w)
  2. throws java.lang.Exception
Renders the content based on the selected option: General or Advanced.
Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class com.filenet.wcm.toolkit.server.base.WcmUiModule
Parameters:
w - Output device.
Throws:
java.lang.Exception - If there are problems with retrieving data or with an invalid parameter.

selectTab

  1. protected void selectTab(java.lang.String sSelectedTab)
  2. throws java.lang.Exception
Throws:
java.lang.Exception

onSelectTab

  1. public void onSelectTab(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Handles user selection of the General Tools or Advanced Tools option.
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems with retrieving data or with an invalid parameter.

onSelectTab

  1. public void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
  2. throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

  1. public void onStartPage(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Description copied from class: com.filenet.wcm.toolkit.server.base.GlobalEventModule
Event that is fired for all UI modules before the page is rendered
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 - HttpServletRequest
response - HttpServletResponse
Throws:
java.lang.Exception - If any errors occured