com.filenet.wcm.apps.server.ui
Class WcmPathLabel

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.WcmPathLabel
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
ComponentRelationshipPropertiesInfoPage.ChildDocumentPathModule, ComponentRelationshipPropertiesInfoPage.ParentDocumentPathModule

public class WcmPathLabel
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule

UI Module that renders paths using properties xml.


Field Summary
 
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
WcmPathLabel()
          private Constructor sets the default type, the name and creates the WcmPropertiesUtil object.
WcmPathLabel(int type)
          Constructor sets the Property type to one of the static int values defined above.
 
Method Summary
 void initialize()
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the onStartPage event.
 void setAddItemLinkUrl(boolean on)
          Sets the flag to add the Item link Url.
 void setLabelInfo(java.lang.String newLabelInfo)
          Sets the label information that is going to be displayed to the right of the anchors
 void setLabelInfo(com.filenet.wcm.toolkit.util.WcmString newLabelInfo)
          Sets the label information that is going to be displayed to the right of the anchors
 void setMimeIcons(boolean on)
          Sets the flag to show Mime Icons.
 void setPathTitle(java.lang.String newTitle)
          Sets the label that is going to be displayed to the left of the anchors
 void setPathTitle(com.filenet.wcm.toolkit.util.WcmString newTitle)
          Sets the label that is going to be displayed to the left of the anchors
 void setPathTitleCssClass(java.lang.String cssClass)
          Sets the label css class for path title that is being displayed to left of the anchors
 void setReturnUrl(java.lang.String returnUrl)
           
 void setShowInfoIcon(boolean on)
           
 void setStateIcons(boolean on)
          Sets the flag to show state icons.
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, render, 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
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
 

Constructor Detail

WcmPathLabel

public WcmPathLabel()
             throws java.lang.Exception
private Constructor sets the default type, the name and creates the WcmPropertiesUtil object.


WcmPathLabel

public WcmPathLabel(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.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the onStartPage event. Properties data is retrieved.

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

setAddItemLinkUrl

public void setAddItemLinkUrl(boolean on)
Sets the flag to add the Item link Url. The Url is typically the url to the getContent servlet or the bookmark pages.


setStateIcons

public void setStateIcons(boolean on)
Sets the flag to show state icons.


setMimeIcons

public void setMimeIcons(boolean on)
Sets the flag to show Mime Icons.


setPathTitle

public void setPathTitle(com.filenet.wcm.toolkit.util.WcmString newTitle)
Sets the label that is going to be displayed to the left of the anchors

Parameters:
newTitle - new value of the title (as WcmString)

setPathTitle

public void setPathTitle(java.lang.String newTitle)
Sets the label that is going to be displayed to the left of the anchors

Parameters:
newTitle - new value of the title (as String)

setPathTitleCssClass

public void setPathTitleCssClass(java.lang.String cssClass)
Sets the label css class for path title that is being displayed to left of the anchors

Parameters:
cssClass - new css class

setLabelInfo

public void setLabelInfo(com.filenet.wcm.toolkit.util.WcmString newLabelInfo)
Sets the label information that is going to be displayed to the right of the anchors

Parameters:
newLabelInfo - new value of the label information (as WcmString)

setLabelInfo

public void setLabelInfo(java.lang.String newLabelInfo)
Sets the label information that is going to be displayed to the right of the anchors

Parameters:
newLabelInfo - new value of the label information (as String)

setShowInfoIcon

public void setShowInfoIcon(boolean on)

setReturnUrl

public void setReturnUrl(java.lang.String returnUrl)


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