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

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.compounddocument.ComponentRelationshipPropertiesInfoPage
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, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

public class ComponentRelationshipPropertiesInfoPage
extends WcmPropertiesInfoPage
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

This class handles output of Compound Document Component Relationship class properties


Nested Class Summary
 class ComponentRelationshipPropertiesInfoPage.ChildDocumentPathModule
           
 class ComponentRelationshipPropertiesInfoPage.ParentDocumentPathModule
           
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
WcmPropertiesInfoPage.OVPReader
 
Field Summary
 
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 ComponentRelationshipPropertiesInfoPage()
          Constructor sets the name.
  ComponentRelationshipPropertiesInfoPage(int type)
          Constructor sets the Property type to one of the static int values defined above.
 
Method Summary
 java.lang.String getClassName()
          Provides the class name for display.
 ComponentRelationshipRef getComponentRelationshipRef()
           
protected  org.w3c.dom.Document getOutputXML()
          Gets the Document interface on the properties XML
protected  org.w3c.dom.Document getPropertiesXML()
          Gets the Document interface on the properties XML.
 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 isFinished()
           
 void onClearValue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectDocument(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectValue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetChoice(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetClass(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 onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This event updates the output XML from the request data.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when user cancels the action
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Calls setProperties on the object.
 void panelInit()
          Initializes module
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initializes module
 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 component link properties page.
 void reset()
          Resets data provider and module properties.
 void setSelectedClass(java.lang.String newClassId)
          Set the select class.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.info.WcmPropertiesInfoPage
cleanup, getExceptions, getFormName, getShowCompoundDocument, getValidationErrors, initializePropertiesWithCommandXml, isModified, onAddChild, onChangePage, onCollapse, onExpand, onGetInfo, onSelectObject, onSetObject, onShowChildren, onSystemProperties, onUpdateChild, pageValidate, panelInitClientProperties, removeSingleProperty, setFormName, setReadOnly, setRootClass, 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
 

Constructor Detail

ComponentRelationshipPropertiesInfoPage

protected ComponentRelationshipPropertiesInfoPage()
                                           throws java.lang.Exception
Constructor sets the name.

Throws:
java.lang.Exception

ComponentRelationshipPropertiesInfoPage

public ComponentRelationshipPropertiesInfoPage(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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the component link properties page.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmPropertiesInfoPage
Parameters:
w - Writer object to write to.
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

onSelectDocument

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

onSelectValue

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

onSetChoice

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

onClearValue

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

getPropertiesXML

protected org.w3c.dom.Document getPropertiesXML()
                                         throws java.lang.Exception
Gets the Document interface on the properties XML. Also sets the class property for the output XML.

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

getOutputXML

protected org.w3c.dom.Document getOutputXML()
                                     throws java.lang.Exception
Description copied from class: WcmPropertiesInfoPage
Gets the Document interface on the properties XML

Overrides:
getOutputXML in class WcmPropertiesInfoPage
Returns:
The output xml.
Throws:
java.lang.Exception

setSelectedClass

public void setSelectedClass(java.lang.String newClassId)
                      throws java.lang.Exception
Set the select class. Updates the output xml with selected class and class properties. The class description xml and object store name must be already loaded into the module properties.

Overrides:
setSelectedClass in class WcmPropertiesInfoPage
Parameters:
newClassId - String new object class id
Throws:
java.lang.Exception

onSetClass

public void onSetClass(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Overrides:
onSetClass in class WcmPropertiesInfoPage
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

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Calls setProperties on the object.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Overrides:
panelFinish in class WcmPropertiesInfoPage
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
Initializes module

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

reset

public void reset()
           throws java.lang.Exception
Resets data provider and module properties.

Overrides:
reset in class WcmPropertiesInfoPage
Throws:
java.lang.Exception

panelInit

public void panelInit()
               throws java.lang.Exception
Initializes module

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
Event that occurs when user cancels the action

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

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Description copied from class: WcmPropertiesInfoPage
This event updates the output XML from the request data.

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

getClassName

public java.lang.String getClassName()
                              throws java.lang.Exception
Provides the class name for display.

Overrides:
getClassName in class WcmPropertiesInfoPage
Returns:
The chosen class name.
Throws:
java.lang.Exception

isFinished

public boolean isFinished()
Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

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
Overrides:
isApplyButtonRequired in class WcmPropertiesInfoPage
Returns:
true.
Throws:
java.lang.Exception

getComponentRelationshipRef

public ComponentRelationshipRef getComponentRelationshipRef()


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