com.filenet.wcm.apps.server.ui.wizard
Class WcmPropertiesWizardPage

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.wizard.WcmPropertiesWizardPage
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.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
DeclareRecordsPropertiesWizardPage, WcmEntryPropertiesWizardPage, WcmEntryTempPropertiesWizardPage

public class WcmPropertiesWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

This class handles output of Properties for various wizards. It uses the WcmPropertiesInfoPage to show properties.

See Also:
WcmPropertiesInfoPage

Field Summary
protected  java.lang.String className
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmPropertiesWizardPage(int type)
          Constructor sets the Property type to one of the static int values defined in WcmPropertiesInfoPage.
 
Method Summary
 java.lang.String getFormName()
          Uses the WcmPropertiesInfoPage form so wizard navigation will submit it.
 WcmPropertiesInfoPage getPropertiesInfoPage()
          Get accessor returns WcmPropertiesInfoPage
protected  java.lang.String getRootClassId(javax.servlet.http.HttpServletRequest request)
          Gets the Document interface on the Object Class XML
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 boolean isFinished()
          Defers to the WcmPropertiesInfoPage.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the child modules
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears state information.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Should not be called.
 void panelInit()
          Called when this wizard page is first loaded to clear out any residual state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sends wizardSave to the WcmPropertiesInfoPage.
 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 document classes and properties.
 
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, 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
 

Field Detail

className

protected java.lang.String className
Constructor Detail

WcmPropertiesWizardPage

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

Parameters:
type - One of the WcmPropertiesInfoPage int field types.
See Also:
WcmPropertiesInfoPage
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
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Initialize the child modules

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the document classes and properties.

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

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to clear out any residual state information.

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

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Clears state information.

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Sends wizardSave to the WcmPropertiesInfoPage.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
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
Throws:
java.lang.Exception

getValidationErrors

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

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Should not be called. Currently clears state information.

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

getFormName

public java.lang.String getFormName()
Uses the WcmPropertiesInfoPage form so wizard navigation will submit it.

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

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Defers to the WcmPropertiesInfoPage.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Returns:
WcmPropertiesInfoPage.isFinished.
Throws:
java.lang.Exception

getRootClassId

protected java.lang.String getRootClassId(javax.servlet.http.HttpServletRequest request)
                                   throws java.lang.Exception
Gets the Document interface on the Object Class XML

Returns:
the Object Store Classes XML
Throws:
java.lang.Exception

getPropertiesInfoPage

public WcmPropertiesInfoPage getPropertiesInfoPage()
                                            throws java.lang.Exception
Get accessor returns WcmPropertiesInfoPage

Returns:
WcmPropertiesInfoPage
Throws:
java.lang.Exception


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