com.filenet.wcm.toolkit.server.base
Interface WcmHeaderModuleInterface

All Superinterfaces:
WcmModuleInterface, WcmUiModuleInterface
All Known Implementing Classes:
WcmHeaderModule

public interface WcmHeaderModuleInterface
extends WcmUiModuleInterface

This is the header module interface. A header module is a UI module that renders the headers that go between <head> and </head>.


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
 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
 java.util.Iterator getJsFiles()
          Get an enumeration of the JavaScript files
 java.lang.String getTitle()
          Get the title.
 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 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 setTitle(java.lang.String title)
          Set the title for the page.
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
getActive, getFormName, onStartPage, render, 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
 

Method Detail

addCssFile

public void addCssFile(java.lang.String cssFile)
Add a cascading style sheet to the list to be included in the header.

Parameters:
cssFile - - The css file's URL. It can be relative to the application root.

addJsFile

public void addJsFile(java.lang.String jsFile)
Add a JavaScript file to the list to be included.

Parameters:
jsFile - - The JavaScript URL. It can be relative to the application root.

setTitle

public void setTitle(java.lang.String title)
Set the title for the page.

Parameters:
title - - The page title.

setContentType

public void setContentType(java.lang.String typeValue)
Set the content type. (i.e. UTF-8).

Parameters:
typeValue - - The content type.

setBuildInfo

public void setBuildInfo(java.lang.String version,
                         java.lang.String date,
                         java.lang.String copyright)
Specify the build information.

Parameters:
version - - The version number.
date - - The build date.
copyright - - The copyright information.

getContentType

public java.lang.String getContentType()
Get the content type.


getBuildVersion

public java.lang.String getBuildVersion()
Get the build version.


getBuildDate

public java.lang.String getBuildDate()
Get the build date.


getBuildCopyright

public java.lang.String getBuildCopyright()
Get the build copyright.


getTitle

public java.lang.String getTitle()
Get the title.


getCssFiles

public java.util.Iterator getCssFiles()
Get an enumeration of the CSS files


getJsFiles

public java.util.Iterator getJsFiles()
Get an enumeration of the JavaScript files


renderCssFiles

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

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.

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

addJsTag

public void addJsTag(java.lang.String key,
                     java.lang.String jsTagValue)
Adds a javascript tag to the header

Parameters:
key - to ensure it's not being added twise
jsTagValue -


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