|
||||||||||
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.apps.server.ui.PortalModule
This UI Module lets users add, checkin, cancel checkout, and publish documents, as well as create folders.
Field Summary | |
protected WcmWorkplaceConfig |
config
|
protected PrefPortalPage |
currentPage
|
protected java.util.List |
groupPageList
|
protected java.util.List |
homePagePortletsList
|
protected PrefsHomePageSettings |
homePageSettings
|
protected java.lang.String |
mode
|
protected boolean |
noModules
|
protected int |
nSelectedTab
|
protected java.util.List |
portalPages
|
protected java.util.List |
registeredPortletsList
|
protected java.util.List |
sitePages
|
protected WcmSitePrefs |
sitePrefs
|
protected com.filenet.wcm.toolkit.server.ui.WcmAnchorTree |
treeModule
|
protected WcmUserPrefs |
userPrefs
|
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
PortalModule()
|
Method Summary | |
protected void |
addSitePrefPages()
Adds all pages defined in site prefs that this user has access to. |
protected boolean |
compareTwoList(java.util.List source,
java.util.List target)
|
protected boolean |
compareTwoPage(PrefPortalPage sourcePage,
PrefPortalPage targetPage)
|
java.lang.String |
constructPortletURL(PrefsHomePagePortlet p,
java.lang.String baseUrl,
java.lang.String inUrl,
java.lang.String mode)
construct a full path url with portletUrl, controllerName, and mode embedded. |
java.lang.String |
constructURL(PrefsHomePagePortlet p,
java.lang.String inUrl)
construct a URL with portlet id embedded. |
protected PrefPortalPage |
findPageInList(java.util.List source,
java.lang.String id)
|
PrefsRegisteredPortlet |
findSitePortlet(java.util.List searchList,
java.lang.String id)
Find portlet in site registered portlets list. |
PrefsHomePagePortlet |
findUserPortlet(java.util.List searchList,
java.lang.String id)
Find portlet in user registered portlets list. |
java.util.List |
getHomePagePortlets()
return user's home page portlets list, used in JSP |
java.util.List |
getHomePagePortlets(java.lang.String placement)
return home page portlets list in specific placement, used in JSP. |
PrefsHomePageSettings |
getHomePageSettings()
return the home page settings. |
java.lang.String |
getMode()
|
java.lang.String |
getModuleName()
return module name, used in jsp. |
java.util.List |
getRegisteredPortlets()
return site prefs registered portlets list, used in jsp |
void |
initialize()
Initializes module variables. |
protected void |
integretyCheck(java.util.List groupPageList,
java.lang.String id)
|
void |
onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
global event handler. |
void |
onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
|
void |
onSelectTab(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Handles user selection of General Tools or Advanced Tools option. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Configures the pages required for the different modes. |
void |
render(java.io.Writer w)
Renders its content based on selected option: General or Advanced. |
void |
setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
Setup an external tree if pass in. |
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 |
Field Detail |
protected com.filenet.wcm.toolkit.server.ui.WcmAnchorTree treeModule
protected WcmWorkplaceConfig config
protected WcmSitePrefs sitePrefs
protected WcmUserPrefs userPrefs
protected java.util.List portalPages
protected PrefPortalPage currentPage
protected PrefsHomePageSettings homePageSettings
protected java.util.List homePagePortletsList
protected java.util.List registeredPortletsList
protected java.util.List groupPageList
protected java.util.List sitePages
protected int nSelectedTab
protected boolean noModules
protected java.lang.String mode
Constructor Detail |
public PortalModule()
Method Detail |
public void initialize() throws java.lang.Exception
java.lang.Exception
public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt) throws java.lang.Exception
evt
- - GlobalEven handler
java.lang.Exception
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The JSP request object HttpServletRequestresponse
- The JSP response object HttpServletResponse
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getMode()
protected void addSitePrefPages() throws java.lang.Exception
java.lang.Exception
protected void integretyCheck(java.util.List groupPageList, java.lang.String id) throws java.lang.Exception
java.lang.Exception
protected boolean compareTwoList(java.util.List source, java.util.List target) throws java.lang.Exception
java.lang.Exception
protected PrefPortalPage findPageInList(java.util.List source, java.lang.String id)
protected boolean compareTwoPage(PrefPortalPage sourcePage, PrefPortalPage targetPage) throws java.lang.Exception
java.lang.Exception
public void onSelectTab(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- Request object.response
- Response object.
java.lang.Exception
- If there are problems with retrieving data or with an invalid parameter.public void onSelectTab(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt) throws java.lang.Exception
java.lang.Exception
public void setTree(com.filenet.wcm.toolkit.server.ui.WcmAnchorTree tree)
tree
- public void render(java.io.Writer w) throws java.lang.Exception
w
- Output device.
java.lang.Exception
- If there are problems with retrieving data or with an invalid parameter.public java.util.List getHomePagePortlets()
public java.util.List getHomePagePortlets(java.lang.String placement)
placement
- (1 - left, 2 - right)
public java.util.List getRegisteredPortlets()
public java.lang.String getModuleName()
public PrefsHomePageSettings getHomePageSettings()
public PrefsRegisteredPortlet findSitePortlet(java.util.List searchList, java.lang.String id)
searchList
- site registered portlets listid
- portelt id.
public PrefsHomePagePortlet findUserPortlet(java.util.List searchList, java.lang.String id)
searchList
- user registered portlets listid
- portelt id.
public java.lang.String constructURL(PrefsHomePagePortlet p, java.lang.String inUrl)
p
- - portletinUrl
- - URL
public java.lang.String constructPortletURL(PrefsHomePagePortlet p, java.lang.String baseUrl, java.lang.String inUrl, java.lang.String mode)
p
- - portletbaseUrl
- - base URLinUrl
- - Portlet URL locationmode
- - mode of execution.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |