com.filenet.wcm.apps.server.ui.nav
Class WcmClassNavigation

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.presentation.ui.GenericListView
                          extended bycom.filenet.wcm.apps.server.ui.WcmGenericListView
                              extended bycom.filenet.wcm.apps.server.ui.nav.WcmClassNavigation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
WcmClassTypeNavigation, WcmEntryTemplateClassNavigation, WcmObjectStoreClassNavigation

public class WcmClassNavigation
extends WcmGenericListView

This class handles rendering the top portion of the Properties Wizard Page to display the document or folder class hierarchy.


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState authState
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classesLabel
           
protected  int nType
           
protected  java.lang.String propCacheKey
           
static int SHOW_HIDDEN
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCustomObjectClasses
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDocumentClasses
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFolderClasses
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLinkClasses
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSecurityPolicyClasses
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
config
 
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 WcmClassNavigation()
           
  WcmClassNavigation(int type)
          Constructor sets the Property type to one of the static int values defined in WcmPropertyInfoPage.
 
Method Summary
 void cancel()
          Clears any residual state information.
 void cleanup()
          Clears out saved module properties.
 java.lang.String getClassName()
          Provides the class name for display.
 java.lang.String getSelectedID()
          Get the selected class Id.
 int getType()
          Get the type of classes
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          A choice was made.
 void onShowProps(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show/Hide Properties was pressed.
 void render(java.io.Writer w)
          Renders the page.
 void setData(org.w3c.dom.Document xmlClasses, java.lang.String objectStoreID)
          Sets the data required to render the class hierarchy.
 void setLabel(java.lang.String label)
          Use this label first if defined.
 void setLockRootID(java.lang.String classId)
          Sets the rootId XSL parameter.
 void setRenderTreeModule(boolean render)
          Turn Tree Module rendering on or off.
 void setSelectedClass(java.lang.String newClassId)
          Set the select class.
 java.lang.String setSelectedID(java.lang.String classId)
          Sets the selectedID XSL parameter.
 void setType(int type)
          Set type of module
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmGenericListView
configNameProperties, configNameProperties, configNameProperties, configNameProperties, setCustomObjectNameProperty, setCustomObjectNameProperty, setDocumentNameProperty, setDocumentNameProperty, setFolderNameProperty, setFolderNameProperty
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, getXSLTemplate, onPageChange, setCurrentPage, setFirstDisplayedItem, setItemsCount, setLastDisplayedItem, setNameProperty, setNoItemsText, setNotItemsTextString, setPageSize, setPagingLabel, setSelectedObjects
 
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, getFormName, 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
onStartPage, 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.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

wsDocumentClasses

protected static final com.filenet.wcm.toolkit.util.WcmString wsDocumentClasses

wsFolderClasses

protected static final com.filenet.wcm.toolkit.util.WcmString wsFolderClasses

wsCustomObjectClasses

protected static final com.filenet.wcm.toolkit.util.WcmString wsCustomObjectClasses

wsLinkClasses

protected static final com.filenet.wcm.toolkit.util.WcmString wsLinkClasses

wsSecurityPolicyClasses

protected static final com.filenet.wcm.toolkit.util.WcmString wsSecurityPolicyClasses

SHOW_HIDDEN

public static final int SHOW_HIDDEN
See Also:
Constant Field Values

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

authState

protected WcmAuthoringState authState

classesLabel

protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classesLabel

nType

protected int nType

propCacheKey

protected java.lang.String propCacheKey
Constructor Detail

WcmClassNavigation

protected WcmClassNavigation()
                      throws java.lang.Exception

WcmClassNavigation

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

Parameters:
type - One of the WcmPropertyInfoPage 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
Overrides:
initialize in class WcmGenericListView
Throws:
java.lang.Exception

setRenderTreeModule

public void setRenderTreeModule(boolean render)
Turn Tree Module rendering on or off. When you turn this on, make sure you have setup TreeModule handlers for the following events: eventUrl Handles clicks on the link getChildrenUrl Handles clicks on the plus icon

Parameters:
render - state of Tree Module rendering.

setType

public void setType(int type)
             throws java.lang.Exception
Set type of module

Throws:
java.lang.Exception

onShowProps

public void onShowProps(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Show/Hide Properties was pressed. Toggles the state of showing properties.

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 page.

Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

setData

public void setData(org.w3c.dom.Document xmlClasses,
                    java.lang.String objectStoreID)
             throws java.lang.Exception
Sets the data required to render the class hierarchy.

Parameters:
xmlClasses - The XML that describe the class hierarchy.
objectStoreID - The Object Store ID that these classes are taken from.
Throws:
java.lang.Exception

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
A choice was made. Adds the new value to the output XML and sets the id of the selected choice in the currentPage XSL parameter.

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
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.

Parameters:
newClassId - String new object class id
Throws:
java.lang.Exception

cleanup

public void cleanup()
             throws java.lang.Exception
Clears out saved module properties.

Throws:
java.lang.Exception

getClassName

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

Returns:
The chosen class name.
Throws:
java.lang.Exception

cancel

public void cancel()
            throws java.lang.Exception
Clears any residual state information.

Throws:
java.lang.Exception

setSelectedID

public java.lang.String setSelectedID(java.lang.String classId)
                               throws java.lang.Exception
Sets the selectedID XSL parameter.

Parameters:
classId - String new class id.
Returns:
String selected class id.
Throws:
java.lang.Exception

setLockRootID

public void setLockRootID(java.lang.String classId)
                   throws java.lang.Exception
Sets the rootId XSL parameter.

Parameters:
classId - String new class id.
Throws:
java.lang.Exception

getSelectedID

public java.lang.String getSelectedID()
                               throws java.lang.Exception
Get the selected class Id.

Returns:
String class id.
Throws:
java.lang.Exception

getType

public int getType()
Get the type of classes

Returns:
int type.

setLabel

public void setLabel(java.lang.String label)
Use this label first if defined.

Parameters:
label - classes view label


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