com.filenet.wcm.apps.server.ui.info
Class WcmFieldInfoPage

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.WcmFieldInfoPage
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 WcmFieldInfoPage
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

Display a list of data fields in a property table format.


Field Summary
static java.lang.String sDT_PREFIX
          Defines the prefix for eProcess date/time fields in the html form
static java.lang.String sEP_PREFIX
          Defines the prefix for eProcess data fields in the html form
 
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
WcmFieldInfoPage(int processorType)
          Constructor
 
Method Summary
 void cleanup()
          Cleans up.
 java.lang.String getFormName()
          Returns the form name.
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes the class data.
 boolean isApplyButtonRequired()
          Implement, and return "true" if you want the WcmInfo container to show an "Apply" button.
 boolean isModified()
          Return true if the state has changed as a result of a panelSave call.
 void onFieldModified(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler used by multi-value selection pages to call back and refresh list
 void onSelectField(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary field selection pages after it submits the form by calling onSubmit.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Adds the appropriate command button to the toolbar.
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves the data field changes to the data provider.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module to commit its state to the data provider.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module to persist the incoming form data to its current state.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void render(java.io.Writer w)
          Renders the class data.
 void setIsModified(boolean modified)
          Set the modified state.
 void setLocale(java.util.Locale locale)
          Set the locale
 void setPageInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set the cached page data into the step element object.
 
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

sEP_PREFIX

public static final java.lang.String sEP_PREFIX
Defines the prefix for eProcess data fields in the html form

See Also:
Constant Field Values

sDT_PREFIX

public static final java.lang.String sDT_PREFIX
Defines the prefix for eProcess date/time fields in the html form

See Also:
Constant Field Values
Constructor Detail

WcmFieldInfoPage

public WcmFieldInfoPage(int processorType)
                 throws java.lang.Exception
Constructor

Parameters:
processorType - int specifying the step processor type.
Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - If there are problems.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Adds the appropriate command button to the toolbar.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - The Java™Server Pages (JSP) request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onSelectField

public void onSelectField(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Used by links to redirect to secondary field selection pages after it submits the form by calling onSubmit.

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

onFieldModified

public void onFieldModified(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Event handler used by multi-value selection pages to call back and refresh list

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

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Saves the data field changes to the data provider.

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

cleanup

public void cleanup()
             throws java.lang.Exception
Cleans up.

Specified by:
cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - If there are problems.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Signals the UI module to persist the incoming form data to its current state.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

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
Returns:
boolean flag set to true if no validation erros otherwise false.
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Signals the UI module to commit its state to the data provider.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

setPageInfo

public void setPageInfo(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Set the cached page data into the step element object. Step Element is not actually saved until doSave() method is called sometime later.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

isModified

public boolean isModified()
                   throws java.lang.Exception
Return true if the state has changed as a result of a panelSave call.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
false
Throws:
java.lang.Exception - If there are problems.

setIsModified

public void setIsModified(boolean modified)
                   throws java.lang.Exception
Set the modified state. Checks to see if the state is currently modified. If the state is currently modified, nothing is set, otherwise the value is set to what is being passed in.

Parameters:
modified - boolean value to set.
Throws:
java.lang.Exception - If there are problems.

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Implement, and return "true" if you want the WcmInfo container to show an "Apply" button. When Apply is pressed by the user, the UI module will get a call to wizardFinish.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true - Apply button required
Throws:
java.lang.Exception - If there are problems.

getFormName

public java.lang.String getFormName()
Returns the form name.

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

setLocale

public void setLocale(java.util.Locale locale)
Set the locale

Parameters:
locale - Locale

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface


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