uPortal 2.4.1
API Documentation

org.jasig.portal.channels
Class CHeader

java.lang.Object
  extended byorg.jasig.portal.channels.BaseChannel
      extended byorg.jasig.portal.channels.CHeader
All Implemented Interfaces:
ICacheable, IChannel

public class CHeader
extends BaseChannel
implements ICacheable

This channel provides content for a page header. It is indended to be included in a layout folder of type "header". Most stylesheets will render the content of such header channels consistently on every page.

Version:
$Revision: 1.49.2.1 $
Author:
Peter Kharchenko, pkharchenko@interactivebusiness.com, Ken Weiner, kweiner@unicon.net, Bernie Durfee, bdurfee@interactivebusiness.com

Constructor Summary
CHeader()
           
 
Method Summary
 ChannelCacheKey generateKey()
          ICacheable method - generates cache key
static java.lang.String getDate(java.lang.String format)
          Gets the current date/time with specified format
 boolean isCacheValid(java.lang.Object validity)
          ICacheable method - checks validity of cache
 void renderXML(org.xml.sax.ContentHandler out)
          Render method.
 
Methods inherited from class org.jasig.portal.channels.BaseChannel
getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CHeader

public CHeader()
Method Detail

getDate

public static java.lang.String getDate(java.lang.String format)
Gets the current date/time with specified format

Parameters:
format - the format string
Returns:
a formatted date and time string

generateKey

public ChannelCacheKey generateKey()
ICacheable method - generates cache key

Specified by:
generateKey in interface ICacheable
Returns:
key the cache key

isCacheValid

public boolean isCacheValid(java.lang.Object validity)
ICacheable method - checks validity of cache

Specified by:
isCacheValid in interface ICacheable
Parameters:
validity - the validity object
Returns:
cacheValid true if cache is still valid, otherwise false

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Render method.

Specified by:
renderXML in interface IChannel
Overrides:
renderXML in class BaseChannel
Parameters:
out - the content handler
Throws:
PortalException

uPortal 2.4.1
API Documentation