com.filenet.wcm.apps.server.ui.banner
Class WcmPageBanner
java.lang.Object
com.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.WcmAnchorList
com.filenet.wcm.apps.server.presentation.ui.BannerBar
com.filenet.wcm.apps.server.ui.WcmBannerBar
com.filenet.wcm.apps.server.ui.banner.WcmPageBanner
- All Implemented Interfaces:
- com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
- public class WcmPageBanner
- extends WcmBannerBar
This module renders the banner bar that appears in every page in Workplace,
except the Sign-in page
Fields inherited from class com.filenet.wcm.apps.server.presentation.ui.BannerBar |
renderImage, topAnchors, wsBannerText |
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmAnchorList |
anchorList |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Method Summary |
void |
initialize()
|
void |
onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
|
void |
onDismissCommand(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
setLinksDisabled(boolean bLinksDisabled)
disables all links in the banner regardless of whether or not
this is a command window, popup, etc. |
void |
setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn)
Sets which links are going to be visible in the banner bar |
void |
setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn,
boolean bClose)
Sets which links are going to be visible in the banner bar |
void |
setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn,
boolean bClose,
boolean bAdjustForPopups)
Sets which links are going to be visible in the banner bar |
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.BannerBar |
addTopAnchor, clearTopAnchors, getTopAnchors, renderAnchor, setRenderImage |
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmAnchorList |
addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, clear, getAnchor, getLength, insertAnchor, removeAnchor, renderClosingHTML, renderOpeningHTML |
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 |
BANNER_CLOSE_EVENT_NAME
public static final java.lang.String BANNER_CLOSE_EVENT_NAME
- See Also:
- Constant Field Values
WcmPageBanner
public WcmPageBanner()
initialize
public void initialize()
throws java.lang.Exception
- Specified by:
initialize
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
- Overrides:
initialize
in class WcmBannerBar
- Throws:
java.lang.Exception
setLinksDisabled
public void setLinksDisabled(boolean bLinksDisabled)
- disables all links in the banner regardless of whether or not
this is a command window, popup, etc. (used by file tracking
to show a upload/download status page...)
- Parameters:
bLinksDisabled
- true if links are disabled
setVisibleLinks
public void setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn)
- Sets which links are going to be visible in the banner bar
- Parameters:
bHelp
- help linkbPreferences
- preferences linkbHome
- home linkbSignIn
- sign-in link
setVisibleLinks
public void setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn,
boolean bClose)
- Sets which links are going to be visible in the banner bar
- Parameters:
bHelp
- help linkbPreferences
- preferences linkbHome
- home linkbSignIn
- sign-in linkbClose
- close link
setVisibleLinks
public void setVisibleLinks(boolean bHelp,
boolean bPreferences,
boolean bHome,
boolean bSignIn,
boolean bClose,
boolean bAdjustForPopups)
- Sets which links are going to be visible in the banner bar
- Parameters:
bHelp
- help linkbPreferences
- preferences linkbHome
- home linkbSignIn
- sign-in linkbClose
- close linkbAdjustForPopups
- Module should rendering Region mode (don't adjust for popups).
onBannerClose
public void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
throws java.lang.Exception
- Throws:
java.lang.Exception
onDismissCommand
public void onDismissCommand(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
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
- Throws:
java.lang.Exception
© Copyright IBM Corp. 2002, 2007. All Rights Reserved.