|
||||||||||
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.toolkit.server.ui.WcmHeaderModule
The default Toolkit implementation of WcmHeaderModuleInterface.
Field Summary | |
protected java.lang.String |
buildCopyright
|
protected java.lang.String |
buildDate
|
protected java.lang.String |
buildVersion
|
protected java.lang.String |
contentType
|
protected java.util.ArrayList |
cssFiles
|
protected java.util.ArrayList |
jsFiles
|
protected org.apache.commons.collections.map.ListOrderedMap |
jsTags
|
protected java.lang.String |
preloadImagePrefix
|
protected java.util.ArrayList |
preloadImages
|
protected java.lang.String |
title
|
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmHeaderModule()
|
Method Summary | |
void |
addCssFile(java.lang.String cssFile)
Add a cascading style sheet to the list to be included in the header. |
void |
addJsFile(java.lang.String jsFile)
Add a JavaScript file to the list to be included. |
void |
addJsTag(java.lang.String key,
java.lang.String jsTagValue)
Adds a javascript tag to the header |
void |
addPreloadImage(java.lang.String preloadImage)
|
java.lang.String |
getBuildCopyright()
Get the build copyright. |
java.lang.String |
getBuildDate()
Get the build date. |
java.lang.String |
getBuildVersion()
Get the build version. |
java.lang.String |
getContentType()
Get the content type. |
java.util.Iterator |
getCssFiles()
Get an enumeration of the CSS files |
static WcmHeaderModule |
getHeaderModule(WcmController controller)
Get the instance of WcmHeaderModule if available in the controller. |
java.util.Iterator |
getJsFiles()
Get an enumeration of the JavaScript files |
java.util.Iterator |
getPreloadImages()
|
java.lang.String |
getTitle()
Get the title. |
void |
render(java.io.Writer w)
Default rendering of the HTML headers. |
void |
renderBasePath(java.io.Writer w)
Render just CSS <base> tag. |
void |
renderContentType(java.io.Writer w)
Render just the content type meta tag. |
void |
renderCssFiles(java.io.Writer w)
Render just the CSS <link> tags. |
void |
renderJsFiles(java.io.Writer w)
Render just the JavaScript <script> tags. |
void |
renderJsTags(java.io.Writer w)
Render java script tags added by addJsTag method |
void |
renderPreloadImages(java.io.Writer w)
Render JavaScript to preload images, if any are defined. |
void |
renderTitle(java.io.Writer w)
Render just the <title> tag. |
void |
renderVersionInfo(java.io.Writer w)
Render just the version info meta tags. |
void |
setBuildInfo(java.lang.String version,
java.lang.String date,
java.lang.String copyright)
Specify the build information. |
void |
setContentType(java.lang.String typeValue)
Set the content type. |
void |
setPreloadImagePrefix(java.lang.String preloadImagePrefix)
Set the variable name prefix used as the basis for enumerated variable names to use representing each preload image object. |
void |
setTitle(java.lang.String titleValue)
Set the title for the page. |
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, initialize, 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 |
getActive, getFormName, onStartPage, renderJSP, setActive, setJSP |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
protected java.lang.String preloadImagePrefix
protected java.util.ArrayList cssFiles
protected java.util.ArrayList jsFiles
protected java.util.ArrayList preloadImages
protected org.apache.commons.collections.map.ListOrderedMap jsTags
protected java.lang.String title
protected java.lang.String buildVersion
protected java.lang.String buildDate
protected java.lang.String buildCopyright
protected java.lang.String contentType
Constructor Detail |
public WcmHeaderModule()
Method Detail |
public static WcmHeaderModule getHeaderModule(WcmController controller)
controller
-
public void setTitle(java.lang.String titleValue)
WcmHeaderModuleInterface
setTitle
in interface WcmHeaderModuleInterface
titleValue
- - The page title.public java.lang.String getTitle()
WcmHeaderModuleInterface
getTitle
in interface WcmHeaderModuleInterface
public void setBuildInfo(java.lang.String version, java.lang.String date, java.lang.String copyright)
WcmHeaderModuleInterface
setBuildInfo
in interface WcmHeaderModuleInterface
version
- - The version number.date
- - The build date.copyright
- - The copyright information.public java.lang.String getBuildVersion()
WcmHeaderModuleInterface
getBuildVersion
in interface WcmHeaderModuleInterface
public java.lang.String getBuildDate()
WcmHeaderModuleInterface
getBuildDate
in interface WcmHeaderModuleInterface
public java.lang.String getBuildCopyright()
WcmHeaderModuleInterface
getBuildCopyright
in interface WcmHeaderModuleInterface
public void setContentType(java.lang.String typeValue)
WcmHeaderModuleInterface
setContentType
in interface WcmHeaderModuleInterface
typeValue
- - The content type.public java.lang.String getContentType()
WcmHeaderModuleInterface
getContentType
in interface WcmHeaderModuleInterface
public java.util.Iterator getCssFiles()
WcmHeaderModuleInterface
getCssFiles
in interface WcmHeaderModuleInterface
public void addCssFile(java.lang.String cssFile)
WcmHeaderModuleInterface
addCssFile
in interface WcmHeaderModuleInterface
cssFile
- - The css file's URL. It can be relative to the application root.public java.util.Iterator getJsFiles()
WcmHeaderModuleInterface
getJsFiles
in interface WcmHeaderModuleInterface
public void addJsFile(java.lang.String jsFile)
WcmHeaderModuleInterface
addJsFile
in interface WcmHeaderModuleInterface
jsFile
- - The JavaScript URL. It can be relative to the application root.public void addJsTag(java.lang.String key, java.lang.String jsTagValue)
WcmHeaderModuleInterface
addJsTag
in interface WcmHeaderModuleInterface
key
- to ensure it's not being added twisejsTagValue
- public java.util.Iterator getPreloadImages()
public void addPreloadImage(java.lang.String preloadImage)
public void setPreloadImagePrefix(java.lang.String preloadImagePrefix)
preloadImagePrefix
- public void renderBasePath(java.io.Writer w) throws java.lang.Exception
w
- - The Writer object to write to.
java.lang.Exception
public void renderJsTags(java.io.Writer w) throws java.lang.Exception
w
-
java.lang.Exception
public void renderTitle(java.io.Writer w) throws java.lang.Exception
w
- - The Writer object to write to.
java.lang.Exception
public void renderCssFiles(java.io.Writer w) throws java.lang.Exception
renderCssFiles
in interface WcmHeaderModuleInterface
w
- - The Writer object to write to.
java.lang.Exception
public void renderPreloadImages(java.io.Writer w) throws java.lang.Exception
w
- - The Writer object to write to.
java.lang.Exception
public void renderJsFiles(java.io.Writer w) throws java.lang.Exception
renderJsFiles
in interface WcmHeaderModuleInterface
w
- - The Writer object to write to.
java.lang.Exception
public void renderContentType(java.io.Writer w) throws java.lang.Exception
w
- - The Writer object to write to.
java.lang.Exception
public void renderVersionInfo(java.io.Writer w) throws java.lang.Exception
w
- - The Writer object to write to.
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
render
in class WcmUiModule
w
- - The Writer object to write to.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |