com.filenet.wcm.apps.server.ui
Class WcmAuthorModule
- 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.WcmAuthorModule
All implemented interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
- public class WcmAuthorModule
- extends com.filenet.wcm.toolkit.server.base.WcmUiModule
Nested Class Summary
| Modifier and Type | Class and Description |
|---|---|
|
WcmAuthorModule.WcmAdvancedModule
|
|
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 |
|---|---|
|
initialize()
Initializes the module variables.
|
|
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.
|
|
onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
|
|
onSelectTab(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Handles user selection of the General Tools or Advanced Tools option.
|
|
onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
|
|
render(java.io.Writer w)
Renders the content based on the selected option: General or Advanced.
|
|
renderAdditionalLinks(java.util.List links,java.io.Writer w,com.filenet.wcm.toolkit.server.base.WcmUiModule module)
|
|
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)
|
|
renderAuthorLink(java.lang.String url,java.lang.String icon,java.lang.Object label,java.lang.Object description,java.io.Writer w)
|
|
selectTab(java.lang.String sSelectedTab)
|
|
setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
|
|
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
- public WcmAuthorModule()
Method Detail
showAdvancedTools
- public static boolean showAdvancedTools( com.filenet.wcm.toolkit.server.base.WcmController controller)
- throws java.lang.Exception
Throws:
java.lang.Exceptioninitialize
- public void initialize()
- 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.ExceptiononReset
- public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
- 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.ExceptionsetTree
- public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
renderAdditionalLinks
- public static void renderAdditionalLinks( java.util.List links,
- java.io.Writer w,
- com.filenet.wcm.toolkit.server.base.WcmUiModule module)
- throws java.lang.Exception
Throws:
java.lang.ExceptionrenderAuthorLink
- public static 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)
- throws java.io.IOException
Throws:
java.io.IOExceptionrenderAuthorLink
- public static void renderAuthorLink( java.lang.String url,
- java.lang.String icon,
- java.lang.Object label,
- java.lang.Object description,
- java.io.Writer w)
- throws java.io.IOException
Throws:
java.io.IOExceptionrender
- public void render(java.io.Writer w)
- 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
- protected void selectTab(java.lang.String sSelectedTab)
- throws java.lang.Exception
Throws:
java.lang.ExceptiononSelectTab
- public void onSelectTab(javax.servlet.http.HttpServletRequest request,
- javax.servlet.http.HttpServletResponse response)
- 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
- public void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
- throws java.lang.Exception
Throws:
java.lang.ExceptiononStartPage
- public void onStartPage(javax.servlet.http.HttpServletRequest request,
- javax.servlet.http.HttpServletResponse response)
- 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