com.filenet.wcm.apps.server.ui.info.webcontent
Class WebContentPropertiesInfoPage

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.toolkit.server.ui.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
                          extended bycom.filenet.wcm.apps.server.ui.info.webcontent.WebContentPropertiesInfoPage
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

public class WebContentPropertiesInfoPage
extends WcmPropertiesInfoPage

This class handles output of properties in a number of different scenarios. It works in conjunction with WcmPropertiesInfoPage.xsl and the properties xml returned from the Authoring Data Provider or, in some cases, the xml created here for new objects. This class makes great use of WcmPropertiesUtil.

See Also:
WcmPropertiesUtil

Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
WcmPropertiesInfoPage.OVPReader
 
Field Summary
static java.lang.String WCM_PROPDESCS_KEY_PREFIX
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
adp, aState, classLabel, controller, exceptions, isInfoPage, nType, propCacheKey, rootClassId, showCompoundDocument
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
protected WebContentPropertiesInfoPage()
          protected Constructor sets the default type, the name and creates the WcmPropertiesUtil object.
  WebContentPropertiesInfoPage(int type)
          Constructor sets the Property type to one of the static int values defined above.
 
Method Summary
 void cleanup()
          Cleanup module properties
 java.util.List getExceptions()
           
 org.w3c.dom.Document getPropertiesXML()
          Overrides the getPropertiesXML method to properly load the web content property descriptions xml.
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 void onSelectCategories(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the select categories event triggered by the user selecting the Categories link.
 void onSetCategories(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Set Categories event triggered by the user selecting one or more categories from the select categories page.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set XSL parameters and other setup before showing the property page.
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Set Categories event triggered by the user selecting one or more categories from the select categories page.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
getClassName, getFormName, getOutputXML, getShowCompoundDocument, getValidationErrors, initializePropertiesWithCommandXml, isApplyButtonRequired, isModified, onAddChild, onChangePage, onCollapse, onExpand, onGetInfo, onSelectObject, onSetClass, onSetObject, onShowChildren, onSystemProperties, onUpdateChild, pageValidate, panelFinish, panelInitClientProperties, panelSave, removeSingleProperty, render, reset, setFormName, setReadOnly, setRootClass, setSelectedClass, showCompoundDocument, showSelectClassLink, showSingleProperty, transformXML
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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

WCM_PROPDESCS_KEY_PREFIX

public static final java.lang.String WCM_PROPDESCS_KEY_PREFIX
See Also:
Constant Field Values
Constructor Detail

WebContentPropertiesInfoPage

protected WebContentPropertiesInfoPage()
                                throws java.lang.Exception
protected Constructor sets the default type, the name and creates the WcmPropertiesUtil object. Used internally.

Throws:
java.lang.Exception

WebContentPropertiesInfoPage

public WebContentPropertiesInfoPage(int type)
                             throws java.lang.Exception
Constructor sets the Property type to one of the static int values defined above.

Parameters:
type - One of the defined int field types.
Throws:
java.lang.Exception
Method Detail

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
Overrides:
initialize in class WcmPropertiesInfoPage
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
Overrides:
onStartPage in class WcmPropertiesInfoPage
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

onSelectCategories

public void onSelectCategories(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Handles the select categories event triggered by the user selecting the Categories link.

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

onSetCategories

public void onSetCategories(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Handles the Set Categories event triggered by the user selecting one or more categories from the select categories page.

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Handles the Set Categories event triggered by the user selecting one or more categories from the select categories page.

Overrides:
onSubmit in class WcmPropertiesInfoPage
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

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

getExceptions

public java.util.List getExceptions()
Overrides:
getExceptions in class WcmPropertiesInfoPage

cleanup

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

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

getPropertiesXML

public org.w3c.dom.Document getPropertiesXML()
                                      throws java.lang.Exception
Overrides the getPropertiesXML method to properly load the web content property descriptions xml.

Overrides:
getPropertiesXML in class WcmPropertiesInfoPage
Returns:
The property descriptions xml.
Throws:
java.lang.Exception
See Also:
for detail.


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