|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmXSLModule
com.filenet.wcm.apps.server.ui.info.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.
WcmPropertiesUtil
Nested Class Summary | |
class |
WcmPropertiesInfoPage.OVPReader
|
Field Summary | |
protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider |
adp
|
protected WcmAuthoringState |
aState
|
protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel |
classLabel
|
protected com.filenet.wcm.toolkit.server.base.WcmController |
controller
|
protected java.util.List |
exceptions
|
protected boolean |
isInfoPage
|
protected int |
nType
Set this value in the constructor to one of the static ints defined above. |
protected java.lang.String |
propCacheKey
|
protected java.lang.String |
rootClassId
|
protected boolean |
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 |
WcmPropertiesInfoPage()
protected Constructor sets the default type, the name and creates the WcmPropertiesUtil object. |
|
WcmPropertiesInfoPage(int type)
Constructor sets the Property type to one of the static int values defined above. |
Method Summary | |
void |
cleanup()
Cleanup module properties |
java.lang.String |
getClassName()
Provides the class name for display. |
java.util.List |
getExceptions()
|
java.lang.String |
getFormName()
Overridden to return the form name used so wizard navigation will submit it. |
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. |
protected boolean |
getShowCompoundDocument(java.lang.String classId)
|
java.util.Iterator |
getValidationErrors()
Unused. |
void |
initialize()
Initializes data providers, XSL parameters, the authoring state and other state values. |
void |
initializePropertiesWithCommandXml(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
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 |
onAddChild(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onChangePage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Used by links to redirect to secondary property pages after it submits the form by calling onSubmit. |
void |
onCollapse(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Handle Collapse on expanded object property |
void |
onExpand(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Handle Expand on object Property |
void |
onGetInfo(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onSelectObject(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Handle Select Object event. |
void |
onSetClass(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onSetObject(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onShowChildren(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 |
onSystemProperties(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onUpdateChild(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
boolean |
pageValidate()
Validates the properties but this method don't display error stack. |
void |
panelFinish(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Calls setProperties on the object. |
void |
panelInitClientProperties(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Called only when in App Integration/Client mode. |
void |
panelSave(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Calls onSubmit |
boolean |
panelValidate()
Validates the properties |
void |
removeSingleProperty()
Provides the mechanism for removing a single property value. |
void |
render(java.io.Writer w)
Renders the properties. |
void |
reset()
Resets data provider and module properties. |
void |
setFormName(java.lang.String formName)
Sets the form name string |
void |
setReadOnly(boolean bReadOnly)
Pass true to set this property page as read only. |
void |
setRootClass(java.lang.String classId)
|
void |
setSelectedClass(java.lang.String newClassId)
Set the select class. |
void |
showCompoundDocument(boolean value)
|
void |
showSelectClassLink(boolean value)
|
void |
showSingleProperty(java.lang.String propertySymname)
Used for Intermediate Select Object page that provides the remove Object assignment link. |
protected org.w3c.dom.Document |
transformXML(org.w3c.dom.Document domSource,
java.lang.String type)
Merge mime type or container type to link xml. |
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 |
protected java.lang.String rootClassId
protected int nType
protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
protected WcmAuthoringState aState
protected java.lang.String propCacheKey
protected boolean isInfoPage
protected java.util.List exceptions
protected com.filenet.wcm.toolkit.server.base.WcmController controller
protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classLabel
protected boolean showCompoundDocument
Constructor Detail |
protected WcmPropertiesInfoPage() throws java.lang.Exception
java.lang.Exception
public WcmPropertiesInfoPage(int type) throws java.lang.Exception
type
- One of the defined int field types.
java.lang.Exception
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
java.lang.Exception
public void onCollapse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The request Objectresponse
- The response Object
java.lang.Exception
public void onExpand(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The request Objectresponse
- The response Object
java.lang.Exception
public void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The request Objectresponse
- The response Object
java.lang.Exception
public void onSetObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
onStartPage
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
protected boolean getShowCompoundDocument(java.lang.String classId) throws java.lang.Exception
java.lang.Exception
public void onAddChild(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onShowChildren(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onUpdateChild(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void setReadOnly(boolean bReadOnly) throws java.lang.Exception
bReadOnly
- Value desired for read only.
java.lang.Exception
public void showSingleProperty(java.lang.String propertySymname) throws java.lang.Exception
propertySymname
- The symbolic name of the property to show.
java.lang.Exception
public void removeSingleProperty() throws java.lang.Exception
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
w
- Writer object to write to.
java.lang.Exception
protected org.w3c.dom.Document getPropertiesXML() throws java.lang.Exception
java.lang.Exception
protected org.w3c.dom.Document getOutputXML() throws java.lang.Exception
java.lang.Exception
public java.lang.String getFormName()
getFormName
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
public void setFormName(java.lang.String formName)
formName
- Stringpublic void onGetInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onChangePage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
public void initializePropertiesWithCommandXml(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
public void onSystemProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void panelInitClientProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
public void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
panelSave
in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
public boolean panelValidate() throws java.lang.Exception
panelValidate
in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
java.lang.Exception
public boolean pageValidate() throws java.lang.Exception
java.lang.Exception
public java.util.List getExceptions()
public java.util.Iterator getValidationErrors()
getValidationErrors
in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
public void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
panelFinish
in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
public void cleanup() throws java.lang.Exception
cleanup
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
java.lang.Exception
public void reset() throws java.lang.Exception
java.lang.Exception
public boolean isModified() throws java.lang.Exception
isModified
in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
java.lang.Exception
public boolean isApplyButtonRequired() throws java.lang.Exception
isApplyButtonRequired
in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
java.lang.Exception
protected org.w3c.dom.Document transformXML(org.w3c.dom.Document domSource, java.lang.String type) throws java.lang.Exception
domSource
- Folder contents DOM object
java.lang.Exception
public void setSelectedClass(java.lang.String newClassId) throws java.lang.Exception
newClassId
- String new object class id
java.lang.Exception
public void onSetClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public java.lang.String getClassName() throws java.lang.Exception
java.lang.Exception
public void showSelectClassLink(boolean value) throws java.lang.Exception
java.lang.Exception
public void setRootClass(java.lang.String classId) throws java.lang.Exception
java.lang.Exception
public void showCompoundDocument(boolean value) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |