com.filenet.wcm.apps.server.presentation.ui
Class BannerBar
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
- All Implemented Interfaces:
- com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
- public abstract class BannerBar
- extends com.filenet.wcm.toolkit.server.ui.WcmAnchorList
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 |
addTopAnchor(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor a)
Adds a top anchor |
void |
clearTopAnchors()
Clears top anchors |
protected java.lang.String |
formatDate(java.util.Locale locale)
|
abstract java.lang.String |
getBannerHeight()
Override and specify the fixed banner height value to use, or return null. |
abstract java.lang.String |
getBannerSrc()
Override and specify the graphic to be used for the banner. |
abstract java.lang.String |
getBannerWidth()
Override and return a fixed banner width value to use, or return null. |
java.util.List |
getTopAnchors()
Returns a List of WcmAnchor objects for top anchors |
abstract java.lang.String |
getUserDisplayName()
Return the signed in user's display name. |
void |
render(java.io.Writer w)
|
protected void |
renderAnchor(java.io.Writer w,
int idx,
int max,
com.filenet.wcm.toolkit.server.util.ui.WcmAnchor a)
|
protected void |
renderButtomAnchors(java.io.Writer w)
|
protected void |
renderTopAnchors(java.io.Writer w)
|
void |
setRenderImage(boolean render)
|
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmAnchorList |
addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, clear, getAnchor, getLength, initialize, 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 |
onStartPage, 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.WcmUiModuleInterface |
onStartPage |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
renderImage
protected boolean renderImage
topAnchors
protected java.util.List topAnchors
wsBannerText
protected static final com.filenet.wcm.toolkit.util.WcmString wsBannerText
BannerBar
public BannerBar()
getTopAnchors
public java.util.List getTopAnchors()
- Returns a List of WcmAnchor objects for top anchors
- Returns:
- list of top anchors
clearTopAnchors
public void clearTopAnchors()
- Clears top anchors
addTopAnchor
public void addTopAnchor(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor a)
- Adds a top anchor
- Parameters:
a
- WcmAnchor object
setRenderImage
public void setRenderImage(boolean render)
renderAnchor
protected void renderAnchor(java.io.Writer w,
int idx,
int max,
com.filenet.wcm.toolkit.server.util.ui.WcmAnchor a)
throws java.lang.Exception
- Throws:
java.lang.Exception
formatDate
protected java.lang.String formatDate(java.util.Locale locale)
throws java.lang.Exception
- Throws:
java.lang.Exception
render
public void render(java.io.Writer w)
throws java.lang.Exception
- Throws:
java.lang.Exception
renderTopAnchors
protected void renderTopAnchors(java.io.Writer w)
throws java.lang.Exception
- Throws:
java.lang.Exception
renderButtomAnchors
protected void renderButtomAnchors(java.io.Writer w)
throws java.lang.Exception
- Throws:
java.lang.Exception
getBannerSrc
public abstract java.lang.String getBannerSrc()
- Override and specify the graphic to be used for the banner.
- Returns:
- - the banner graphic relative or absolute URL.
getBannerWidth
public abstract java.lang.String getBannerWidth()
- Override and return a fixed banner width value to use, or return null.
- Returns:
- - numeric width value, or null.
getBannerHeight
public abstract java.lang.String getBannerHeight()
- Override and specify the fixed banner height value to use, or return null.
- Returns:
- - numeric height value, or null.
getUserDisplayName
public abstract java.lang.String getUserDisplayName()
- Return the signed in user's display name.
- Returns:
- - the current user's display name.
© Copyright IBM Corp. 2002, 2007. All Rights Reserved.