com.filenet.wcm.apps.server.ui.info.compounddocument
Class ChildDocumentsInfoPage

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.info.compounddocument.ChildDocumentsInfoPage
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Direct Known Subclasses:
CompoundDocumentChildrenPage.ChildDocumentModule

public class ChildDocumentsInfoPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

This class handles output of Compound Document child info page


Nested Class Summary
static class ChildDocumentsInfoPage.CompoundDocumentTreeModule
           
 
Field Summary
protected  java.lang.String childLabel
           
protected  java.lang.String childrenLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddChild
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
ChildDocumentsInfoPage()
          Constructor sets the name.
 
Method Summary
protected  void addAddChildAction()
           
 void cleanup()
          Cleanup module properties
protected  void configureClientSideTree()
           
protected  void configurePathView()
           
protected  void configureToolbar()
           
 java.lang.String getFormName()
          Overridden to return the form name used so wizard navigation will submit it.
 WcmItemsListView getLinkListView()
          Returns Child Document Listview object.
 WcmPathNavigation getPathNavigation()
          Returns WcmPathNavigation object.
protected  boolean getRenderTreeModule()
           
 java.util.Iterator getValidationErrors()
          Unused.
 void initialize()
          Initializes data providers, XSL parameters, the authoring state and other state values.
 boolean isApplyButtonRequired()
          Tells the Info page if it should put up an Apply button.
 boolean isModified()
          Indicates that the state has changed as a result of a wizardSave call.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set XSL parameters and other setup before showing the property page.
 void onTreeSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Implements the panelFinish method
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Implements panelSave
 boolean panelValidate()
          Validates the properties
 void render(java.io.Writer w)
          Renders the child documents info page.
 
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, 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, 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, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

wsAddChild

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddChild

childrenLabel

protected java.lang.String childrenLabel

childLabel

protected java.lang.String childLabel
Constructor Detail

ChildDocumentsInfoPage

public ChildDocumentsInfoPage()
                       throws java.lang.Exception
Constructor sets the name.

Throws:
java.lang.Exception
Method Detail

getPathNavigation

public WcmPathNavigation getPathNavigation()
Returns WcmPathNavigation object.

Returns:
WcmPathNavigation

getLinkListView

public WcmItemsListView getLinkListView()
Returns Child Document Listview object.

Returns:
LinkListView

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, XSL parameters, the authoring state and other state values.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Set XSL parameters and other setup before showing the property page.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

configureClientSideTree

protected void configureClientSideTree()
                                throws java.lang.Exception
Throws:
java.lang.Exception

configurePathView

protected void configurePathView()
                          throws java.lang.Exception
Throws:
java.lang.Exception

configureToolbar

protected void configureToolbar()
                         throws java.lang.Exception
Throws:
java.lang.Exception

addAddChildAction

protected void addAddChildAction()
                          throws java.lang.Exception
Throws:
java.lang.Exception

onSelect

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

onTreeSelect

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the child documents info page.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

getRenderTreeModule

protected boolean getRenderTreeModule()

getFormName

public java.lang.String getFormName()
Overridden to return the form name used so wizard navigation will submit it.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
Returns the form name.

panelSave

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

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Validates the properties

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
true if no exception is thrown
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Unused.

Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
null

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Implements the panelFinish method

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

cleanup

public void cleanup()
             throws java.lang.Exception
Cleanup module properties

Specified by:
cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception

isModified

public boolean isModified()
                   throws java.lang.Exception
Indicates that the state has changed as a result of a wizardSave call.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true if page's state has changed.
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Tells the Info page if it should put up an Apply button.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true.
Throws:
java.lang.Exception


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