com.filenet.wcm.toolkit.server.ui
Class WcmHeaderModule

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.WcmHeaderModule
All Implemented Interfaces:
WcmHeaderModuleInterface, WcmModuleInterface, WcmUiModuleInterface

public class WcmHeaderModule
extends WcmUiModule
implements WcmHeaderModuleInterface

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

preloadImagePrefix

protected java.lang.String preloadImagePrefix

cssFiles

protected java.util.ArrayList cssFiles

jsFiles

protected java.util.ArrayList jsFiles

preloadImages

protected java.util.ArrayList preloadImages

jsTags

protected org.apache.commons.collections.map.ListOrderedMap jsTags

title

protected java.lang.String title

buildVersion

protected java.lang.String buildVersion

buildDate

protected java.lang.String buildDate

buildCopyright

protected java.lang.String buildCopyright

contentType

protected java.lang.String contentType
Constructor Detail

WcmHeaderModule

public WcmHeaderModule()
Method Detail

getHeaderModule

public static WcmHeaderModule getHeaderModule(WcmController controller)
Get the instance of WcmHeaderModule if available in the controller.

Parameters:
controller -
Returns:
header module

setTitle

public void setTitle(java.lang.String titleValue)
Description copied from interface: WcmHeaderModuleInterface
Set the title for the page.

Specified by:
setTitle in interface WcmHeaderModuleInterface
Parameters:
titleValue - - The page title.

getTitle

public java.lang.String getTitle()
Description copied from interface: WcmHeaderModuleInterface
Get the title.

Specified by:
getTitle in interface WcmHeaderModuleInterface

setBuildInfo

public void setBuildInfo(java.lang.String version,
                         java.lang.String date,
                         java.lang.String copyright)
Description copied from interface: WcmHeaderModuleInterface
Specify the build information.

Specified by:
setBuildInfo in interface WcmHeaderModuleInterface
Parameters:
version - - The version number.
date - - The build date.
copyright - - The copyright information.

getBuildVersion

public java.lang.String getBuildVersion()
Description copied from interface: WcmHeaderModuleInterface
Get the build version.

Specified by:
getBuildVersion in interface WcmHeaderModuleInterface

getBuildDate

public java.lang.String getBuildDate()
Description copied from interface: WcmHeaderModuleInterface
Get the build date.

Specified by:
getBuildDate in interface WcmHeaderModuleInterface

getBuildCopyright

public java.lang.String getBuildCopyright()
Description copied from interface: WcmHeaderModuleInterface
Get the build copyright.

Specified by:
getBuildCopyright in interface WcmHeaderModuleInterface

setContentType

public void setContentType(java.lang.String typeValue)
Description copied from interface: WcmHeaderModuleInterface
Set the content type. (i.e. UTF-8).

Specified by:
setContentType in interface WcmHeaderModuleInterface
Parameters:
typeValue - - The content type.

getContentType

public java.lang.String getContentType()
Description copied from interface: WcmHeaderModuleInterface
Get the content type.

Specified by:
getContentType in interface WcmHeaderModuleInterface

getCssFiles

public java.util.Iterator getCssFiles()
Description copied from interface: WcmHeaderModuleInterface
Get an enumeration of the CSS files

Specified by:
getCssFiles in interface WcmHeaderModuleInterface

addCssFile

public void addCssFile(java.lang.String cssFile)
Description copied from interface: WcmHeaderModuleInterface
Add a cascading style sheet to the list to be included in the header.

Specified by:
addCssFile in interface WcmHeaderModuleInterface
Parameters:
cssFile - - The css file's URL. It can be relative to the application root.

getJsFiles

public java.util.Iterator getJsFiles()
Description copied from interface: WcmHeaderModuleInterface
Get an enumeration of the JavaScript files

Specified by:
getJsFiles in interface WcmHeaderModuleInterface

addJsFile

public void addJsFile(java.lang.String jsFile)
Description copied from interface: WcmHeaderModuleInterface
Add a JavaScript file to the list to be included.

Specified by:
addJsFile in interface WcmHeaderModuleInterface
Parameters:
jsFile - - The JavaScript URL. It can be relative to the application root.

addJsTag

public void addJsTag(java.lang.String key,
                     java.lang.String jsTagValue)
Description copied from interface: WcmHeaderModuleInterface
Adds a javascript tag to the header

Specified by:
addJsTag in interface WcmHeaderModuleInterface
Parameters:
key - to ensure it's not being added twise
jsTagValue -

getPreloadImages

public java.util.Iterator getPreloadImages()

addPreloadImage

public void addPreloadImage(java.lang.String preloadImage)

setPreloadImagePrefix

public 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.

WcmHeaderModule provides a default prefix value of "_preloadImage_"

Parameters:
preloadImagePrefix -

renderBasePath

public void renderBasePath(java.io.Writer w)
                    throws java.lang.Exception
Render just CSS <base> tag.

Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderJsTags

public void renderJsTags(java.io.Writer w)
                  throws java.lang.Exception
Render java script tags added by addJsTag method

Parameters:
w -
Throws:
java.lang.Exception

renderTitle

public void renderTitle(java.io.Writer w)
                 throws java.lang.Exception
Render just the <title> tag.

Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderCssFiles

public void renderCssFiles(java.io.Writer w)
                    throws java.lang.Exception
Render just the CSS <link> tags.

Specified by:
renderCssFiles in interface WcmHeaderModuleInterface
Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderPreloadImages

public void renderPreloadImages(java.io.Writer w)
                         throws java.lang.Exception
Render JavaScript to preload images, if any are defined.

Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderJsFiles

public void renderJsFiles(java.io.Writer w)
                   throws java.lang.Exception
Render just the JavaScript <script> tags.

Specified by:
renderJsFiles in interface WcmHeaderModuleInterface
Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderContentType

public void renderContentType(java.io.Writer w)
                       throws java.lang.Exception
Render just the content type meta tag.

Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

renderVersionInfo

public void renderVersionInfo(java.io.Writer w)
                       throws java.lang.Exception
Render just the version info meta tags.

Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Default rendering of the HTML headers.

Specified by:
render in interface WcmUiModuleInterface
Overrides:
render in class WcmUiModule
Parameters:
w - - The Writer object to write to.
Throws:
java.lang.Exception


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