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

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.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

This UI Module lets users add, checkin, cancel checkout, and publish documents, as well as create folders.


Nested Class Summary
static class WcmAuthorModule.WcmAdvancedModule
           
static class WcmAuthorModule.WcmGeneralModule
           
 
Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmAuthorModule()
           
 
Method Summary
 void initialize()
          Initializes module variables.
 void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
          global even handler.
 void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
           
 void onSelectTab(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles user selection of General Tools or Advanced Tools option.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void render(java.io.Writer w)
          Renders its content based on selected option: General or Advanced.
static void renderAdditionalLinks(java.util.List links, java.io.Writer w, com.filenet.wcm.toolkit.server.base.WcmUiModule module)
           
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)
           
static void renderAuthorLink(java.lang.String url, java.lang.String icon, java.lang.Object label, java.lang.Object description, java.io.Writer w)
           
protected  void selectTab(java.lang.String sSelectedTab)
           
 void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
           
static 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

public WcmAuthorModule()
Method Detail

showAdvancedTools

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

initialize

public void initialize()
                throws java.lang.Exception
Initializes module variables. Called by Controller during page initialization. State information will be filled by Controller's page parameter provided by selected object's JSP if it exists.

Throws:
java.lang.Exception

onReset

public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
             throws java.lang.Exception
global even handler. indicates that user clicked their Home Link so this page needs to be reset to the top level and state information cleared.

Parameters:
evt - - GlobalEvent handler
Throws:
java.lang.Exception

setTree

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.Exception

renderAuthorLink

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.IOException

renderAuthorLink

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.IOException

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders its content based on selected option: General or Advanced.

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.Exception

onSelectTab

public void onSelectTab(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles user selection of 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.Exception

onStartPage

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


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